Response (Asynchronous Http Client 1.6.5 API)

All Known Implementing Classes:

ApacheResponse, JDKResponse, NettyResponse, WebDavResponse
```
public interface Response
```
Represents the asynchronous HTTP response callback for an AsyncCompletionHandler

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Response.ResponseBuilder

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Response.ResponseBuilder`

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`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
  - 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
  - getResponseBodyAsStream
```
InputStream getResponseBodyAsStream()
                                    throws IOException
```
    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
    
    Throws:
    
    IOException
  - getResponseBodyExcerpt
```
String getResponseBodyExcerpt(int maxLength,
                            String charset)
                              throws IOException
```
    Returns the first maxLength bytes of the response body as a string. Note that this does not check whether the content type is actually a textual one, but it will use the charset if present in the content type header.
    
    Parameters:
    maxLength - The maximum number of bytes to read
    charset - the charset to use when decoding the stream
    
    Returns:
    The response body
    
    Throws:
    
    IOException
  - getResponseBody
```
String getResponseBody(String charset)
                       throws IOException
```
    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.
    
    Throws:
    
    IOException
  - getResponseBodyExcerpt
```
String getResponseBodyExcerpt(int maxLength)
                              throws IOException
```
    Returns the first maxLength bytes of the response body as a string. Note that this does not check whether the content type is actually a textual one, but it will use the charset if present in the content type header.
    
    Parameters:
    maxLength - The maximum number of bytes to read
    
    Returns:
    The response body
    
    Throws:
    
    IOException
  - getResponseBody
```
String getResponseBody()
                       throws IOException
```
    Return the entire response body as a String.
    
    Returns:
    the entire response body as a String.
    
    Throws:
    
    IOException
  - getUri
```
URI getUri()
           throws MalformedURLException
```
    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.
    
    Throws:
    
    MalformedURLException
  - getContentType
```
String getContentType()
```
    Return the content-type header value.
    
    Returns:
    the content-type header value.
  - getHeader
```
String getHeader(String name)
```
    Return the response header
    
    Returns:
    the response header
  - getHeaders
```
List<String> getHeaders(String name)
```
    Return a List of the response header value.
    
    Returns:
    the response header
  - getHeaders
```
FluentCaseInsensitiveStringsMap 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 request for logging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    The textual representation
  - getCookies
```
List<Cookie> getCookies()
```
    Return 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(HttpResponseHeaders) 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 the either AsyncHandler.onStatusReceived(HttpResponseStatus) or AsyncHandler.onHeadersReceived(HttpResponseHeaders) returned AsyncHandler.STATE.ABORT
    
    Returns:
    true if the response's body has been computed by an AsyncHandler

Interface Response

Nested Class Summary

Method Summary

Method Detail

getStatusCode

getStatusText

getResponseBodyAsStream

getResponseBodyExcerpt

getResponseBody

getResponseBodyExcerpt

getResponseBody

getUri

getContentType

getHeader

getHeaders

getHeaders

isRedirected

toString

getCookies

hasResponseStatus

hasResponseHeaders

hasResponseBody