com.clxcommunications.xms

Class ApiHttpAsyncClient

java.lang.Object

com.clxcommunications.xms.ApiHttpAsyncClient

All Implemented Interfaces:

Closeable, AutoCloseable, HttpAsyncClient

public class ApiHttpAsyncClient
extends Object
implements HttpAsyncClient, Closeable

An asynchronous HTTP client used in API connections. It is configured in a way suitable for communicating with XMS and is therefore most applicable for communicating with a single HTTP host.

It is in most cases sufficient to let ApiConnection create and manage the HTTP client. If necessary, however, it is possible to create and manage this type of connections manually.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this client and releases any held resources.
<T> Future<T>	execute(org.apache.http.nio.protocol.HttpAsyncRequestProducer requestProducer, org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T> responseConsumer, FutureCallback<T> callback)
<T> Future<T>	execute(org.apache.http.nio.protocol.HttpAsyncRequestProducer requestProducer, org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T> responseConsumer, HttpContext context, FutureCallback<T> callback)
Future<HttpResponse>	execute(HttpHost target, HttpRequest request, FutureCallback<HttpResponse> callback)
Future<HttpResponse>	execute(HttpHost target, HttpRequest request, HttpContext context, FutureCallback<HttpResponse> callback)
Future<HttpResponse>	execute(org.apache.http.client.methods.HttpUriRequest request, FutureCallback<HttpResponse> callback)
Future<HttpResponse>	execute(org.apache.http.client.methods.HttpUriRequest request, HttpContext context, FutureCallback<HttpResponse> callback)
boolean	isRunning() Whether this client is started.
static ApiHttpAsyncClient	of() Creates a new asynchronous HTTP client suitable for communicating with XMS.
void	start() Starts this client.

Methods inherited from class java.lang.Object

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

Method Detail

of

@Nonnull
public static ApiHttpAsyncClient of()

Creates a new asynchronous HTTP client suitable for communicating with XMS.

Returns:

a newly constructed HTTP client

isRunning

public boolean isRunning()

Whether this client is started.

Returns:

true if started, false otherwise

start

public void start()

Starts this client.

close

public void close()
           throws IOException

Closes this client and releases any held resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if an I/O error occurs

execute

public <T> Future<T> execute(org.apache.http.nio.protocol.HttpAsyncRequestProducer requestProducer,
                             org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T> responseConsumer,
                             HttpContext context,
                             FutureCallback<T> callback)

Specified by:

execute in interface HttpAsyncClient

execute

public <T> Future<T> execute(org.apache.http.nio.protocol.HttpAsyncRequestProducer requestProducer,
                             org.apache.http.nio.protocol.HttpAsyncResponseConsumer<T> responseConsumer,
                             FutureCallback<T> callback)

Specified by:

execute in interface HttpAsyncClient

execute

public Future<HttpResponse> execute(HttpHost target,
                                    HttpRequest request,
                                    HttpContext context,
                                    FutureCallback<HttpResponse> callback)

Specified by:

execute in interface HttpAsyncClient

execute

public Future<HttpResponse> execute(HttpHost target,
                                    HttpRequest request,
                                    FutureCallback<HttpResponse> callback)

Specified by:

execute in interface HttpAsyncClient

execute

public Future<HttpResponse> execute(org.apache.http.client.methods.HttpUriRequest request,
                                    HttpContext context,
                                    FutureCallback<HttpResponse> callback)

Specified by:

execute in interface HttpAsyncClient

execute

public Future<HttpResponse> execute(org.apache.http.client.methods.HttpUriRequest request,
                                    FutureCallback<HttpResponse> callback)

Specified by:

execute in interface HttpAsyncClient