public class WebResponseWrapper extends Object implements WebResponse
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.Constructor and Description |
---|
WebResponseWrapper(WebResponse webResponse)
Constructs a WebResponse object wrapping provided WebResponse.
|
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
NameValuePair s. |
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() |
public WebResponseWrapper(WebResponse webResponse) throws IllegalArgumentException
webResponse
- the webResponse that does the real workIllegalArgumentException
- if the connection is null
public InputStream getContentAsStream() throws IOException
getContentAsStream
in interface WebResponse
IOException
- if an IO problem occurspublic String getContentAsString()
getContentAsString
in interface WebResponse
public String getContentAsString(String encoding)
getContentAsString
in interface WebResponse
encoding
- the charset/encoding to use to convert the response content into a stringpublic byte[] getContentAsBytes()
getContentAsBytes
in interface WebResponse
@Deprecated public String getContentCharSet()
getContentCharset()
getContentCharSet
in interface WebResponse
public String getContentCharsetOrNull()
getContentCharsetOrNull
in interface WebResponse
public String getContentCharset()
TextUtil.DEFAULT_CHARSET
.
The default behavior of this method is to return getContentCharset() on the wrapped connection object.getContentCharset
in interface WebResponse
public String getContentType()
getContentType
in interface WebResponse
public long getLoadTime()
getLoadTime
in interface WebResponse
@Deprecated public HttpMethod getRequestMethod()
getRequestSettings()
.getHttpMethod()getRequestMethod
in interface WebResponse
public List<org.apache.commons.httpclient.NameValuePair> getResponseHeaders()
NameValuePair
s.
The default behavior of this method is to return getResponseHeaders() on the wrapped connection object.getResponseHeaders
in interface WebResponse
NameValuePair
spublic String getResponseHeaderValue(String headerName)
getResponseHeaderValue
in interface WebResponse
headerName
- the name of the header whose value is to be returnedpublic int getStatusCode()
getStatusCode
in interface WebResponse
public String getStatusMessage()
getStatusMessage
in interface WebResponse
@Deprecated public URL getRequestUrl()
getRequestSettings()
.getUrl()getRequestUrl
in interface WebResponse
public URL getUrl()
WebResponse
WebResponse.getRequestUrl()
getUrl
in interface WebResponse
public WebRequestSettings getRequestSettings()
getRequestSettings
in interface WebResponse
Copyright © 2002–2014 Gargoyle Software Inc.. All rights reserved.