Interface Response

All Known Subinterfaces:

ContentResponse

All Known Implementing Classes:

HttpResponse

public interface Response

Response represents an HTTP response and offers methods to retrieve status code, HTTP version and headers.

Response objects are passed as parameters to Response.Listener callbacks, or as future result of Request.send().

Response objects do not contain getters for the response content, because it may be too large to fit into memory. The response content should be retrieved via content events, or via utility classes such as BufferingResponseListener.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Response.AsyncContentListener	Asynchronous listener for the response content events.
static interface	Response.BeginListener	Listener for the response begin event.
static interface	Response.CompleteListener	Listener for the request and response completed event.
static interface	Response.ContentListener	Synchronous listener for the response content events.
static interface	Response.ContentSourceListener	Asynchronous listener for the response content events.
static interface	Response.FailureListener	Listener for the response failure event.
static interface	Response.HeaderListener	Listener for a response header event.
static interface	Response.HeadersListener	Listener for the response headers event.
static interface	Response.Listener	Listener for all response events.
static interface	Response.ResponseListener	Common, empty, super-interface for response listeners
static interface	Response.SuccessListener	Listener for the response succeeded event.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Boolean>	abort(Throwable cause)	Attempts to abort the receive of this response.
HttpFields	getHeaders()	Returns the headers of this response.
String	getReason()
Request	getRequest()
int	getStatus()
HttpFields	getTrailers()
HttpVersion	getVersion()

Method Details

getRequest

Request getRequest()

Returns:

the request associated with this response

getVersion

HttpVersion getVersion()

Returns:

the HTTP version of this response, such as "HTTP/1.1"

getStatus

int getStatus()

Returns:

the HTTP status code of this response, such as 200 or 404

getReason

String getReason()

Returns:

the HTTP reason associated to the getStatus()

getHeaders

HttpFields getHeaders()

Returns the headers of this response.

Some headers sent by the server may not be present, or be present but modified, while the content is being processed. A typical example is the Content-Length header when the content is sent compressed by the server and automatically decompressed by the client: the Content-Length header will be removed.

Similarly, the Content-Encoding header may be removed or modified, as the content is decoded by the client.

Returns:

the headers of this response

getTrailers

HttpFields getTrailers()

Returns:

the trailers of this response

abort

CompletableFuture<Boolean> abort(Throwable cause)

Attempts to abort the receive of this response.

Parameters:

cause - the abort cause, must not be null

Returns:

whether the abort succeeded