NettyResponse (Asynchronous Http Client 2.5.3 API)

java.lang.Object
- org.asynchttpclient.netty.NettyResponse

All Implemented Interfaces:: Response

public class NettyResponse
extends java.lang.Object
implements Response

Wrapper around the Response API.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.asynchttpclient.Response
  Response.ResponseBuilder

Constructor Summary

Constructors
Constructor and Description
`NettyResponse(HttpResponseStatus status, io.netty.handler.codec.http.HttpHeaders headers, java.util.List<HttpResponseBodyPart> bodyParts)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getContentType()` Return the content-type header value.
`java.util.List<io.netty.handler.codec.http.cookie.Cookie>`	`getCookies()`
`java.lang.String`	`getHeader(java.lang.CharSequence name)`
`io.netty.handler.codec.http.HttpHeaders`	`getHeaders()`
`java.util.List<java.lang.String>`	`getHeaders(java.lang.CharSequence name)` Return a `List` of the response header value.
`java.net.SocketAddress`	`getLocalAddress()` Get local address client initiated request from.
`java.net.SocketAddress`	`getRemoteAddress()` Get remote address client initiated request to.
`java.lang.String`	`getResponseBody()` Return the entire response body as a String.
`java.lang.String`	`getResponseBody(java.nio.charset.Charset charset)` Return the entire response body as a String.
`java.nio.ByteBuffer`	`getResponseBodyAsByteBuffer()` Return the entire response body as a ByteBuffer.
`byte[]`	`getResponseBodyAsBytes()` Return the entire response body as a byte[].
`java.io.InputStream`	`getResponseBodyAsStream()` Returns an input stream for the response body.
`int`	`getStatusCode()` Returns the status code for the request.
`java.lang.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.
`java.lang.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

- Constructor Detail
  - NettyResponse
```
public NettyResponse(HttpResponseStatus status,
                     io.netty.handler.codec.http.HttpHeaders headers,
                     java.util.List<HttpResponseBodyPart> bodyParts)
```
- Method Detail
  - 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 java.lang.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 java.net.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 java.net.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 java.lang.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 java.lang.String getHeader(java.lang.CharSequence name)
```
    Specified by:
    
    getHeader in interface Response
    
    Parameters:
    
    name - the header name
    
    Returns:
    
    the first response header value
  - getHeaders
```
public final java.util.List<java.lang.String> getHeaders(java.lang.CharSequence 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 java.util.List<io.netty.handler.codec.http.cookie.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(HttpHeaders) 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:
    - either the AsyncHandler.onStatusReceived(HttpResponseStatus) returned AsyncHandler.State.ABORT
    - or AsyncHandler.onHeadersReceived(HttpHeaders) returned AsyncHandler.State.ABORT
    - response body was empty
    Specified by:
    
    hasResponseBody in interface Response
    
    Returns:
    
    true if the response's body has been computed by an AsyncHandler to new empty bytes
  - getResponseBodyAsBytes
```
public byte[] getResponseBodyAsBytes()
```
    Description copied from interface: Response
    
    Return the entire response body as a byte[].
    
    Specified by:
    
    getResponseBodyAsBytes in interface Response
    
    Returns:
    
    the entire response body as a byte[].
  - getResponseBodyAsByteBuffer
```
public java.nio.ByteBuffer getResponseBodyAsByteBuffer()
```
    Description copied from interface: Response
    
    Return the entire response body as a ByteBuffer.
    
    Specified by:
    
    getResponseBodyAsByteBuffer in interface Response
    
    Returns:
    
    the entire response body as a ByteBuffer.
  - getResponseBody
```
public java.lang.String getResponseBody()
```
    Description copied from interface: Response
    
    Return the entire response body as a String.
    
    Specified by:
    
    getResponseBody in interface Response
    
    Returns:
    
    the entire response body as a String.
  - getResponseBody
```
public java.lang.String getResponseBody(java.nio.charset.Charset charset)
```
    Description copied from interface: Response
    
    Return the entire response body as a String.
    
    Specified by:
    
    getResponseBody in interface Response
    
    Parameters:
    
    charset - the charset to use when decoding the stream
    
    Returns:
    
    the entire response body as a String.
  - getResponseBodyAsStream
```
public java.io.InputStream getResponseBodyAsStream()
```
    Description copied from interface: Response
    
    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.
    
    Specified by:
    
    getResponseBodyAsStream in interface Response
    
    Returns:
    
    The input stream
  - toString
```
public java.lang.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 java.lang.Object
    
    Returns:
    
    the textual representation

Class NettyResponse

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NettyResponse

Method Detail

getStatusCode

getStatusText

getUri

getRemoteAddress

getLocalAddress

getContentType

getHeader

getHeaders

getHeaders

isRedirected

getCookies

hasResponseStatus

hasResponseHeaders

hasResponseBody

getResponseBodyAsBytes

getResponseBodyAsByteBuffer

getResponseBody

getResponseBody

getResponseBodyAsStream

toString