org.asynchttpclient

Class DefaultAsyncHttpClient

java.lang.Object

org.asynchttpclient.DefaultAsyncHttpClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, AsyncHttpClient

public class DefaultAsyncHttpClient
extends java.lang.Object
implements AsyncHttpClient

Default and threadsafe implementation of AsyncHttpClient.

Constructor Summary

Constructors

Constructor and Description
DefaultAsyncHttpClient() Create a new HTTP Asynchronous Client using the default DefaultAsyncHttpClientConfig configuration.
DefaultAsyncHttpClient(AsyncHttpClientConfig config) Create a new HTTP Asynchronous Client using the specified DefaultAsyncHttpClientConfig configuration.

Method Summary

Modifier and Type	Method and Description
void	close()
ListenableFuture<Response>	executeRequest(Request request) Execute an HTTP request.
<T> ListenableFuture<T>	executeRequest(Request request, AsyncHandler<T> handler) Execute an HTTP request.
ListenableFuture<Response>	executeRequest(RequestBuilder requestBuilder) Execute an HTTP request.
<T> ListenableFuture<T>	executeRequest(RequestBuilder requestBuilder, AsyncHandler<T> handler) Execute an HTTP request.
void	flushChannelPoolPartitions(java.util.function.Predicate<java.lang.Object> predicate) Flush ChannelPool partitions based on a predicate
ChannelPool	getChannelPool()
ClientStats	getClientStats() Return details about pooled connections.
AsyncHttpClientConfig	getConfig() Return the config associated to this client.
io.netty.channel.EventLoopGroup	getEventLoopGroup()
boolean	isClosed() Return true if closed
BoundRequestBuilder	prepare(java.lang.String method, java.lang.String url) Prepare an HTTP client request.
BoundRequestBuilder	prepareConnect(java.lang.String url) Prepare an HTTP client CONNECT request.
BoundRequestBuilder	prepareDelete(java.lang.String url) Prepare an HTTP client DELETE request.
BoundRequestBuilder	prepareGet(java.lang.String url) Prepare an HTTP client GET request.
BoundRequestBuilder	prepareHead(java.lang.String url) Prepare an HTTP client HEAD request.
BoundRequestBuilder	prepareOptions(java.lang.String url) Prepare an HTTP client OPTIONS request.
BoundRequestBuilder	preparePatch(java.lang.String url) Prepare an HTTP client PATCH request.
BoundRequestBuilder	preparePost(java.lang.String url) Prepare an HTTP client POST request.
BoundRequestBuilder	preparePut(java.lang.String url) Prepare an HTTP client PUT request.
BoundRequestBuilder	prepareRequest(Request request) Construct a RequestBuilder using a Request
BoundRequestBuilder	prepareRequest(RequestBuilder requestBuilder) Construct a RequestBuilder using a RequestBuilder
BoundRequestBuilder	prepareTrace(java.lang.String url) Prepare an HTTP client TRACE request.
protected BoundRequestBuilder	requestBuilder(Request prototype)
protected BoundRequestBuilder	requestBuilder(java.lang.String method, java.lang.String url)
DefaultAsyncHttpClient	setSignatureCalculator(SignatureCalculator signatureCalculator) Set default signature calculator to use for requests built by this client instance

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAsyncHttpClient

public DefaultAsyncHttpClient()

Create a new HTTP Asynchronous Client using the default DefaultAsyncHttpClientConfig configuration. The default AsyncHttpClient that will be used will be based on the classpath configuration.

If none of those providers are found, then the engine will throw an IllegalStateException.

DefaultAsyncHttpClient

public DefaultAsyncHttpClient(AsyncHttpClientConfig config)

Create a new HTTP Asynchronous Client using the specified DefaultAsyncHttpClientConfig configuration. This configuration will be passed to the default AsyncHttpClient that will be selected based on the classpath configuration.

Parameters:

config - a DefaultAsyncHttpClientConfig

Method Detail

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

isClosed

public boolean isClosed()

Description copied from interface: AsyncHttpClient

Return true if closed

Specified by:

isClosed in interface AsyncHttpClient

Returns:

true if closed

setSignatureCalculator

public DefaultAsyncHttpClient setSignatureCalculator(SignatureCalculator signatureCalculator)

Description copied from interface: AsyncHttpClient

Set default signature calculator to use for requests built by this client instance

Specified by:

setSignatureCalculator in interface AsyncHttpClient

Parameters:

signatureCalculator - a signature calculator

Returns:

RequestBuilder

prepare

public BoundRequestBuilder prepare(java.lang.String method,
                                   java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client request.

Specified by:

prepare in interface AsyncHttpClient

Parameters:

method - HTTP request method type. MUST BE in upper case

url - A well formed URL.

Returns:

RequestBuilder

prepareGet

public BoundRequestBuilder prepareGet(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client GET request.

Specified by:

prepareGet in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

prepareConnect

public BoundRequestBuilder prepareConnect(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client CONNECT request.

Specified by:

prepareConnect in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

prepareOptions

public BoundRequestBuilder prepareOptions(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client OPTIONS request.

Specified by:

prepareOptions in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

prepareHead

public BoundRequestBuilder prepareHead(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client HEAD request.

Specified by:

prepareHead in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

preparePost

public BoundRequestBuilder preparePost(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client POST request.

Specified by:

preparePost in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

preparePut

public BoundRequestBuilder preparePut(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client PUT request.

Specified by:

preparePut in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

prepareDelete

public BoundRequestBuilder prepareDelete(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client DELETE request.

Specified by:

prepareDelete in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

preparePatch

public BoundRequestBuilder preparePatch(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client PATCH request.

Specified by:

preparePatch in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

prepareTrace

public BoundRequestBuilder prepareTrace(java.lang.String url)

Description copied from interface: AsyncHttpClient

Prepare an HTTP client TRACE request.

Specified by:

prepareTrace in interface AsyncHttpClient

Parameters:

url - A well formed URL.

Returns:

RequestBuilder

prepareRequest

public BoundRequestBuilder prepareRequest(Request request)

Description copied from interface: AsyncHttpClient

Construct a RequestBuilder using a Request

Specified by:

prepareRequest in interface AsyncHttpClient

Parameters:

request - a Request

Returns:

RequestBuilder

prepareRequest

public BoundRequestBuilder prepareRequest(RequestBuilder requestBuilder)

Description copied from interface: AsyncHttpClient

Construct a RequestBuilder using a RequestBuilder

Specified by:

prepareRequest in interface AsyncHttpClient

Parameters:

requestBuilder - a RequestBuilder

Returns:

RequestBuilder

executeRequest

public <T> ListenableFuture<T> executeRequest(Request request,
                                              AsyncHandler<T> handler)

Description copied from interface: AsyncHttpClient

Execute an HTTP request.

Specified by:

executeRequest in interface AsyncHttpClient

Type Parameters:

T - Type of the value that will be returned by the associated Future

Parameters:

request - Request

handler - an instance of AsyncHandler

Returns:

a Future of type T

executeRequest

public <T> ListenableFuture<T> executeRequest(RequestBuilder requestBuilder,
                                              AsyncHandler<T> handler)

Description copied from interface: AsyncHttpClient

Execute an HTTP request.

Specified by:

executeRequest in interface AsyncHttpClient

Type Parameters:

T - Type of the value that will be returned by the associated Future

Parameters:

requestBuilder - RequestBuilder

handler - an instance of AsyncHandler

Returns:

a Future of type T

executeRequest

public ListenableFuture<Response> executeRequest(Request request)

Description copied from interface: AsyncHttpClient

Execute an HTTP request.

Specified by:

executeRequest in interface AsyncHttpClient

Parameters:

request - Request

Returns:

a Future of type Response

executeRequest

public ListenableFuture<Response> executeRequest(RequestBuilder requestBuilder)

Description copied from interface: AsyncHttpClient

Execute an HTTP request.

Specified by:

executeRequest in interface AsyncHttpClient

Parameters:

requestBuilder - RequestBuilder

Returns:

a Future of type Response

getChannelPool

public ChannelPool getChannelPool()

getEventLoopGroup

public io.netty.channel.EventLoopGroup getEventLoopGroup()

getClientStats

public ClientStats getClientStats()

Description copied from interface: AsyncHttpClient

Return details about pooled connections.

Specified by:

getClientStats in interface AsyncHttpClient

Returns:

a ClientStats

flushChannelPoolPartitions

public void flushChannelPoolPartitions(java.util.function.Predicate<java.lang.Object> predicate)

Description copied from interface: AsyncHttpClient

Flush ChannelPool partitions based on a predicate

Specified by:

flushChannelPoolPartitions in interface AsyncHttpClient

Parameters:

predicate - the predicate

requestBuilder

protected BoundRequestBuilder requestBuilder(java.lang.String method,
                                             java.lang.String url)

requestBuilder

protected BoundRequestBuilder requestBuilder(Request prototype)

getConfig

public AsyncHttpClientConfig getConfig()

Description copied from interface: AsyncHttpClient

Return the config associated to this client.

Specified by:

getConfig in interface AsyncHttpClient

Returns:

the config associated to this client.