Interface Response

All Superinterfaces:
HttpHeaders
All Known Implementing Classes:
HttpResponse, HttpResponse, HttpResponse, HttpResponse, HttpResponse, OkHttpResponse

public interface Response extends HttpHeaders
A response interface. Makes all protocols model HTTP.
  • Field Details

    • REQUEST

      static final String REQUEST
      Key to hold the HTTP request if store.http.request is true
      See Also:
    • RESPONSE_HEADERS

      static final String RESPONSE_HEADERS
      Key to hold the HTTP response header if store.http.headers is true
      See Also:
    • IP_ADDRESS

      static final String IP_ADDRESS
      Key to hold the IP address the request is sent to if store.ip.address is true
      See Also:
    • PROTOCOL_VERSIONS

      static final String PROTOCOL_VERSIONS
      Key to hold the HTTP and SSL/TLS protocol versions if store.protocol.versions is true.
      See Also:
    • CIPHER_SUITES

      static final String CIPHER_SUITES
      Key to hold the SSL/TLS cipher suites store.protocol.versions is true.
      See Also:
    • FETCH_TIME

      static final String FETCH_TIME
      Key to hold the time when the page has been fetched
      See Also:
    • TRUNCATED_CONTENT

      static final String TRUNCATED_CONTENT
      Key to hold boolean whether content has been truncated, e.g., because it exceeds http.content.limit
      See Also:
    • TRUNCATED_CONTENT_REASON

      static final String TRUNCATED_CONTENT_REASON
      Key to hold reason why content has been truncated, see Response.TruncatedContentReason
      See Also:
  • Method Details

    • getUrl

      URL getUrl()
      Get the URL the protocol actually used when requesting the Response.
      Returns:
      URL
    • getCode

      int getCode()
      Get the response code.
      Returns:
      protocol response code (int)
    • getHeader

      String getHeader(String name)
      Get the value of a named header.
      Parameters:
      name - key of the header you wish to retrieve
      Returns:
      header value
    • getHeaders

      Metadata getHeaders()
      Get all the headers.
      Returns:
      populated headers Metadata
    • getContent

      byte[] getContent()
      Get the full content of the response.
      Returns:
      a byte array representing the response content