org.springframework.http.client

Class HttpComponentsAsyncClientHttpRequestFactory

java.lang.Object

org.springframework.http.client.HttpComponentsClientHttpRequestFactory

org.springframework.http.client.HttpComponentsAsyncClientHttpRequestFactory

All Implemented Interfaces:

DisposableBean, InitializingBean, AsyncClientHttpRequestFactory, ClientHttpRequestFactory

public class HttpComponentsAsyncClientHttpRequestFactory
extends HttpComponentsClientHttpRequestFactory
implements AsyncClientHttpRequestFactory, InitializingBean

Asynchronous extension of the HttpComponentsClientHttpRequestFactory. Uses Apache HttpComponents HttpAsyncClient 4.0 to create requests.

Since:

4.0

Author:

Arjen Poutsma, Stephane Nicoll

See Also:

HttpAsyncClient

Constructor Summary

Constructors

Constructor and Description
HttpComponentsAsyncClientHttpRequestFactory() Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with a default HttpAsyncClient and HttpClient.
HttpComponentsAsyncClientHttpRequestFactory(org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncClient) Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given CloseableHttpAsyncClient instance and a default HttpClient.
HttpComponentsAsyncClientHttpRequestFactory(CloseableHttpClient httpClient, org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncClient) Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given CloseableHttpClient and CloseableHttpAsyncClient instances.
HttpComponentsAsyncClientHttpRequestFactory(org.apache.http.nio.client.HttpAsyncClient asyncClient) Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpAsyncClient instance and a default HttpClient.
HttpComponentsAsyncClientHttpRequestFactory(HttpClient httpClient, org.apache.http.nio.client.HttpAsyncClient asyncClient) Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpClient and HttpAsyncClient instances.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
AsyncClientHttpRequest	createAsyncRequest(java.net.URI uri, HttpMethod httpMethod) Create a new asynchronous AsyncClientHttpRequest for the specified URI and HTTP method.
void	destroy() Shutdown hook that closes the underlying ClientConnectionManager's connection pool, if any.
org.apache.http.nio.client.HttpAsyncClient	getAsyncClient() Return the HttpAsyncClient used for synchronous execution.
org.apache.http.impl.nio.client.CloseableHttpAsyncClient	getHttpAsyncClient() Deprecated. as of 4.3.10, in favor of getAsyncClient()
void	setAsyncClient(org.apache.http.nio.client.HttpAsyncClient asyncClient) Set the HttpAsyncClient used for synchronous execution.
void	setHttpAsyncClient(org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncClient) Deprecated. as of 4.3.10, in favor of setAsyncClient(HttpAsyncClient)

Methods inherited from class org.springframework.http.client.HttpComponentsClientHttpRequestFactory

createHttpContext, createHttpUriRequest, createRequest, createRequestConfig, getHttpClient, mergeRequestConfig, postProcessHttpRequest, setBufferRequestBody, setConnectionRequestTimeout, setConnectTimeout, setHttpClient, setReadTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory()

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with a default HttpAsyncClient and HttpClient.

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory(org.apache.http.nio.client.HttpAsyncClient asyncClient)

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpAsyncClient instance and a default HttpClient.

Parameters:

asyncClient - the HttpAsyncClient instance to use for this request factory

Since:

4.3.10

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory(org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncClient)

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given CloseableHttpAsyncClient instance and a default HttpClient.

Parameters:

asyncClient - the CloseableHttpAsyncClient instance to use for this request factory

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory(HttpClient httpClient,
                                                   org.apache.http.nio.client.HttpAsyncClient asyncClient)

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given HttpClient and HttpAsyncClient instances.

Parameters:

httpClient - the HttpClient instance to use for this request factory

asyncClient - the HttpAsyncClient instance to use for this request factory

Since:

4.3.10

HttpComponentsAsyncClientHttpRequestFactory

public HttpComponentsAsyncClientHttpRequestFactory(CloseableHttpClient httpClient,
                                                   org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncClient)

Create a new instance of the HttpComponentsAsyncClientHttpRequestFactory with the given CloseableHttpClient and CloseableHttpAsyncClient instances.

Parameters:

httpClient - the CloseableHttpClient instance to use for this request factory

asyncClient - the CloseableHttpAsyncClient instance to use for this request factory

Method Detail

setAsyncClient

public void setAsyncClient(org.apache.http.nio.client.HttpAsyncClient asyncClient)

Set the HttpAsyncClient used for synchronous execution.

Since:

4.3.10

See Also:

HttpComponentsClientHttpRequestFactory.setHttpClient(HttpClient)

getAsyncClient

public org.apache.http.nio.client.HttpAsyncClient getAsyncClient()

Return the HttpAsyncClient used for synchronous execution.

Since:

4.3.10

See Also:

HttpComponentsClientHttpRequestFactory.getHttpClient()

setHttpAsyncClient

@Deprecated
public void setHttpAsyncClient(org.apache.http.impl.nio.client.CloseableHttpAsyncClient asyncClient)

Deprecated. as of 4.3.10, in favor of setAsyncClient(HttpAsyncClient)

Set the CloseableHttpAsyncClient used for asynchronous execution.

getHttpAsyncClient

@Deprecated
public org.apache.http.impl.nio.client.CloseableHttpAsyncClient getHttpAsyncClient()

Deprecated. as of 4.3.10, in favor of getAsyncClient()

Return the CloseableHttpAsyncClient used for asynchronous execution.

afterPropertiesSet

public void afterPropertiesSet()

Description copied from interface: InitializingBean

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Specified by:

afterPropertiesSet in interface InitializingBean

createAsyncRequest

public AsyncClientHttpRequest createAsyncRequest(java.net.URI uri,
                                                 HttpMethod httpMethod)
                                          throws java.io.IOException

Description copied from interface: AsyncClientHttpRequestFactory

Create a new asynchronous AsyncClientHttpRequest for the specified URI and HTTP method.

The returned request can be written to, and then executed by calling AsyncClientHttpRequest.executeAsync().

Specified by:

createAsyncRequest in interface AsyncClientHttpRequestFactory

Parameters:

uri - the URI to create a request for

httpMethod - the HTTP method to execute

Returns:

the created request

Throws:

java.io.IOException - in case of I/O errors

destroy

public void destroy()
             throws java.lang.Exception

Description copied from class: HttpComponentsClientHttpRequestFactory

Shutdown hook that closes the underlying ClientConnectionManager's connection pool, if any.

Specified by:

destroy in interface DisposableBean

Overrides:

destroy in class HttpComponentsClientHttpRequestFactory

Throws:

java.lang.Exception - in case of shutdown errors. Exceptions will get logged but not rethrown to allow other beans to release their resources as well.