org.apache.brooklyn.rest.client

Class BrooklynApi

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, org.apache.http.auth.Credentials credentials, int maxPoolSize, int timeOutInMillis) Creates a BrooklynApi using an HTTP connection pool
BrooklynApi(java.net.URL endpoint, ClientExecutor clientExecutor) Creates a BrooklynApi using a custom ClientExecutor

Method Summary

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, <any> type) As getEntity(Response, Class)
static <T> T	getEntity(javax.ws.rs.core.Response response, java.lang.Class<T> type) Extracts an instance of the given type from the response, including JSON strings in there.
EntityApi	getEntityApi()
EntityConfigApi	getEntityConfigApi()
static <T> T	getEntityOnSuccess(javax.ws.rs.core.Response response, <any> type) As #getEntity(Response, GenericType) but fails if the response is an error of any sort.
static <T> T	getEntityOnSuccess(javax.ws.rs.core.Response response, java.lang.Class<T> type) As getEntity(Response, Class) but fails if the response is an error of any sort.
LocationApi	getLocationApi()
PolicyApi	getPolicyApi()
PolicyConfigApi	getPolicyConfigApi()
ScriptApi	getScriptApi()
SensorApi	getSensorApi()
ServerApi	getServerApi()
UsageApi	getUsageApi()
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

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()

getAccessApi

public AccessApi getAccessApi()

getEntity

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

Extracts an instance of the given type from the response, including JSON strings in there. Forgives most errors except for obviously incompatible ones. To fail on any server error, use getEntityOnSuccess(Response, Class).

This method will coerce and empty map "{}" to a no-arg contructed instance of the target class. This method will also ignore most errors in the response.

It has changed to identify the most obvious errors.

getEntityOnSuccess

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

As getEntity(Response, Class) but fails if the response is an error of any sort.

getEntity

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

As getEntity(Response, Class)

getEntityOnSuccess

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

As #getEntity(Response, GenericType) but fails if the response is an error of any sort.