com.dkfqs.tools.http

Class HTTPResponseContent

java.lang.Object

com.dkfqs.tools.http.HTTPResponseContent

public class HTTPResponseContent
extends java.lang.Object

A received HTTP response content. This class supports theoretical an unlimited size of received data - but the received data must fit into the Java memory.

Note that the high-level functions of this class support only data with a maximum size of 2^31-1 bytes, and may throw a HTTPContentTooLargeException or a HTTPContentTruncatedException if the received data are too large.

See Also:

HTTPClient.setMaxHTTPResponseSize(long), HTTPClient.setMaxStoredHTTPResponseContentLength(long), HTTPResponseTooLargeException, HTTPContentTooLargeException, HTTPContentTruncatedException

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_READ_CHUNKED The content was read in chunks because the HTTP response header field 'Transfer-Encoding: chunked' was set.
static int	CONTENT_READ_FIXED_LENGTH The content was read by the size set in the HTTP response header field 'Content-Length'.
static int	CONTENT_READ_IGNORED The content was not read because a HTTP 'HEAD' request was sent, or because a HTTP V1.1+ response header contains no information about how to process the received content (normal case for '204 No Content' responses).
static int	CONTENT_READ_UNTIL_END_OF_STREAM The content was read until the end of the stream because a HTTP 1.0 response has received with no hint about how to read the content.

Method Summary

Modifier and Type	Method and Description
byte[]	getContent() High-level function: Get the (decompressed) response content as a single byte array.
java.lang.String	getContentAsString() High-level function: Get the (decompressed) response content as a string.
int	getContentReadMethod() Get the way how the content was read.
long	getContentReceiveTimeMillis() Get the elapsed time duration for receiving the content data.
HTTPRequestHeader	getHttpRequestHeader() Get the corresponding HTTP request header which was sent to the server.
HTTPResponseHeader	getHttpResponseHeader() Get the corresponding HTTP response header which was received from the server.
byte[]	getRawMergedContent() High-level function: Merge the raw received content fragments to one byte array (without any control chars in case if a chunked content was received).
java.util.ArrayList<byte[]>	getRawReceivedContent() Get the raw received content (which my be truncated), without any control chars in case if a chunked content was received.
long	getRawReceivedContentLength() Get the raw received content length (the number of the received response content bytes from the Web server).
long	getStartContentReceiveTimestamp() Get the timestamp of the start of receiving the content data.
boolean	hasContent() Get if any content has received.
boolean	isContentTruncated() Get if the stored content is truncated.
JsonObject	toJsonObject() Get a JSON object of this instance (the decompressed response content in Base64 format, which can be also have a decoded size of zero bytes in case of no content).
void	traceContent() Trace the HTTP response content.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_READ_IGNORED

public static final int CONTENT_READ_IGNORED

The content was not read because a HTTP 'HEAD' request was sent, or because a HTTP V1.1+ response header contains no information about how to process the received content (normal case for '204 No Content' responses).

See Also:

Constant Field Values

CONTENT_READ_FIXED_LENGTH

public static final int CONTENT_READ_FIXED_LENGTH

The content was read by the size set in the HTTP response header field 'Content-Length'.

See Also:

Constant Field Values

CONTENT_READ_CHUNKED

public static final int CONTENT_READ_CHUNKED

The content was read in chunks because the HTTP response header field 'Transfer-Encoding: chunked' was set.

See Also:

Constant Field Values

CONTENT_READ_UNTIL_END_OF_STREAM

public static final int CONTENT_READ_UNTIL_END_OF_STREAM

The content was read until the end of the stream because a HTTP 1.0 response has received with no hint about how to read the content.

See Also:

Constant Field Values

Method Detail

getHttpRequestHeader

public HTTPRequestHeader getHttpRequestHeader()

Get the corresponding HTTP request header which was sent to the server.

Returns:

the corresponding HTTP request header which was sent to the server.

getHttpResponseHeader

public HTTPResponseHeader getHttpResponseHeader()

Get the corresponding HTTP response header which was received from the server.

Returns:

the corresponding HTTP response header which was received from the server

getContentReadMethod

public int getContentReadMethod()

Get the way how the content was read.

Returns:

the way how the content was read

See Also:

CONTENT_READ_IGNORED, CONTENT_READ_FIXED_LENGTH, CONTENT_READ_CHUNKED, CONTENT_READ_UNTIL_END_OF_STREAM

hasContent

public boolean hasContent()

Get if any content has received.

Returns:

true if any content has received

isContentTruncated

public boolean isContentTruncated()

Get if the stored content is truncated.

Returns:

true if the stored content is truncated

See Also:

HTTPClient.setMaxStoredHTTPResponseContentLength(long), HTTPClient.getMaxStoredHTTPResponseContentLength()

getRawReceivedContentLength

public long getRawReceivedContentLength()

Get the raw received content length (the number of the received response content bytes from the Web server). Note that this value includes also the number of control chars in case if a chunked content was received

Returns:

the raw received content length

getRawReceivedContent

public java.util.ArrayList<byte[]> getRawReceivedContent()

Get the raw received content (which my be truncated), without any control chars in case if a chunked content was received. The size of the received content is theoretically unlimited - but must fit into the Java memory.

Returns:

the raw received content = an array list of byte array fragments

See Also:

isContentTruncated(), HTTPClient.setMaxStoredHTTPResponseContentLength(long), HTTPClient.getMaxStoredHTTPResponseContentLength()

getRawMergedContent

public byte[] getRawMergedContent()
                           throws HTTPContentTooLargeException,
                                  HTTPContentTruncatedException

High-level function: Merge the raw received content fragments to one byte array (without any control chars in case if a chunked content was received).

Returns:

the raw received content, merged to one byte array.

Throws:

HTTPContentTooLargeException - if the received content is larger than 2^31-1 bytes

HTTPContentTruncatedException - if the stored HTTP response content was truncated (but was still fully read)

See Also:

HTTPClient.setMaxStoredHTTPResponseContentLength(long), HTTPClient.getMaxStoredHTTPResponseContentLength(), isContentTruncated()

getContent

public byte[] getContent()
                  throws HTTPContentTooLargeException,
                         HTTPContentTruncatedException,
                         java.io.IOException

High-level function: Get the (decompressed) response content as a single byte array. If the content was received in a compressed format then the content is decompressed by this method.

Returns:

the (decompressed) response content as a single byte array.

Throws:

HTTPContentTooLargeException - if the received content is larger than 2^31-1 bytes

HTTPContentTruncatedException - if the stored HTTP response content was truncated (but was still fully read)

java.io.IOException - if the content was compressed and the decompression fails

See Also:

HTTPClient.setMaxStoredHTTPResponseContentLength(long), HTTPClient.getMaxStoredHTTPResponseContentLength(), isContentTruncated()

getContentAsString

public java.lang.String getContentAsString()
                                    throws HTTPContentTooLargeException,
                                           HTTPContentTruncatedException,
                                           java.io.IOException

High-level function: Get the (decompressed) response content as a string. If the content was received in a compressed format then the content is decompressed by this method. This method extracts from the HTTP response header field 'Content-Type' the 'charset' parameter, and constructs the return value of the response content string depending on the received 'charset' from the server. (Example: 'Content-Type: text/html; charset=ISO-8859-1'). In case if no 'charset' parameter can extracted from the HTTP response header field 'Content-Type', then UTF-8 is used as default charset.

Returns:

the (decompressed) response content as a string.

Throws:

HTTPContentTooLargeException - if the received content is larger than 2^31-1 bytes

HTTPContentTruncatedException - if the stored HTTP response content was truncated (but was still fully read)

java.io.IOException - if the content was compressed and the decompression fails

See Also:

HTTPClient.setMaxStoredHTTPResponseContentLength(long), HTTPClient.getMaxStoredHTTPResponseContentLength(), isContentTruncated()

getStartContentReceiveTimestamp

public long getStartContentReceiveTimestamp()

Get the timestamp of the start of receiving the content data.

Returns:

the timestamp of the start of receiving the content data (Unix time), or -1 if no such data is available

getContentReceiveTimeMillis

public long getContentReceiveTimeMillis()

Get the elapsed time duration for receiving the content data. Measured from start to receive the first byte of the content data until the last byte has received.

Returns:

the elapsed time for receiving the content data in milliseconds, or -1 if no such data is available

traceContent

public void traceContent()
                  throws java.io.IOException

Trace the HTTP response content.

Throws:

java.io.IOException - if the content was compressed and the decompression fails

See Also:

HTTPClient.setTraceRequestContentTypesSet(HashSet)

toJsonObject

public JsonObject toJsonObject()
                        throws HTTPContentTooLargeException,
                               HTTPContentTruncatedException,
                               java.io.IOException

Get a JSON object of this instance (the decompressed response content in Base64 format, which can be also have a decoded size of zero bytes in case of no content).

Returns:

a JSON object of this instance

Throws:

HTTPContentTooLargeException - if the received content is larger than 2^31-1 bytes

HTTPContentTruncatedException - if the stored HTTP response content was truncated (but was still fully read)

java.io.IOException - if the content was compressed and the decompression fails