Class BufferingClientHttpRequestFactory

java.lang.Object

org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper

org.springframework.http.client.BufferingClientHttpRequestFactory

All Implemented Interfaces:

ClientHttpRequestFactory

public class BufferingClientHttpRequestFactory
extends AbstractClientHttpRequestFactoryWrapper

ClientHttpRequestFactory that wraps another in order to buffer outgoing and incoming content in memory, making it possible to set a content-length on the request, and to read the response body multiple times.

Note: as of 7.0, buffering can be enabled through RestClient.Builder.bufferContent(BiPredicate) and therefore it is not necessary for applications to use this class directly.

Since:

3.1

Author:

Arjen Poutsma, Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
BufferingClientHttpRequestFactory(ClientHttpRequestFactory requestFactory)	Create a buffering wrapper for the given ClientHttpRequestFactory.
BufferingClientHttpRequestFactory(ClientHttpRequestFactory requestFactory, @Nullable BiPredicate<URI, HttpMethod> bufferingPredicate)	Constructor variant with an additional predicate to decide whether to buffer the response.

Method Summary

Modifier and Type	Method	Description
protected ClientHttpRequest	createRequest(URI uri, HttpMethod httpMethod, ClientHttpRequestFactory requestFactory)	Create a new ClientHttpRequest for the specified URI and HTTP method by using the passed-on request factory.
protected boolean	shouldBuffer(URI uri, HttpMethod httpMethod)	Indicates whether the request/response exchange for the given URI and method should be buffered in memory.

Methods inherited from class AbstractClientHttpRequestFactoryWrapper

createRequest, getDelegate

Methods inherited from class Object

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

Constructor Details

BufferingClientHttpRequestFactory

public BufferingClientHttpRequestFactory(ClientHttpRequestFactory requestFactory)

Create a buffering wrapper for the given ClientHttpRequestFactory.

Parameters:

requestFactory - the target request factory to wrap

BufferingClientHttpRequestFactory

public BufferingClientHttpRequestFactory(ClientHttpRequestFactory requestFactory,
 @Nullable BiPredicate<URI, HttpMethod> bufferingPredicate)

Constructor variant with an additional predicate to decide whether to buffer the response.

Since:

7.0

Method Details

createRequest

protected ClientHttpRequest createRequest(URI uri,
 HttpMethod httpMethod,
 ClientHttpRequestFactory requestFactory)
                                   throws IOException

Description copied from class: AbstractClientHttpRequestFactoryWrapper

Create a new ClientHttpRequest for the specified URI and HTTP method by using the passed-on request factory.

Called from AbstractClientHttpRequestFactoryWrapper.createRequest(URI, HttpMethod).

Specified by:

createRequest in class AbstractClientHttpRequestFactoryWrapper

Parameters:

uri - the URI to create a request for

httpMethod - the HTTP method to execute

requestFactory - the wrapped request factory

Returns:

the created request

Throws:

IOException - in case of I/O errors

shouldBuffer

protected boolean shouldBuffer(URI uri,
 HttpMethod httpMethod)

Indicates whether the request/response exchange for the given URI and method should be buffered in memory.

The default implementation returns true for all URIs and methods. Subclasses can override this method to change this behavior.

Parameters:

uri - the URI

httpMethod - the method

Returns:

true if the exchange should be buffered; false otherwise