public class WebResponseWrapper extends 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 response object.Constructor and Description |
---|
WebResponseWrapper(WebResponse webResponse)
Constructs a WebResponse object wrapping provided WebResponse.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
getContentAsBytes()
Deprecated.
as of 2.8, use either
getContentAsString() or getContentAsStream() . |
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 |
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.
|
WebRequest |
getRequestSettings()
Deprecated.
as of 2.8, please use
getWebRequest() instead |
List<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.
|
WebRequest |
getWebRequest()
Returns the request used to load this response.
|
public WebResponseWrapper(WebResponse webResponse) throws IllegalArgumentException
webResponse
- the webResponse that does the real workIllegalArgumentException
- if the webResponse is null
public InputStream getContentAsStream()
getContentAsStream
in class WebResponse
public String getContentAsString()
getContentAsString
in class WebResponse
public String getContentAsString(String encoding)
getContentAsString
in class WebResponse
encoding
- the charset/encoding to use to convert the response content into a string@Deprecated public byte[] getContentAsBytes()
getContentAsBytes
in class WebResponse
public String getContentCharsetOrNull()
getContentCharsetOrNull
in class WebResponse
public String getContentCharset()
TextUtil.DEFAULT_CHARSET
.
The default behavior of this method is to return getContentCharset() on the wrapped webResponse object.getContentCharset
in class WebResponse
public String getContentType()
getContentType
in class WebResponse
public long getLoadTime()
getLoadTime
in class WebResponse
public List<NameValuePair> getResponseHeaders()
NameValuePair
s.
The default behavior of this method is to return getResponseHeaders() on the wrapped webResponse object.getResponseHeaders
in class WebResponse
NameValuePair
spublic String getResponseHeaderValue(String headerName)
getResponseHeaderValue
in class WebResponse
headerName
- the name of the header whose value is to be returnednull
if no response header exists with this namepublic int getStatusCode()
getStatusCode
in class WebResponse
public String getStatusMessage()
getStatusMessage
in class WebResponse
@Deprecated public WebRequest getRequestSettings()
getWebRequest()
insteadgetRequestSettings
in class WebResponse
public WebRequest getWebRequest()
getWebRequest
in class WebResponse
Copyright © 2002-2013 Gargoyle Software Inc.. All Rights Reserved.