BrooklynApi (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.rest.client.BrooklynApi

public class BrooklynApi
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description
`BrooklynApi(java.lang.String endpoint)` Deprecated. since 0.9.0. Use `newInstance(String)` instead
`BrooklynApi(java.lang.String endpoint, org.apache.http.auth.Credentials credentials)` Deprecated. since 0.9.0. Use `newInstance(String, String, String)` instead
`BrooklynApi(java.lang.String endpoint, org.apache.http.auth.Credentials credentials, int maxPoolSize, int timeOutInMillis)` Creates a BrooklynApi using an HTTP connection pool
`BrooklynApi(java.lang.String endpoint, java.lang.String username, java.lang.String password)` Deprecated. since 0.9.0. Use `newInstance(String, String, String)` instead
`BrooklynApi(java.net.URL endpoint)` Deprecated. since 0.9.0. Use `newInstance(String)` instead
`BrooklynApi(java.net.URL endpoint, ClientExecutor clientExecutor)` Creates a BrooklynApi using a custom ClientExecutor
`BrooklynApi(java.net.URL endpoint, org.apache.http.auth.Credentials credentials)` Deprecated. since 0.9.0. Use `newInstance(String, String, String)` instead
`BrooklynApi(java.net.URL endpoint, java.lang.String username, java.lang.String password)` Deprecated. since 0.9.0. Use `newInstance(String, String, String)` instead

Method Summary

Methods
Modifier and Type	Method and Description
`AccessApi`	`getAccessApi()`
`ActivityApi`	`getActivityApi()`
`ApplicationApi`	`getApplicationApi()`
`CatalogApi`	`getCatalogApi()`
`EffectorApi`	`getEffectorApi()`
`static <T> T`	`getEntity(javax.ws.rs.core.Response response, type)`
`static <T> T`	`getEntity(javax.ws.rs.core.Response response, java.lang.Class<T> type)`
`EntityApi`	`getEntityApi()`
`EntityConfigApi`	`getEntityConfigApi()`
`static <T> T`	`getEntityGeneric(javax.ws.rs.core.Response response, type)` Deprecated. since 0.8.0-incubating. Use `#getEntity(Response, GenericType)` instead.
`LocationApi`	`getLocationApi()`
`PolicyApi`	`getPolicyApi()`
`PolicyConfigApi`	`getPolicyConfigApi()`
`ScriptApi`	`getScriptApi()`
`SensorApi`	`getSensorApi()`
`ServerApi`	`getServerApi()`
`UsageApi`	`getUsageApi()`
`VersionApi`	`getVersionApi()`
`static BrooklynApi`	`newInstance(java.lang.String endpoint)` Creates a BrooklynApi using an HTTP connection pool
`static BrooklynApi`	`newInstance(java.lang.String endpoint, int maxPoolSize, int timeOutInMillis)` Creates a BrooklynApi using an HTTP connection pool
`static BrooklynApi`	`newInstance(java.lang.String endpoint, java.lang.String username, java.lang.String password)` Creates a BrooklynApi using an HTTP connection pool
`static BrooklynApi`	`newInstance(java.lang.String endpoint, java.lang.String username, java.lang.String password, int maxPoolSize, int timeOutInMillis)` Creates a BrooklynApi using an HTTP connection pool

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrooklynApi
```
@Deprecated
public BrooklynApi(java.net.URL endpoint)
```
Deprecated. since 0.9.0. Use newInstance(String) instead

BrooklynApi
```
@Deprecated
public BrooklynApi(java.lang.String endpoint)
```
Deprecated. since 0.9.0. Use newInstance(String) instead

BrooklynApi

@Deprecated
public BrooklynApi(java.net.URL endpoint,
                      java.lang.String username,
                      java.lang.String password)

Deprecated. since 0.9.0. Use newInstance(String, String, String) instead

BrooklynApi

@Deprecated
public BrooklynApi(java.lang.String endpoint,
                      java.lang.String username,
                      java.lang.String password)

Deprecated. since 0.9.0. Use newInstance(String, String, String) instead

BrooklynApi

@Deprecated
public BrooklynApi(java.net.URL endpoint,
                      @Nullable
                      org.apache.http.auth.Credentials credentials)

Deprecated. since 0.9.0. Use newInstance(String, String, String) instead

BrooklynApi

@Deprecated
public BrooklynApi(java.lang.String endpoint,
                      @Nullable
                      org.apache.http.auth.Credentials credentials)

Deprecated. since 0.9.0. Use newInstance(String, String, String) instead

Creates a BrooklynApi using an HTTP connection pool

BrooklynApi
```
public BrooklynApi(java.net.URL endpoint,
           ClientExecutor clientExecutor)
```
Creates a BrooklynApi using a custom ClientExecutor

Parameters:
endpoint - the Brooklyn endpoint
clientExecutor - the ClientExecutor
See Also:
getClientExecutor(org.apache.http.auth.Credentials)

BrooklynApi
```
public BrooklynApi(java.lang.String endpoint,
           @Nullable
           org.apache.http.auth.Credentials credentials,
           int maxPoolSize,
           int timeOutInMillis)
```
Creates a BrooklynApi using an HTTP connection pool

Parameters:
endpoint - the Brooklyn endpoint
credentials - user credentials or null
maxPoolSize - maximum pool size
timeOutInMillis - connection timeout in milliseconds

Method Detail

newInstance
```
public static BrooklynApi newInstance(java.lang.String endpoint)
```
Creates a BrooklynApi using an HTTP connection pool

Parameters:
endpoint - the Brooklyn endpoint

Returns:
a new BrooklynApi instance

newInstance
```
public static BrooklynApi newInstance(java.lang.String endpoint,
                      int maxPoolSize,
                      int timeOutInMillis)
```
Creates a BrooklynApi using an HTTP connection pool

Parameters:
endpoint - the Brooklyn endpoint
maxPoolSize - maximum connection pool size
timeOutInMillis - connection timeout in millisecond

Returns:
a new BrooklynApi instance

newInstance
```
public static BrooklynApi newInstance(java.lang.String endpoint,
                      java.lang.String username,
                      java.lang.String password)
```
Creates a BrooklynApi using an HTTP connection pool

Parameters:
endpoint - the Brooklyn endpoint
username - for authentication
password - for authentication

Returns:
a new BrooklynApi instance

newInstance
```
public static BrooklynApi newInstance(java.lang.String endpoint,
                      java.lang.String username,
                      java.lang.String password,
                      int maxPoolSize,
                      int timeOutInMillis)
```
Creates a BrooklynApi using an HTTP connection pool

Parameters:
endpoint - the Brooklyn endpoint
username - for authentication
password - for authentication
maxPoolSize - maximum connection pool size
timeOutInMillis - connection timeout in millisecond

Returns:
a new BrooklynApi instance

getActivityApi
```
public ActivityApi getActivityApi()
```

getApplicationApi

public ApplicationApi getApplicationApi()

getCatalogApi
```
public CatalogApi getCatalogApi()
```

getEffectorApi
```
public EffectorApi getEffectorApi()
```

getEntityConfigApi

public EntityConfigApi getEntityConfigApi()

getEntityApi
```
public EntityApi getEntityApi()
```

getLocationApi
```
public LocationApi getLocationApi()
```

getPolicyConfigApi

public PolicyConfigApi getPolicyConfigApi()

getPolicyApi
```
public PolicyApi getPolicyApi()
```

getScriptApi
```
public ScriptApi getScriptApi()
```

getSensorApi
```
public SensorApi getSensorApi()
```

getServerApi
```
public ServerApi getServerApi()
```

getUsageApi
```
public UsageApi getUsageApi()
```

getVersionApi
```
public VersionApi getVersionApi()
```

getAccessApi
```
public AccessApi getAccessApi()
```

getEntity

public static <T> T getEntity(javax.ws.rs.core.Response response,
              java.lang.Class<T> type)

getEntity

public static <T> T getEntity(javax.ws.rs.core.Response response,
               type)

getEntityGeneric

@Deprecated
public static <T> T getEntityGeneric(javax.ws.rs.core.Response response,
                                 type)

Deprecated. since 0.8.0-incubating. Use #getEntity(Response, GenericType) instead.

Class BrooklynApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BrooklynApi

BrooklynApi

BrooklynApi

BrooklynApi

BrooklynApi

BrooklynApi

BrooklynApi

BrooklynApi

Method Detail

newInstance

newInstance

newInstance

newInstance

getActivityApi

getApplicationApi

getCatalogApi

getEffectorApi

getEntityConfigApi

getEntityApi

getLocationApi

getPolicyConfigApi

getPolicyApi

getScriptApi

getSensorApi

getServerApi

getUsageApi

getVersionApi

getAccessApi

getEntity

getEntity

getEntityGeneric