org.dmfs.httpclientinterfaces

Interface HttpRequest<T>

Type Parameters:

T - The type of the expected response.

All Known Implementing Classes:

BufferedRequest

public interface HttpRequest<T>

Defines an interface of an HTTP request. The request is typed to the class of the expected response.

Author:

Marten Gajda

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.

Method Detail

method

HttpMethod method()

Returns the HTTP method of this request.

Returns:

The HttpMethod this request uses.

headers

HeaderList headers()

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

Returns:

A HeaderList, never null.

requestEntity

HttpRequestEntity requestEntity()

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.

Returns:

An HttpRequestEntity object.

responseHandler

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

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

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.