cz.jirutka.spring.http.client.cache.internal

Class SizeLimitedHttpResponseReader

java.lang.Object

cz.jirutka.spring.http.client.cache.internal.SizeLimitedHttpResponseReader

All Implemented Interfaces:

HttpResponseReader

@Immutable
public class SizeLimitedHttpResponseReader
extends Object
implements HttpResponseReader

HttpResponseReader implementation that reads a response until the specified size limit.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SizeLimitedHttpResponseReader.ResponseSizeLimitExceededException

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
SizeLimitedHttpResponseReader(int maxBodySize) Construct with a default buffer size.
SizeLimitedHttpResponseReader(int maxBodySize, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
InMemoryClientHttpResponse	readResponse(org.springframework.http.client.ClientHttpResponse response) Reads the original ClientHttpResponse to memory, if possible, and returns a serializable copy.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

Constructor Detail

SizeLimitedHttpResponseReader

public SizeLimitedHttpResponseReader(int maxBodySize)

Construct with a default buffer size.

Parameters:

maxBodySize - The maximal size to read in bytes. It must be greater then zero and should be multiple of the DEFAULT_BUFFER_SIZE.

SizeLimitedHttpResponseReader

public SizeLimitedHttpResponseReader(int maxBodySize,
                             int bufferSize)

Parameters:

maxBodySize - The maximal size to read in bytes. It must be greater then zero and should be multiple of the bufferSize.

bufferSize - The buffer size in bytes. It must be greater then zero.

Method Detail

readResponse

public InMemoryClientHttpResponse readResponse(org.springframework.http.client.ClientHttpResponse response)
                                        throws SizeLimitedHttpResponseReader.ResponseSizeLimitExceededException,
                                               IOException

Reads the original ClientHttpResponse to memory, if possible, and returns a serializable copy. If the response's body size exceeds the specified maxBodySize limit, then it throws SizeLimitedHttpResponseReader.ResponseSizeLimitExceededException with a reconstructed response that combines an already read bytes in memory and the original response.

Specified by:

readResponse in interface HttpResponseReader

Parameters:

response - The original response to read.

Returns:

An in-memory copy of the original response.

Throws:

SizeLimitedHttpResponseReader.ResponseSizeLimitExceededException - When the response's body size exceeds the specified maxBodySize limit.

IOException