Package com.ning.http.client

Interface Response

All Known Implementing Classes:
GrizzlyResponse, ResponseBase, WebDavResponse
public interface Response
Represents the asynchronous HTTP response callback for an AsyncCompletionHandler

  • Method Details

    • 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() throws IOException
      Return the entire response body as a byte[].
      Returns:
      the entire response body as a byte[].
      Throws:
      IOException

    • getResponseBodyAsByteBuffer

      ByteBuffer getResponseBodyAsByteBuffer() throws IOException
      Return the entire response body as a ByteBuffer.
      Returns:
      the entire response body as a ByteBuffer.
      Throws:
      IOException

    • 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()
      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(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 response 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