org.asynchttpclient

Class ResponseBase

java.lang.Object

org.asynchttpclient.ResponseBase

All Implemented Interfaces:

Response

Direct Known Subclasses:

NettyResponse

public abstract class ResponseBase
extends Object
implements Response

Nested Class Summary

Nested classes/interfaces inherited from interface org.asynchttpclient.Response

Response.ResponseBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected List<HttpResponseBodyPart>	bodyParts
protected HttpResponseHeaders	headers
protected HttpResponseStatus	status

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResponseBase(HttpResponseStatus status, HttpResponseHeaders headers, List<HttpResponseBodyPart> bodyParts)

Method Summary

Modifier and Type	Method and Description
protected abstract List<Cookie>	buildCookies()
protected Charset	calculateCharset(Charset charset)
String	getContentType() Return the content-type header value.
List<Cookie>	getCookies()
String	getHeader(String name)
io.netty.handler.codec.http.HttpHeaders	getHeaders()
List<String>	getHeaders(String name) Return a List of the response header value.
SocketAddress	getLocalAddress() Get local address client initiated request from.
SocketAddress	getRemoteAddress() Get remote address client initiated request to.
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(HttpResponseHeaders) 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.asynchttpclient.Response

getResponseBody, getResponseBody, getResponseBodyAsByteBuffer, getResponseBodyAsBytes, getResponseBodyAsStream

Field Detail

bodyParts

protected final List<HttpResponseBodyPart> bodyParts

headers

protected final HttpResponseHeaders headers

status

protected final HttpResponseStatus status

Constructor Detail

ResponseBase

protected ResponseBase(HttpResponseStatus status,
                       HttpResponseHeaders headers,
                       List<HttpResponseBodyPart> bodyParts)

Method Detail

buildCookies

protected abstract List<Cookie> buildCookies()

calculateCharset

protected Charset calculateCharset(Charset charset)

getStatusCode

public final int getStatusCode()

Description copied from interface: Response

Returns the status code for the request.

Specified by:

getStatusCode in interface Response

Returns:

The status code

getStatusText

public final String getStatusText()

Description copied from interface: Response

Returns the status text for the request.

Specified by:

getStatusText in interface Response

Returns:

The status text

getUri

public final Uri getUri()

Description copied from interface: Response

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

Specified by:

getUri in interface Response

Returns:

the request Uri.

getRemoteAddress

public SocketAddress getRemoteAddress()

Description copied from interface: Response

Get remote address client initiated request to.

Specified by:

getRemoteAddress in interface Response

Returns:

remote address client initiated request to, may be null if asynchronous provider is unable to provide the remote address

getLocalAddress

public SocketAddress getLocalAddress()

Description copied from interface: Response

Get local address client initiated request from.

Specified by:

getLocalAddress in interface Response

Returns:

local address client initiated request from, may be null if asynchronous provider is unable to provide the local address

getContentType

public final String getContentType()

Description copied from interface: Response

Return the content-type header value.

Specified by:

getContentType in interface Response

Returns:

the content-type header value.

getHeader

public final String getHeader(String name)

Specified by:

getHeader in interface Response

Parameters:

name - the header name

Returns:

the first response header value

getHeaders

public final List<String> getHeaders(String name)

Description copied from interface: Response

Return a List of the response header value.

Specified by:

getHeaders in interface Response

Parameters:

name - the header name

Returns:

the response header value

getHeaders

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

Specified by:

getHeaders in interface Response

isRedirected

public final boolean isRedirected()

Description copied from interface: Response

Return true if the response redirects to another object.

Specified by:

isRedirected in interface Response

Returns:

True if the response redirects to another object.

getCookies

public List<Cookie> getCookies()

Specified by:

getCookies in interface Response

Returns:

the list of Cookie.

hasResponseStatus

public boolean hasResponseStatus()

Description copied from interface: Response

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

Specified by:

hasResponseStatus in interface Response

Returns:

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

hasResponseHeaders

public boolean hasResponseHeaders()

Description copied from interface: Response

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(HttpResponseHeaders) returned AsyncHandler.State.ABORT

Specified by:

hasResponseHeaders in interface Response

Returns:

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

hasResponseBody

public boolean hasResponseBody()

Description copied from interface: Response

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

Specified by:

hasResponseBody in interface Response

Returns:

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

toString

public String toString()

Description copied from interface: Response

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

Specified by:

toString in interface Response

Overrides:

toString in class Object

Returns:

the textual representation