Package org.htmlunit

Class WebResponseData

java.lang.Object

org.htmlunit.WebResponseData

All Implemented Interfaces:

java.io.Serializable

public class WebResponseData
extends java.lang.Object
implements java.io.Serializable

Simple data object to simplify WebResponse creation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private DownloadedContent	downloadedContent_
private static org.apache.commons.logging.Log	LOG
private java.util.List<NameValuePair>	responseHeaders_
private int	statusCode_
private java.lang.String	statusMessage_

Constructor Summary

Constructors

Modifier	Constructor	Description
	WebResponseData(byte[] body, int statusCode, java.lang.String statusMessage, java.util.List<NameValuePair> responseHeaders)	Constructs with a raw byte[] (mostly for testing).
protected	WebResponseData(int statusCode, java.lang.String statusMessage, java.util.List<NameValuePair> responseHeaders)	Constructs without data stream for subclasses that override getBody().
	WebResponseData(DownloadedContent downloadedContent, int statusCode, java.lang.String statusMessage, java.util.List<NameValuePair> responseHeaders)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Clean up the downloaded content.
byte[]	getBody()	Returns the response body.
long	getContentLength()	Returns length of the content data.
private static java.lang.String	getHeader(java.util.List<NameValuePair> headers, java.lang.String name)
java.io.InputStream	getInputStream()	Returns a new InputStream allowing to read the downloaded content.
java.io.InputStream	getInputStreamWithBomIfApplicable(org.apache.commons.io.ByteOrderMark... bomHeaders)	INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
java.util.List<NameValuePair>	getResponseHeaders()
int	getStatusCode()
java.lang.String	getStatusMessage()
private java.io.InputStream	getStream(org.apache.commons.io.ByteOrderMark... bomHeaders)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.commons.logging.Log LOG

statusCode_

private final int statusCode_

statusMessage_

private final java.lang.String statusMessage_

responseHeaders_

private final java.util.List<NameValuePair> responseHeaders_

downloadedContent_

private final DownloadedContent downloadedContent_

Constructor Detail

WebResponseData

public WebResponseData(byte[] body,
                       int statusCode,
                       java.lang.String statusMessage,
                       java.util.List<NameValuePair> responseHeaders)

Constructs with a raw byte[] (mostly for testing).

Parameters:

body - Body of this response

statusCode - Status code from the server

statusMessage - Status message from the server

responseHeaders - Headers in this response

WebResponseData

protected WebResponseData(int statusCode,
                          java.lang.String statusMessage,
                          java.util.List<NameValuePair> responseHeaders)

Constructs without data stream for subclasses that override getBody().

Parameters:

statusCode - Status code from the server

statusMessage - Status message from the server

responseHeaders - Headers in this response

WebResponseData

public WebResponseData(DownloadedContent downloadedContent,
                       int statusCode,
                       java.lang.String statusMessage,
                       java.util.List<NameValuePair> responseHeaders)

Constructor.

Parameters:

downloadedContent - the downloaded content

statusCode - Status code from the server

statusMessage - Status message from the server

responseHeaders - Headers in this response

Method Detail

getStream

private java.io.InputStream getStream(org.apache.commons.io.ByteOrderMark... bomHeaders)
                               throws java.io.IOException

Throws:

java.io.IOException

getHeader

private static java.lang.String getHeader(java.util.List<NameValuePair> headers,
                                          java.lang.String name)

getBody

public byte[] getBody()

Returns the response body. This may cause memory problem for very large responses.

Returns:

response body

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns a new InputStream allowing to read the downloaded content.

Returns:

the associated InputStream

Throws:

java.io.IOException - in case of IO problems

getInputStreamWithBomIfApplicable

public java.io.InputStream getInputStreamWithBomIfApplicable(org.apache.commons.io.ByteOrderMark... bomHeaders)
                                                      throws java.io.IOException

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

Parameters:

bomHeaders - the supported bomHeaders

Returns:

the associated InputStream wrapped with a bom input stream if applicable

Throws:

java.io.IOException - in case of IO problems

getResponseHeaders

public java.util.List<NameValuePair> getResponseHeaders()

Returns:

response headers

getStatusCode

public int getStatusCode()

Returns:

response status code

getStatusMessage

public java.lang.String getStatusMessage()

Returns:

response status message

getContentLength

public long getContentLength()

Returns length of the content data.

Returns:

the length

cleanUp

public void cleanUp()

Clean up the downloaded content.