|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Response
Represents the asynchronous HTTP response callback for an AsyncCompletionHandler
Nested Class Summary | |
---|---|
static class |
Response.ResponseBuilder
|
Method Summary | |
---|---|
String |
getContentType()
Return the content-type header value. |
List<Cookie> |
getCookies()
Return the list of Cookie . |
String |
getHeader(String name)
Return the response header |
FluentCaseInsensitiveStringsMap |
getHeaders()
|
List<String> |
getHeaders(String name)
Return a List of the response header value. |
String |
getResponseBody()
Return the entire response body as a String. |
String |
getResponseBody(String charset)
Return the entire response body as a String. |
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. |
String |
getResponseBodyExcerpt(int maxLength)
Returns the first maxLength bytes of the response body as a string. |
String |
getResponseBodyExcerpt(int maxLength,
String charset)
Returns the first maxLength bytes of the response body as a string. |
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 request for logging. |
Method Detail |
---|
int getStatusCode()
String getStatusText()
byte[] getResponseBodyAsBytes() throws IOException
IOException
ByteBuffer getResponseBodyAsByteBuffer() throws IOException
IOException
InputStream getResponseBodyAsStream() throws IOException
IOException
String getResponseBodyExcerpt(int maxLength, String charset) throws IOException
maxLength
- The maximum number of bytes to readcharset
- the charset to use when decoding the stream
IOException
String getResponseBody(String charset) throws IOException
charset
- the charset to use when decoding the stream
IOException
String getResponseBodyExcerpt(int maxLength) throws IOException
maxLength
- The maximum number of bytes to read
IOException
String getResponseBody() throws IOException
IOException
URI getUri() throws MalformedURLException
URI
. Note that if the request got redirected, the value of the URI
will be
the last valid redirect url.
URI
.
MalformedURLException
String getContentType()
String getHeader(String name)
List<String> getHeaders(String name)
List
of the response header value.
FluentCaseInsensitiveStringsMap getHeaders()
boolean isRedirected()
String toString()
toString
in class Object
List<Cookie> getCookies()
Cookie
.
boolean hasResponseStatus()
AsyncHandler
AsyncHandler
boolean hasResponseHeaders()
AsyncHandler
It will return false if the
either AsyncHandler.onStatusReceived(HttpResponseStatus)
or AsyncHandler.onHeadersReceived(HttpResponseHeaders)
returned AsyncHandler.STATE.ABORT
AsyncHandler
boolean hasResponseBody()
AsyncHandler
. It will return false if the
either AsyncHandler.onStatusReceived(HttpResponseStatus)
or AsyncHandler.onHeadersReceived(HttpResponseHeaders)
returned AsyncHandler.STATE.ABORT
AsyncHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |