com.gargoylesoftware.htmlunit.util

Class WebResponseWrapper

java.lang.Object

com.gargoylesoftware.htmlunit.WebResponse

com.gargoylesoftware.htmlunit.util.WebResponseWrapper

All Implemented Interfaces:

Serializable

public class WebResponseWrapper
extends WebResponse

Provides a convenient implementation of the WebResponse interface that can be subclassed by developers wishing to adapt a particular WebResponse. This class implements the Wrapper or Decorator pattern. Methods default to calling through to the wrapped web response object.

Author:

Marc Guillemot, Ahmed Ashour, Ronald Brill, Atsushi Nakagawa

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gargoylesoftware.htmlunit.WebResponse

FORBIDDEN, INTERNAL_SERVER_ERROR, NO_CONTENT, NOT_FOUND, OK

Constructor Summary

Constructors

Constructor and Description
WebResponseWrapper(WebResponse webResponse) Constructs a WebResponse object wrapping provided WebResponse.

Method Summary

Modifier and Type	Method and Description
void	cleanUp() Clean up the response data.
void	defaultCharsetUtf8() Mark this response for using UTF-8 as default charset.
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.
String	getContentAsString(Charset encoding, boolean ignoreUtf8Bom) INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. 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.
Charset	getContentCharsetOrNull() Returns the content charset specified explicitly in the header or in the content, or null if none was specified.
long	getContentLength() Returns length of the content data.
String	getContentType() Returns the content type returned from the server, e.g.
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()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebResponseWrapper

public WebResponseWrapper(WebResponse webResponse)
                   throws IllegalArgumentException

Constructs a WebResponse object wrapping provided WebResponse.

Parameters:

webResponse - the webResponse that does the real work

Throws:

IllegalArgumentException - if the webResponse is null

Method Detail

getContentLength

public long getContentLength()

Returns length of the content data. The default behavior of this method is to return getContentLength() on the wrapped webResponse object.

Overrides:

getContentLength in class WebResponse

Returns:

the length

getContentAsStream

public InputStream getContentAsStream()
                               throws IOException

Returns the response content as an input stream. The default behavior of this method is to return getContentAsStream() on the wrapped webResponse object.

Overrides:

getContentAsStream in class WebResponse

Returns:

the response content as an input stream

Throws:

IOException - in case of IOProblems

getContentAsString

public String getContentAsString()

Returns the response content as a string, using the charset/encoding specified in the server response. The default behavior of this method is to return getContentAsString() on the wrapped webResponse object.

Overrides:

getContentAsString in class WebResponse

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. The default behavior of this method is to return getContentAsString(Charset) on the wrapped webResponse object.

Overrides:

getContentAsString in class WebResponse

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

getContentAsString

public String getContentAsString(Charset encoding,
                                 boolean ignoreUtf8Bom)

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
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. The default behavior of this method is to return getContentAsString(Charset, boolean) on the wrapped webResponse object.

Overrides:

getContentAsString in class WebResponse

Parameters:

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

ignoreUtf8Bom - if true utf8 bom header will be ignored

Returns:

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

getContentCharsetOrNull

public Charset getContentCharsetOrNull()

Returns the content charset specified explicitly in the header or in the content, or null if none was specified. The default behavior of this method is to return getContentCharsetOrNull() on the wrapped webResponse object.

Overrides:

getContentCharsetOrNull in class WebResponse

Returns:

the content charset specified explicitly in the header or in the content, 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; if not found, it checks the request charset; as a last resort, this method returns StandardCharsets.ISO_8859_1. If no charset is defined for an xml response, then UTF-8 is used The default behavior of this method is to return getContentCharset() on the wrapped webResponse object.

Overrides:

getContentCharset in class WebResponse

Returns:

the content charset for this response

See Also:

Character Encoding

getContentType

public String getContentType()

Returns the content type returned from the server, e.g. "text/html". The default behavior of this method is to return getContentType() on the wrapped webResponse object.

Overrides:

getContentType in class WebResponse

Returns:

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

getLoadTime

public long getLoadTime()

Returns the time it took to load this web response, in milliseconds. The default behavior of this method is to return getLoadTime() on the wrapped webResponse object.

Overrides:

getLoadTime in class WebResponse

Returns:

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

getResponseHeaders

public List<NameValuePair> getResponseHeaders()

Returns the response headers as a list of NameValuePairs. The default behavior of this method is to return getResponseHeaders() on the wrapped webResponse object.

Overrides:

getResponseHeaders in class WebResponse

Returns:

the response headers as a list of NameValuePairs

getResponseHeaderValue

public String getResponseHeaderValue(String headerName)

Returns the value of the specified response header. The default behavior of this method is to return getResponseHeaderValue() on the wrapped webResponse object.

Overrides:

getResponseHeaderValue in class WebResponse

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. The default behavior of this method is to return getStatusCode() on the wrapped webResponse object.

Overrides:

getStatusCode in class WebResponse

Returns:

the status code that was returned by the server

getStatusMessage

public String getStatusMessage()

Returns the status message that was returned from the server. The default behavior of this method is to return getStatusMessage() on the wrapped webResponse object.

Overrides:

getStatusMessage in class WebResponse

Returns:

the status message that was returned from the server

getWebRequest

public WebRequest getWebRequest()

Returns the request used to load this response. The default behavior of this method is to return getWebRequest() on the wrapped webResponse object.

Overrides:

getWebRequest in class WebResponse

Returns:

the request used to load this response

cleanUp

public void cleanUp()

Clean up the response data. The default behavior of this method is to call cleanUp() on the wrapped webResponse object.

Overrides:

cleanUp in class WebResponse

defaultCharsetUtf8

public void defaultCharsetUtf8()

Mark this response for using UTF-8 as default charset. The default behavior of this method is to call defaultCharsetUtf8() on the wrapped webResponse object.

Overrides:

defaultCharsetUtf8 in class WebResponse

getContentAsStreamWithBomIfApplicable

public InputStream getContentAsStreamWithBomIfApplicable()
                                                  throws IOException

Description copied from class: WebResponse

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

Overrides:

getContentAsStreamWithBomIfApplicable in class WebResponse

Returns:

the associated InputStream wrapped with a bom input stream if applicable

Throws:

IOException - in case of IO problems

isSuccess

public boolean isSuccess()

Overrides:

isSuccess in class WebResponse

Returns:

true if the 2xx

isSuccessOrUseProxy

public boolean isSuccessOrUseProxy()

Overrides:

isSuccessOrUseProxy in class WebResponse

Returns:

true if the 2xx or 305

isSuccessOrUseProxyOrNotModified

public boolean isSuccessOrUseProxyOrNotModified()

Overrides:

isSuccessOrUseProxyOrNotModified in class WebResponse

Returns:

true if the 2xx or 305