com.gargoylesoftware.htmlunit.util

Class WebResponseWrapper

java.lang.Object

com.gargoylesoftware.htmlunit.util.WebResponseWrapper

All Implemented Interfaces:

WebResponse, Serializable

public class WebResponseWrapper
extends Object
implements 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 connection object.

Version:

$Revision: 4872 $

Author:

Marc Guillemot, Ahmed Ashour

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getContentAsBytes() Returns the response content as a byte array.
InputStream	getContentAsStream() Returns the response content as an input stream.
String	getContentAsString() Returns the response content as a string, using the charset/encoding specified in the server response.
String	getContentAsString(String encoding) Returns the response content as a string, using the specified charset/encoding, rather than the charset/encoding specified in the server response.
String	getContentCharset() Returns the content charset for this response, even if no charset was specified explicitly.
String	getContentCharSet() Deprecated. As of 2.6, please use @link getContentCharset()
String	getContentCharsetOrNull() Returns the content charset specified explicitly in the header or in the content, or null if none was specified.
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.
HttpMethod	getRequestMethod() Deprecated. As of 2.6, please use getRequestSettings().getHttpMethod()
WebRequestSettings	getRequestSettings() Returns the request settings used to load this response.
URL	getRequestUrl() Deprecated. As of 2.6, please use getRequestSettings().getUrl()
List<org.apache.commons.httpclient.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.
URL	getUrl() Synonym for WebResponse.getRequestUrl()

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 connection is null

Method Detail

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 connection object.

Specified by:

getContentAsStream in interface WebResponse

Returns:

the response content as an input stream

Throws:

IOException - if an IO problem occurs

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 connection object.

Specified by:

getContentAsString in interface WebResponse

Returns:

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

getContentAsString

public String getContentAsString(String encoding)

Returns the response content as a string, using the specified charset/encoding, rather than the charset/encoding specified in the server response. If the specified charset/encoding is not supported then the default system encoding is used. The default behavior of this method is to return getContentAsString(String) on the wrapped connection object.

Specified by:

getContentAsString in interface WebResponse

Parameters:

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

Returns:

the response content as a string

getContentAsBytes

public byte[] getContentAsBytes()

Returns the response content as a byte array. The default behavior of this method is to return getContentAsBytes() on the wrapped connection object.

Specified by:

getContentAsBytes in interface WebResponse

Returns:

the response content as a byte array

getContentCharSet

@Deprecated
public String getContentCharSet()

Deprecated. As of 2.6, please use @link getContentCharset()

Returns the content charset; may be null. The default behavior of this method is to return getContentCharSet() on the wrapped connection object.

Specified by:

getContentCharSet in interface WebResponse

Returns:

the content charset

getContentCharsetOrNull

public String 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 connection object.

Specified by:

getContentCharsetOrNull in interface WebResponse

Returns:

the content charset specified explicitly in the header or in the content, or null if none was specified

getContentCharset

public String 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 response content; as a last resort, this method returns TextUtil.DEFAULT_CHARSET. The default behavior of this method is to return getContentCharset() on the wrapped connection object.

Specified by:

getContentCharset in interface WebResponse

Returns:

the content charset for this response

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 connection object.

Specified by:

getContentType in interface 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 connection object.

Specified by:

getLoadTime in interface WebResponse

Returns:

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

getRequestMethod

@Deprecated
public HttpMethod getRequestMethod()

Deprecated. As of 2.6, please use getRequestSettings().getHttpMethod()

Returns the method used for the request resulting in this response. The default behavior of this method is to return getRequestMethod() on the wrapped connection object.

Specified by:

getRequestMethod in interface WebResponse

Returns:

the method used for the request resulting in this response

getResponseHeaders

public List<org.apache.commons.httpclient.NameValuePair> getResponseHeaders()

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

Specified by:

getResponseHeaders in interface 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 connection object.

Specified by:

getResponseHeaderValue in interface WebResponse

Parameters:

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

Returns:

the value of the specified response header

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 connection object.

Specified by:

getStatusCode in interface 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 connection object.

Specified by:

getStatusMessage in interface WebResponse

Returns:

the status message that was returned from the server

getRequestUrl

@Deprecated
public URL getRequestUrl()

Deprecated. As of 2.6, please use getRequestSettings().getUrl()

Returns the URL that was used to load this page. The default behavior of this method is to return getRequestUrl() on the wrapped connection object.

Specified by:

getRequestUrl in interface WebResponse

Returns:

the URL that was used to load this page

getUrl

public URL getUrl()

Description copied from interface: WebResponse

Synonym for WebResponse.getRequestUrl()

Specified by:

getUrl in interface WebResponse

getRequestSettings

public WebRequestSettings getRequestSettings()

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

Specified by:

getRequestSettings in interface WebResponse

Returns:

the request settings used to load this response