org.springframework.http.client

Class HttpComponentsClientHttpRequestFactory

java.lang.Object

org.springframework.http.client.HttpComponentsClientHttpRequestFactory

All Implemented Interfaces:

DisposableBean, ClientHttpRequestFactory

Direct Known Subclasses:

HttpComponentsAsyncClientHttpRequestFactory

public class HttpComponentsClientHttpRequestFactory
extends java.lang.Object
implements ClientHttpRequestFactory, DisposableBean

ClientHttpRequestFactory implementation that uses Apache HttpComponents HttpClient to create requests.

Allows to use a pre-configured HttpClient instance - potentially with authentication, HTTP connection pooling, etc.

Since:

3.1

Author:

Oleg Kalnichevski, Arjen Poutsma

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	bufferRequestBody
private int	connectTimeout
private CloseableHttpClient	httpClient
private int	socketTimeout

Constructor Summary

Constructors

Constructor and Description
HttpComponentsClientHttpRequestFactory() Create a new instance of the HttpComponentsClientHttpRequestFactory with a default HttpClient.
HttpComponentsClientHttpRequestFactory(CloseableHttpClient httpClient) Create a new instance of the HttpComponentsClientHttpRequestFactory with the given HttpClient instance.

Method Summary

Modifier and Type	Method and Description
protected HttpContext	createHttpContext(HttpMethod httpMethod, java.net.URI uri) Template methods that creates a HttpContext for the given HTTP method and URI.
protected HttpUriRequest	createHttpUriRequest(HttpMethod httpMethod, java.net.URI uri) Create a Commons HttpMethodBase object for the given HTTP method and URI specification.
ClientHttpRequest	createRequest(java.net.URI uri, HttpMethod httpMethod) Create a new ClientHttpRequest for the specified URI and HTTP method.
void	destroy() Shutdown hook that closes the underlying ClientConnectionManager's connection pool, if any.
CloseableHttpClient	getHttpClient() Return the HttpClient used for synchronous execution.
boolean	isBufferRequestBody() Indicates whether this request factory should buffer the request body internally.
protected void	postProcessHttpRequest(HttpUriRequest request) Template method that allows for manipulating the HttpUriRequest before it is returned as part of a HttpComponentsClientHttpRequest.
void	setBufferRequestBody(boolean bufferRequestBody) Indicates whether this request factory should buffer the request body internally.
void	setConnectTimeout(int timeout) Set the connection timeout for the underlying HttpClient.
void	setHttpClient(CloseableHttpClient httpClient) Set the HttpClient used for synchronous execution.
void	setReadTimeout(int timeout) Set the socket read timeout for the underlying HttpClient.

Methods inherited from class java.lang.Object

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

Field Detail

connectTimeout

private int connectTimeout

socketTimeout

private int socketTimeout

httpClient

private CloseableHttpClient httpClient

bufferRequestBody

private boolean bufferRequestBody

Constructor Detail

HttpComponentsClientHttpRequestFactory

public HttpComponentsClientHttpRequestFactory()

Create a new instance of the HttpComponentsClientHttpRequestFactory with a default HttpClient.

HttpComponentsClientHttpRequestFactory

public HttpComponentsClientHttpRequestFactory(CloseableHttpClient httpClient)

Create a new instance of the HttpComponentsClientHttpRequestFactory with the given HttpClient instance.

Parameters:

httpClient - the HttpClient instance to use for this request factory

Method Detail

setHttpClient

public void setHttpClient(CloseableHttpClient httpClient)

Set the HttpClient used for synchronous execution.

getHttpClient

public CloseableHttpClient getHttpClient()

Return the HttpClient used for synchronous execution.

setConnectTimeout

public void setConnectTimeout(int timeout)

Set the connection timeout for the underlying HttpClient. A timeout value of 0 specifies an infinite timeout.

Parameters:

timeout - the timeout value in milliseconds

setReadTimeout

public void setReadTimeout(int timeout)

Set the socket read timeout for the underlying HttpClient. A timeout value of 0 specifies an infinite timeout.

Parameters:

timeout - the timeout value in milliseconds

setBufferRequestBody

public void setBufferRequestBody(boolean bufferRequestBody)

Indicates whether this request factory should buffer the request body internally.

Default is true. When sending large amounts of data via POST or PUT, it is recommended to change this property to false, so as not to run out of memory.

isBufferRequestBody

public boolean isBufferRequestBody()

Indicates whether this request factory should buffer the request body internally.

createRequest

public ClientHttpRequest createRequest(java.net.URI uri,
                                       HttpMethod httpMethod)
                                throws java.io.IOException

Description copied from interface: ClientHttpRequestFactory

Create a new ClientHttpRequest for the specified URI and HTTP method.

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

Specified by:

createRequest in interface ClientHttpRequestFactory

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

createHttpUriRequest

protected HttpUriRequest createHttpUriRequest(HttpMethod httpMethod,
                                              java.net.URI uri)

Create a Commons HttpMethodBase object for the given HTTP method and URI specification.

Parameters:

httpMethod - the HTTP method

uri - the URI

Returns:

the Commons HttpMethodBase object

postProcessHttpRequest

protected void postProcessHttpRequest(HttpUriRequest request)

Template method that allows for manipulating the HttpUriRequest before it is returned as part of a HttpComponentsClientHttpRequest.

The default implementation is empty.

Parameters:

request - the request to process

createHttpContext

protected HttpContext createHttpContext(HttpMethod httpMethod,
                                        java.net.URI uri)

Template methods that creates a HttpContext for the given HTTP method and URI.

The default implementation returns null.

Parameters:

httpMethod - the HTTP method

uri - the URI

Returns:

the http context

destroy

public void destroy()
             throws java.lang.Exception

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

Specified by:

destroy in interface DisposableBean

Throws:

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