com.clxcommunications.xms

Class ApiConnection.Builder

java.lang.Object

com.clxcommunications.xms.ApiConnection.Builder

Enclosing class:

ApiConnection

public static class ApiConnection.Builder
extends Object

A builder of API connections. At a minimum the service plan identifier and authentication token must be set.

Method Summary

Modifier and Type	Method and Description
ApiConnection	build() Builds a new, initially stopped, ApiConnection.
ApiConnection.Builder	callbackWrapper(CallbackWrapper callbackWrapper) Initializes the value for the callbackWrapper attribute.
ApiConnection.Builder	endpoint(String url) Initializes the endpoint from the given URL string.
ApiConnection.Builder	endpoint(URI endpoint) Initializes the value for the endpoint attribute.
ApiConnection.Builder	httpClient(HttpAsyncClient httpClient) Initializes the value for the httpClient attribute.
ApiConnection.Builder	prettyPrintJson(boolean prettyPrintJson) Initializes the value for the prettyPrintJson attribute.
ApiConnection.Builder	servicePlanId(String servicePlanId) Initializes the value for the servicePlanId attribute.
ApiConnection	start() Builds and starts the defined API connection.
ApiConnection.Builder	token(String token) Initializes the value for the token attribute.
ApiConnection.Builder	using(ApiConnection instance) Fill a builder with attribute values from the provided ApiConnection instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

endpoint

public ApiConnection.Builder endpoint(String url)

Initializes the endpoint from the given URL string. The URL should not contain query or fragment components.

Parameters:

url - the URL to the XMS endpoint

Returns:

this builder for use in a chained invocation

build

public ApiConnection build()

Builds a new, initially stopped, ApiConnection. Before attempting to interact with XMS it is necessary to start the returned connection, this is done using ApiConnection.start().

The start() method is recommended for the common case where the built ApiConnection is immediately started.

Returns:

a freshly built API connection

Throws:

IllegalStateException - if any required attributes are missing

start

public ApiConnection start()

Builds and starts the defined API connection. This is identical to calling build() and then immediately calling ApiConnection.start() on the generated connection object.

Returns:

an API connection

using

public final ApiConnection.Builder using(ApiConnection instance)

Fill a builder with attribute values from the provided ApiConnection instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

token

public final ApiConnection.Builder token(String token)

Initializes the value for the token attribute.

Parameters:

token - The value for token

Returns:

this builder for use in a chained invocation

servicePlanId

public final ApiConnection.Builder servicePlanId(String servicePlanId)

Initializes the value for the servicePlanId attribute.

Parameters:

servicePlanId - The value for servicePlanId

Returns:

this builder for use in a chained invocation

prettyPrintJson

public final ApiConnection.Builder prettyPrintJson(boolean prettyPrintJson)

Initializes the value for the prettyPrintJson attribute.

If not set, this attribute will have a default value as returned by the initializer of prettyPrintJson.

Parameters:

prettyPrintJson - The value for prettyPrintJson

Returns:

this builder for use in a chained invocation

httpClient

public final ApiConnection.Builder httpClient(HttpAsyncClient httpClient)

Initializes the value for the httpClient attribute.

If not set, this attribute will have a default value as returned by the initializer of httpClient.

Parameters:

httpClient - The value for httpClient

Returns:

this builder for use in a chained invocation

callbackWrapper

public final ApiConnection.Builder callbackWrapper(CallbackWrapper callbackWrapper)

Initializes the value for the callbackWrapper attribute.

If not set, this attribute will have a default value as returned by the initializer of callbackWrapper.

Parameters:

callbackWrapper - The value for callbackWrapper

Returns:

this builder for use in a chained invocation

endpoint

public final ApiConnection.Builder endpoint(URI endpoint)

Initializes the value for the endpoint attribute.

If not set, this attribute will have a default value as returned by the initializer of endpoint.

Parameters:

endpoint - The value for endpoint

Returns:

this builder for use in a chained invocation