org.springframework.http.client

Class HttpComponentsStreamingClientHttpRequest

java.lang.Object

org.springframework.http.client.AbstractClientHttpRequest

org.springframework.http.client.HttpComponentsStreamingClientHttpRequest

All Implemented Interfaces:

ClientHttpRequest, HttpMessage, HttpOutputMessage, HttpRequest, StreamingHttpOutputMessage

final class HttpComponentsStreamingClientHttpRequest
extends AbstractClientHttpRequest
implements StreamingHttpOutputMessage

ClientHttpRequest implementation that uses Apache HttpComponents HttpClient to execute requests.

Created via the HttpComponentsClientHttpRequestFactory.

Since:

4.0

Author:

Arjen Poutsma

See Also:

HttpComponentsClientHttpRequestFactory.createRequest(java.net.URI, org.springframework.http.HttpMethod)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HttpComponentsStreamingClientHttpRequest.StreamingHttpEntity

Nested classes/interfaces inherited from interface org.springframework.http.StreamingHttpOutputMessage

StreamingHttpOutputMessage.Body

Field Summary

Fields

Modifier and Type	Field and Description
private StreamingHttpOutputMessage.Body	body
private HttpClient	httpClient
private HttpContext	httpContext
private HttpUriRequest	httpRequest

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected ClientHttpResponse	executeInternal(HttpHeaders headers) Abstract template method that writes the given headers and content to the HTTP request.
protected java.io.OutputStream	getBodyInternal(HttpHeaders headers) Abstract template method that returns the body.
HttpMethod	getMethod() Return the HTTP method of the request.
java.net.URI	getURI() Return the URI of the request.
void	setBody(StreamingHttpOutputMessage.Body body) Set the streaming body for this message.

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

Methods inherited from interface org.springframework.http.HttpOutputMessage

getBody

Methods inherited from interface org.springframework.http.HttpMessage

getHeaders

Field Detail

httpClient

private final HttpClient httpClient

httpRequest

private final HttpUriRequest httpRequest

httpContext

private final HttpContext httpContext

body

private StreamingHttpOutputMessage.Body body

Constructor Detail

HttpComponentsStreamingClientHttpRequest

HttpComponentsStreamingClientHttpRequest(HttpClient httpClient,
                                         HttpUriRequest httpRequest,
                                         HttpContext httpContext)

Method Detail

getMethod

public HttpMethod getMethod()

Description copied from interface: HttpRequest

Return the HTTP method of the request.

Specified by:

getMethod in interface HttpRequest

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.

Specified by:

getURI in interface HttpRequest

Returns:

the URI of the request (never null)

setBody

public void setBody(StreamingHttpOutputMessage.Body body)

Description copied from interface: StreamingHttpOutputMessage

Set the streaming body for this message.

Specified by:

setBody in interface StreamingHttpOutputMessage

Parameters:

body - the streaming body

getBodyInternal

protected java.io.OutputStream getBodyInternal(HttpHeaders headers)
                                        throws java.io.IOException

Description copied from class: AbstractClientHttpRequest

Abstract template method that returns the body.

Specified by:

getBodyInternal in class AbstractClientHttpRequest

Parameters:

headers - the HTTP headers

Returns:

the body output stream

Throws:

java.io.IOException

executeInternal

protected ClientHttpResponse executeInternal(HttpHeaders headers)
                                      throws java.io.IOException

Description copied from class: AbstractClientHttpRequest

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

Specified by:

executeInternal in class AbstractClientHttpRequest

Parameters:

headers - the HTTP headers

Returns:

the response object for the executed request

Throws:

java.io.IOException