org.springframework.http.client

Class HttpComponentsClientHttpRequest

java.lang.Object

org.springframework.http.client.AbstractClientHttpRequest

org.springframework.http.client.AbstractBufferingClientHttpRequest

org.springframework.http.client.HttpComponentsClientHttpRequest

All Implemented Interfaces:

ClientHttpRequest, HttpMessage, HttpOutputMessage, HttpRequest

final class HttpComponentsClientHttpRequest
extends AbstractBufferingClientHttpRequest

ClientHttpRequest implementation that uses Apache HttpComponents HttpClient to execute requests.

Created via the HttpComponentsClientHttpRequestFactory.

NOTE: Requires Apache HttpComponents 4.3 or higher, as of Spring 4.0.

Since:

3.1

Author:

Oleg Kalnichevski, Arjen Poutsma, Juergen Hoeller

See Also:

HttpComponentsClientHttpRequestFactory.createRequest(URI, HttpMethod)

Field Summary

Fields

Modifier and Type	Field and Description
private HttpClient	httpClient
private HttpContext	httpContext
private HttpUriRequest	httpRequest

Constructor Summary

Constructors

Constructor and Description
HttpComponentsClientHttpRequest(HttpClient httpClient, HttpUriRequest httpRequest, HttpContext httpContext)

Method Summary

Modifier and Type	Method and Description
(package private) static void	addHeaders(HttpUriRequest httpRequest, HttpHeaders headers) Add the given headers to the given HTTP request.
protected ClientHttpResponse	executeInternal(HttpHeaders headers, byte[] bufferedOutput) Abstract template method that writes the given headers and content to the HTTP request.
(package private) HttpContext	getHttpContext()
HttpMethod	getMethod() Return the HTTP method of the request.
java.net.URI	getURI() Return the URI of the request.

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

executeInternal, getBodyInternal

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

assertNotExecuted, execute, getBody, getHeaders

Methods inherited from class java.lang.Object

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

Field Detail

httpClient

private final HttpClient httpClient

httpRequest

private final HttpUriRequest httpRequest

httpContext

private final HttpContext httpContext

Constructor Detail

HttpComponentsClientHttpRequest

HttpComponentsClientHttpRequest(HttpClient httpClient,
                                HttpUriRequest httpRequest,
                                HttpContext httpContext)

Method Detail

getMethod

public HttpMethod getMethod()

Description copied from interface: HttpRequest

Return the HTTP method of the request.

Returns:

the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)

getURI

public java.net.URI getURI()

Description copied from interface: HttpRequest

Return the URI of the request.

Returns:

the URI of the request (never null)

getHttpContext

HttpContext getHttpContext()

executeInternal

protected ClientHttpResponse executeInternal(HttpHeaders headers,
                                             byte[] bufferedOutput)
                                      throws java.io.IOException

Description copied from class: AbstractBufferingClientHttpRequest

Abstract template method that writes the given headers and content to the HTTP request.

Specified by:

executeInternal in class AbstractBufferingClientHttpRequest

Parameters:

headers - the HTTP headers

bufferedOutput - the body content

Returns:

the response object for the executed request

Throws:

java.io.IOException

addHeaders

static void addHeaders(HttpUriRequest httpRequest,
                       HttpHeaders headers)

Add the given headers to the given HTTP request.

Parameters:

httpRequest - the request to add the headers to

headers - the headers to add