org.dmfs.httpclientinterfaces.requestutils

Class BufferedRequest<T>

java.lang.Object

org.dmfs.httpclientinterfaces.requestutils.BufferedRequest<T>

Type Parameters:

T - The generic type of the wrapped request.

All Implemented Interfaces:

HttpRequest<T>

public final class BufferedRequest<T>
extends java.lang.Object
implements HttpRequest<T>

A buffered request wrapper. You can use this to wrap request with entities that are generated on demand to avoid chunked encoding, which is not well supported by many servers.

Author:

Marten Gajda

Constructor Summary

Constructors

Constructor and Description
BufferedRequest(HttpRequest<T> request) Creates a BufferedRequest wrapper for the given request with an "unlimited" buffer size.
BufferedRequest(HttpRequest<T> request, int maxBufferSize) Creates a BufferedRequest wrapper for the given request using the given maximum buffer size.

Method Summary

Modifier and Type	Method and Description
HeaderList	headers() Returns a HeaderList containing the Headers to send with the request.
HttpMethod	method() Returns the HTTP method of this request.
HttpRequestEntity	requestEntity() Returns an HttpRequestEntity that contains the body of this request.
HttpResponseHandler<T>	responseHandler(HttpResponse response) Returns a handler for the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedRequest

public BufferedRequest(HttpRequest<T> request)

Creates a BufferedRequest wrapper for the given request with an "unlimited" buffer size.

Parameters:

request - The request to buffer.

BufferedRequest

public BufferedRequest(HttpRequest<T> request,
                       int maxBufferSize)

Creates a BufferedRequest wrapper for the given request using the given maximum buffer size.

Parameters:

request - The request to buffer.

maxBufferSize - The maximum buffer size.

Method Detail

method

public HttpMethod method()

Description copied from interface: HttpRequest

Returns the HTTP method of this request.

Specified by:

method in interface HttpRequest<T>

Returns:

The HttpMethod this request uses.

headers

public HeaderList headers()

Description copied from interface: HttpRequest

Returns a HeaderList containing the Headers to send with the request. Requests that don't need to send any headers should return EmptyHeaderList.INSTANCE.

Specified by:

headers in interface HttpRequest<T>

Returns:

A HeaderList, never null.

requestEntity

public HttpRequestEntity requestEntity()

Description copied from interface: HttpRequest

Returns an HttpRequestEntity that contains the body of this request. If the request doesn't have any message body (like in case of a HttpMethod.GET or an HttpMethods#OPTIONS request) this method should return EmptyHttpRequestEntity.INSTANCE.

Specified by:

requestEntity in interface HttpRequest<T>

Returns:

An HttpRequestEntity object.

responseHandler

public HttpResponseHandler<T> responseHandler(HttpResponse response)
                                       throws java.io.IOException,
                                              ProtocolError,
                                              ProtocolException

Description copied from interface: HttpRequest

Returns a handler for the response. If the response can not be handled an exception is thrown.

Specified by:

responseHandler in interface HttpRequest<T>

Parameters:

response - The HttpResponse that needs to be handled.

Returns:

An HttpResponseHandler.

Throws:

java.io.IOException

ProtocolError - If the response is an error response as specified by the application protocol.

ProtocolException - If the response is invalid or malformed and can not be handled properly.