All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StringWebResponse, WebResponseWrapper

public class WebResponse
extends Object
implements Serializable 

Author:

Mike Bowler, Brad Clarke, Noboru Sinohara, Marc Guillemot, Ahmed Ashour, Ronald Brill, Lai Quang Duong

See Also:

Serialized Form

• Constructor Summary

  Constructors

  Constructor and Description
  WebResponse (WebResponseData responseData, URL url, HttpMethod requestMethod, long loadTime) Constructs with all data.
  WebResponse (WebResponseData responseData, WebRequest request, long loadTime) Constructs with all data.

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  void	cleanUp () Clean up the response data.
  String	getBlockReason ()
  InputStream	getContentAsStream () Returns the response content as an input stream.
  InputStream	getContentAsStreamWithBomIfApplicable () INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
  String	getContentAsString () Returns the response content as a string, using the charset/encoding specified in the server response.
  String	getContentAsString (Charset encoding) Returns the response content as a string, using the specified charset, rather than the charset/encoding specified in the server response.
  Charset	getContentCharset () Returns the content charset for this response, even if no charset was specified explicitly.
  long	getContentLength () Returns length of the content data.
  String	getContentType () Returns the content type returned from the server, e.g.
  Charset	getHeaderContentCharset () Returns the content charset specified explicitly in the Content-Type header or null if none was specified.
  long	getLoadTime () Returns the time it took to load this web response, in milliseconds.
  List<NameValuePair>	getResponseHeaders () Returns the response headers as a list of NameValuePairs.
  String	getResponseHeaderValue (String headerName) Returns the value of the specified response header.
  int	getStatusCode () Returns the status code that was returned by the server.
  String	getStatusMessage () Returns the status message that was returned from the server.
  WebRequest	getWebRequest () Returns the request used to load this response.
  boolean	isSuccess ()
  boolean	isSuccessOrUseProxy ()
  boolean	isSuccessOrUseProxyOrNotModified ()
  void	markAsBlocked (String blockReason) Sets the wasBlocked state to true.
  boolean	wasBlocked ()
  boolean	wasContentCharsetTentative () Returns whether the charset of the previous call to getContentCharset() was "tentative".

  • Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Detail

  • WebResponse

    public WebResponse(WebResponseData responseData,
     URL url,
     HttpMethod requestMethod,
     long loadTime)

    Constructs with all data.

    Parameters:

    responseData - Data that was send back

    url - Where this response came from

    requestMethod - the method used to get this response

    loadTime - How long the response took to be sent

  • WebResponse

    public WebResponse(WebResponseData responseData,
     WebRequest request,
     long loadTime)

    Constructs with all data.

    Parameters:

    responseData - Data that was send back

    request - the request used to get this response

    loadTime - How long the response took to be sent

• Method Detail

  • getWebRequest

    public WebRequest getWebRequest()

    Returns the request used to load this response.

    Returns:

    the request used to load this response

  • getResponseHeaders

    public List<NameValuePair> getResponseHeaders()

    Returns the response headers as a list of NameValuePairs.

    Returns:

    the response headers as a list of NameValuePairs

  • getResponseHeaderValue

    public String getResponseHeaderValue(String headerName)

    Returns the value of the specified response header.

    Parameters:

    headerName - the name of the header whose value is to be returned

    Returns:

    the header value, null if no response header exists with this name

  • getStatusCode

    public int getStatusCode()

    Returns the status code that was returned by the server.

    Returns:

    the status code that was returned by the server

  • getStatusMessage

    public String getStatusMessage()

    Returns the status message that was returned from the server.

    Returns:

    the status message that was returned from the server

  • getContentType

    public String getContentType()

    Returns the content type returned from the server, e.g. "text/html".

    Returns:

    the content type returned from the server, e.g. "text/html"

  • getHeaderContentCharset

    public Charset getHeaderContentCharset()

    Returns the content charset specified explicitly in the Content-Type header or null if none was specified.

    Returns:

    the content charset specified header or null if none was specified

  • getContentCharset

    public Charset getContentCharset()

    Returns the content charset for this response, even if no charset was specified explicitly.

    This method always returns a valid charset. This method first checks the Content-Type header or in the content BOM for viable charset. If not found, it attempts to determine the charset based on the type of the content. As a last resort, this method returns the value of WebRequest.getDefaultResponseContentCharset() which is StandardCharsets.UTF_8 by default.

    Returns:

    the content charset for this response

  • wasContentCharsetTentative

    public boolean wasContentCharsetTentative()

    Returns whether the charset of the previous call to getContentCharset() was "tentative".

    A charset is classed as "tentative" if its detection is prone to false positive/negatives.

    For example, HTML meta-tag sniffing can be fooled by text that looks-like-a-meta-tag inside JavaScript code (false positive) or if the meta-tag is after the first 1024 bytes (false negative).

    Returns:

    true if the charset of the previous call to getContentCharset() was "tentative".

    See Also:

    https://html.spec.whatwg.org/multipage/parsing.html#concept-encoding-confidence

  • getContentAsString

    public String getContentAsString()

    Returns the response content as a string, using the charset/encoding specified in the server response.

    Returns:

    the response content as a string, using the charset/encoding specified in the server response or null if the content retrieval was failing

  • getContentAsString

    public String getContentAsString(Charset encoding)

    Returns the response content as a string, using the specified charset, rather than the charset/encoding specified in the server response. If there is a bom header the charset parameter will be overwritten by the bom.

    Parameters:

    encoding - the charset/encoding to use to convert the response content into a string

    Returns:

    the response content as a string or null if the content retrieval was failing

  • getContentLength

    public long getContentLength()

    Returns length of the content data.

    Returns:

    the length

  • getContentAsStream

    public InputStream getContentAsStream()
     throws IOException 

    Returns the response content as an input stream.

    Returns:

    the response content as an input stream

    Throws:

    IOException - in case of IOProblems

  • getContentAsStreamWithBomIfApplicable

    public InputStream getContentAsStreamWithBomIfApplicable()
     throws IOException 

    INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
    

    Returns:

    the associated InputStream wrapped with a bom input stream if applicable

    Throws:

    IOException - in case of IO problems

  • getLoadTime

    public long getLoadTime()

    Returns the time it took to load this web response, in milliseconds.

    Returns:

    the time it took to load this web response, in milliseconds

  • cleanUp

    public void cleanUp()

    Clean up the response data.

  • isSuccess

    public boolean isSuccess()

    Returns:

    true if the 2xx

  • isSuccessOrUseProxy

    public boolean isSuccessOrUseProxy()

    Returns:

    true if the 2xx or 305

  • isSuccessOrUseProxyOrNotModified

    public boolean isSuccessOrUseProxyOrNotModified()

    Returns:

    true if the 2xx or 305

  • wasBlocked

    public boolean wasBlocked()

    Returns:

    true if the request was blocked

  • getBlockReason

    public String getBlockReason()

    Returns:

    the reason for blocking or null

  • markAsBlocked

    public void markAsBlocked(String blockReason)

    Sets the wasBlocked state to true.

    Parameters:

    blockReason - the reason