Package org.asynchttpclient

Interface Response

All Known Implementing Classes:

NettyResponse

public interface Response

Represents the asynchronous HTTP response callback for an AsyncCompletionHandler

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Response.ResponseBuilder

Method Summary

Modifier and Type	Method	Description
String	getContentType()	Return the content-type header value.
List<io.netty.handler.codec.http.cookie.Cookie>	getCookies()
String	getHeader(CharSequence name)
io.netty.handler.codec.http.HttpHeaders	getHeaders()
List<String>	getHeaders(CharSequence name)	Return a List of the response header value.
SocketAddress	getLocalAddress()	Get the local address that the client initiated the request from.
SocketAddress	getRemoteAddress()	Get the remote address that the client initiated the request to.
String	getResponseBody()	Return the entire response body as a String.
String	getResponseBody(Charset charset)	Return the entire response body as a String.
io.netty.buffer.ByteBuf	getResponseBodyAsByteBuf()	Return the entire response body as a ByteBuf.
ByteBuffer	getResponseBodyAsByteBuffer()	Return the entire response body as a ByteBuffer.
byte[]	getResponseBodyAsBytes()	Return the entire response body as a byte[].
InputStream	getResponseBodyAsStream()	Returns an input stream for the response body.
int	getStatusCode()	Returns the status code for the request.
String	getStatusText()	Returns the status text for the request.
Uri	getUri()	Return the request Uri.
boolean	hasResponseBody()	Return true if the response's body has been computed by an AsyncHandler.
boolean	hasResponseHeaders()	Return true if the response's headers has been computed by an AsyncHandler It will return false if the either AsyncHandler.onStatusReceived(HttpResponseStatus) or AsyncHandler.onHeadersReceived(HttpHeaders) returned AsyncHandler.State.ABORT
boolean	hasResponseStatus()	Return true if the response's status has been computed by an AsyncHandler
boolean	isRedirected()	Return true if the response redirects to another object.
String	toString()	Subclasses SHOULD implement toString() in a way that identifies the response for logging.

Method Detail

getStatusCode

int getStatusCode()

Returns the status code for the request.

Returns:

The status code

getStatusText

String getStatusText()

Returns the status text for the request.

Returns:

The status text

getResponseBodyAsBytes

byte[] getResponseBodyAsBytes()

Return the entire response body as a byte[].

Returns:

the entire response body as a byte[].

getResponseBodyAsByteBuffer

ByteBuffer getResponseBodyAsByteBuffer()

Return the entire response body as a ByteBuffer.

Returns:

the entire response body as a ByteBuffer.

getResponseBodyAsByteBuf

io.netty.buffer.ByteBuf getResponseBodyAsByteBuf()

Return the entire response body as a ByteBuf.

Returns:

the entire response body as a ByteBuf.

getResponseBodyAsStream

InputStream getResponseBodyAsStream()

Returns an input stream for the response body. Note that you should not try to get this more than once, and that you should not close the stream.

Returns:

The input stream

getResponseBody

String getResponseBody(Charset charset)

Return the entire response body as a String.

Parameters:

charset - the charset to use when decoding the stream

Returns:

the entire response body as a String.

getResponseBody

String getResponseBody()

Return the entire response body as a String.

Returns:

the entire response body as a String.

getUri

Uri getUri()

Return the request Uri. Note that if the request got redirected, the value of the Uri will be the last valid redirect url.

Returns:

the request Uri.

getContentType

String getContentType()

Return the content-type header value.

Returns:

the content-type header value.

getHeader

String getHeader(CharSequence name)

Parameters:

name - the header name

Returns:

the first response header value

getHeaders

List<String> getHeaders(CharSequence name)

Return a List of the response header value.

Parameters:

name - the header name

Returns:

the response header value

getHeaders

io.netty.handler.codec.http.HttpHeaders getHeaders()

isRedirected

boolean isRedirected()

Return true if the response redirects to another object.

Returns:

True if the response redirects to another object.

toString

String toString()

Subclasses SHOULD implement toString() in a way that identifies the response for logging.

Overrides:

toString in class Object

Returns:

the textual representation

getCookies

List<io.netty.handler.codec.http.cookie.Cookie> getCookies()

Returns:

the list of Cookie.

hasResponseStatus

boolean hasResponseStatus()

Return true if the response's status has been computed by an AsyncHandler

Returns:

true if the response's status has been computed by an AsyncHandler

hasResponseHeaders

boolean hasResponseHeaders()

Return true if the response's headers has been computed by an AsyncHandler It will return false if the either AsyncHandler.onStatusReceived(HttpResponseStatus) or AsyncHandler.onHeadersReceived(HttpHeaders) returned AsyncHandler.State.ABORT

Returns:

true if the response's headers has been computed by an AsyncHandler

hasResponseBody

boolean hasResponseBody()

Return true if the response's body has been computed by an AsyncHandler. It will return false if:

• either the AsyncHandler.onStatusReceived(HttpResponseStatus) returned AsyncHandler.State.ABORT
• or AsyncHandler.onHeadersReceived(HttpHeaders) returned AsyncHandler.State.ABORT
• response body was empty

Returns:

true if the response's body has been computed by an AsyncHandler to new empty bytes

getRemoteAddress

SocketAddress getRemoteAddress()

Get the remote address that the client initiated the request to.

Returns:

The remote address that the client initiated the request to. May be null if asynchronous provider is unable to provide the remote address

getLocalAddress

SocketAddress getLocalAddress()

Get the local address that the client initiated the request from.

Returns:

The local address that the client initiated the request from. May be null if asynchronous provider is unable to provide the local address