Class AbstractStreamingClientHttpRequest

java.lang.Object

org.springframework.http.client.AbstractClientHttpRequest

org.springframework.http.client.AbstractStreamingClientHttpRequest

All Implemented Interfaces:

ClientHttpRequest, HttpMessage, HttpOutputMessage, HttpRequest, StreamingHttpOutputMessage

public abstract class AbstractStreamingClientHttpRequest
extends AbstractClientHttpRequest
implements StreamingHttpOutputMessage

Extension of AbstractClientHttpRequest that adds the ability to stream request body content directly to the underlying HTTP client library through the StreamingHttpOutputMessage contract.

It is necessary to call setBody(StreamingHttpOutputMessage.Body) and stream the request body through a callback for access to the OutputStream. The alternative to call AbstractClientHttpRequest.getBody() is also supported as a fallback, but that does not stream, and returns an aggregating OutputStream instead.

Since:

6.1

Author:

Arjen Poutsma, Rossen Stoyanchev

Nested Class Summary

Nested classes/interfaces inherited from interface StreamingHttpOutputMessage

StreamingHttpOutputMessage.Body

Constructor Summary

Constructors

Constructor	Description
AbstractStreamingClientHttpRequest()

Method Summary

Modifier and Type	Method	Description
protected final ClientHttpResponse	executeInternal(HttpHeaders headers)	Abstract template method that writes the given headers and content to the HTTP request.
protected abstract ClientHttpResponse	executeInternal(HttpHeaders headers, @Nullable StreamingHttpOutputMessage.Body body)	Abstract method for concrete implementations to write the headers and StreamingHttpOutputMessage.Body to the HTTP request.
protected final OutputStream	getBodyInternal(HttpHeaders headers)	Implements the HttpOutputMessage contract for request body content.
final void	setBody(StreamingHttpOutputMessage.Body body)	Implements the StreamingHttpOutputMessage contract for writing request body by streaming directly to the underlying HTTP client.

Methods inherited from class AbstractClientHttpRequest

assertNotExecuted, execute, getAttributes, getBody, getHeaders

Methods inherited from class Object

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

Methods inherited from interface HttpMessage

getHeaders

Methods inherited from interface HttpOutputMessage

getBody

Methods inherited from interface HttpRequest

getMethod, getURI

Methods inherited from interface StreamingHttpOutputMessage

setBody

Constructor Details

AbstractStreamingClientHttpRequest

public AbstractStreamingClientHttpRequest()

Method Details

getBodyInternal

protected final OutputStream getBodyInternal(HttpHeaders headers)

Implements the HttpOutputMessage contract for request body content.

Note that this method does not result in streaming, and the returned OutputStream aggregates the full content in a byte[] before sending. To use streaming, call setBody(StreamingHttpOutputMessage.Body) instead.

Specified by:

getBodyInternal in class AbstractClientHttpRequest

Parameters:

headers - the HTTP headers

Returns:

the body output stream

setBody

public final void setBody(StreamingHttpOutputMessage.Body body)

Implements the StreamingHttpOutputMessage contract for writing request body by streaming directly to the underlying HTTP client.

Specified by:

setBody in interface StreamingHttpOutputMessage

Parameters:

body - the streaming body callback

executeInternal

protected final ClientHttpResponse executeInternal(HttpHeaders headers)
                                            throws 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:

IOException

executeInternal

protected abstract ClientHttpResponse executeInternal(HttpHeaders headers,
 @Nullable StreamingHttpOutputMessage.Body body)
                                               throws IOException

Abstract method for concrete implementations to write the headers and StreamingHttpOutputMessage.Body to the HTTP request.

Parameters:

headers - the HTTP headers for the request

body - the HTTP body, may be null if no body was set

Returns:

the response object for the executed request

Throws:

IOException

Since:

6.1