public interface AsyncHttpClient extends Closeable
The code above will block until the response is fully received. To execute asynchronous HTTP request, you create anAsyncHttpClient c = new AsyncHttpClient(); Futuref = c.prepareGet("http://www.ning.com/").execute();
AsyncHandler
or its abstract implementation, AsyncCompletionHandler
AsyncHttpClient c = new AsyncHttpClient(); Futuref = c.prepareGet("http://www.ning.com/").execute(new AsyncCompletionHandler () { @Override public Response onCompleted(Response response) throws IOException { // Do something return response; } @Override public void onThrowable(Throwable t) { } }); Response response = f.get(); // We are just interested to retrieve the status code. Future f = c.prepareGet("http://www.ning.com/").execute(new AsyncCompletionHandler () { @Override public Integer onCompleted(Response response) throws IOException { // Do something return response.getStatusCode(); } @Override public void onThrowable(Throwable t) { } }); Integer statusCode = f.get();
AsyncCompletionHandler.onCompleted(Response)
will be invoked once the http response has been fully read, which include
the http headers and the response body. Note that the entire response will be buffered in memory.
You can also have more control about the how the response is asynchronously processed by using a AsyncHandler
HttpContent sub classes, you can asynchronously process the response status,headers and body and decide when to stop the processing the response by throwing a new {link ResponseComplete} at any moment. This class can also be used without the need ofAsyncHttpClient c = new AsyncHttpClient(); Futuref = c.prepareGet("http://www.ning.com/").execute(new AsyncHandler () { private StringBuilder builder = new StringBuilder(); @Override public STATE onStatusReceived(HttpResponseStatus s) throws Exception { // return STATE.CONTINUE or STATE.ABORT return STATE.CONTINUE } @Override public STATE onHeadersReceived(HttpResponseHeaders bodyPart) throws Exception { // return STATE.CONTINUE or STATE.ABORT return STATE.CONTINUE } @Override public STATE onBodyPartReceived(HttpResponseBodyPart bodyPart) throws Exception { builder.append(new String(bodyPart)); // return STATE.CONTINUE or STATE.ABORT return STATE.CONTINUE } @Override public String onCompleted() throws Exception { // Will be invoked once the response has been fully read or a ResponseComplete exception // has been thrown. return builder.toString(); } @Override public void onThrowable(Throwable t) { } }); String bodyResponse = f.get();
AsyncHandler
Finally, you can configure the AsyncHttpClient using anAsyncHttpClient c = new AsyncHttpClient(); Futuref = c.prepareGet(TARGET_URL).execute(); Response r = f.get();
AsyncHttpClientConfig
instance
An instance of this class will cache every HTTP 1.1 connections and close them when theAsyncHttpClient c = new AsyncHttpClient(new AsyncHttpClientConfig.Builder().setRequestTimeoutInMs(...).build()); Futuref = c.prepareGet(TARGET_URL).execute(); Response r = f.get();
AsyncHttpClientConfig.getReadTimeout()
expires. This object can hold many persistent connections to different host.Modifier and Type | Method and Description |
---|---|
void |
closeAsynchronously()
Asynchronous close the
AsyncHttpClient by spawning a thread and avoid blocking. |
ListenableFuture<Response> |
executeRequest(Request request)
Execute an HTTP request.
|
<T> ListenableFuture<T> |
executeRequest(Request request,
AsyncHandler<T> handler)
Execute an HTTP request.
|
boolean |
isClosed()
Return true if closed
|
BoundRequestBuilder |
prepareConnect(String url)
Prepare an HTTP client CONNECT request.
|
BoundRequestBuilder |
prepareDelete(String url)
Prepare an HTTP client DELETE request.
|
BoundRequestBuilder |
prepareGet(String url)
Prepare an HTTP client GET request.
|
BoundRequestBuilder |
prepareHead(String url)
Prepare an HTTP client HEAD request.
|
BoundRequestBuilder |
prepareOptions(String url)
Prepare an HTTP client OPTIONS request.
|
BoundRequestBuilder |
preparePatch(String url)
Prepare an HTTP client PATCH request.
|
BoundRequestBuilder |
preparePost(String url)
Prepare an HTTP client POST request.
|
BoundRequestBuilder |
preparePut(String url)
Prepare an HTTP client PUT request.
|
BoundRequestBuilder |
prepareRequest(Request request)
Construct a
RequestBuilder using a Request |
BoundRequestBuilder |
prepareTrace(String url)
Prepare an HTTP client TRACE request.
|
AsyncHttpClient |
setSignatureCalculator(SignatureCalculator signatureCalculator)
Set default signature calculator to use for requests build by this client instance
|
void closeAsynchronously()
AsyncHttpClient
by spawning a thread and avoid blocking.boolean isClosed()
AsyncHttpClient setSignatureCalculator(SignatureCalculator signatureCalculator)
BoundRequestBuilder prepareGet(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder prepareConnect(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder prepareOptions(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder prepareHead(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder preparePost(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder preparePut(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder prepareDelete(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder preparePatch(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder prepareTrace(String url)
url
- A well formed URL.RequestBuilder
BoundRequestBuilder prepareRequest(Request request)
RequestBuilder
using a Request
request
- a Request
RequestBuilder
<T> ListenableFuture<T> executeRequest(Request request, AsyncHandler<T> handler)
T
- Type of the value that will be returned by the associated Future
request
- Request
handler
- an instance of AsyncHandler
Future
of type TListenableFuture<Response> executeRequest(Request request)
Copyright © 2015. All Rights Reserved.