Package org.dmfs.httpessentials.client

Interface HttpRequest<T>

Type Parameters:

T - The type of the expected response.

public interface HttpRequest<T>

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

Method Summary

Modifier and Type	Method	Description
Headers	headers()	Returns a Headers 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 Details

method

HttpMethod method()

Returns the HTTP method of this request.

Returns:

The HttpMethod this request uses.

headers

Headers headers()

Returns a Headers containing the Headers to send with the request.

Returns:

A Headers, never null.

requestEntity

HttpRequestEntity requestEntity()

Returns an HttpRequestEntity that contains the body of this request.

Returns:

An HttpRequestEntity object, never null.

responseHandler

HttpResponseHandler<T> responseHandler(HttpResponse response)
                                throws 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:

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.