com.dkfqs.tools.http

Class HTTPResponseHeader

java.lang.Object

com.dkfqs.tools.http.HTTPResponseHeader

public class HTTPResponseHeader
extends java.lang.Object

A received HTTP response header.

Method Summary

Modifier and Type	Method and Description
void	dumpToStdout() Dump the HTTP response header to stdout.
java.lang.String	getAsString() Get the full HTTP response header as a single string.
java.lang.String	getContentMIMEType() Get the received content type (MIME type) without any content type parameter extension.
java.lang.String	getContentTypeCharset() Get the charset of the received content type.
long	getFirstReceivedByteTimeStamp() Get the timestamp when first byte of the HTTP response header has received.
java.lang.String	getFirstResponseLine() Get the first line of the received response header.
java.lang.String	getHeaderField(java.lang.String fieldName) Get the value of a header field.
java.util.ArrayList<HTTPHeaderField>	getHeaderFieldList() Get a list of all received header fields.
java.util.ArrayList<java.lang.String>	getHeaderFields() Get all received header fields.
long	getHeaderReceiveTimeMillis() Get the elapsed time duration for receiving the HTTP response header.
int	getHeaderSize() Get the size of the HTTP response header.
int	getHttpStatusCode() Get the received HTTP status code.
java.lang.String	getRawContentType() Get the raw value of the content type, as received from the server.
java.lang.String	getReceivedHttpStatusText() Get the received HTTP status text.
java.lang.String	getReceivedHttpVersion() Get the received HTTP version.
java.lang.String	getSyntheticHeaderFields() Get all received header fields as a single string.
JsonObject	toJsonObject() Get a JSON object of this instance.

Methods inherited from class java.lang.Object

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

Method Detail

getAsString

public java.lang.String getAsString()

Get the full HTTP response header as a single string.

Returns:

the full HTTP response header as a single string

getFirstResponseLine

public java.lang.String getFirstResponseLine()

Get the first line of the received response header.

Returns:

the first line of the received response header, or null if no such data is available

getReceivedHttpVersion

public java.lang.String getReceivedHttpVersion()

Get the received HTTP version. Example: '1.1'

Returns:

the received HTTP version, or an empty string if no such data is available

getHttpStatusCode

public int getHttpStatusCode()

Get the received HTTP status code.

Returns:

the received HTTP status code, or -1 if no such data is available

getReceivedHttpStatusText

public java.lang.String getReceivedHttpStatusText()

Get the received HTTP status text.

Returns:

the received HTTP status text (in uppercase), or an empty string if no such data is received from the server

getHeaderFieldList

public java.util.ArrayList<HTTPHeaderField> getHeaderFieldList()

Get a list of all received header fields.

Returns:

the list of all received header fields (without the first line of the HTTP response header)

getHeaderFields

public java.util.ArrayList<java.lang.String> getHeaderFields()

Get all received header fields.

Returns:

all received header fields (without the first line of the HTTP response header)

getSyntheticHeaderFields

public java.lang.String getSyntheticHeaderFields()

Get all received header fields as a single string.

Returns:

all received header fields as a single string (without the first line of the HTTP response header)

getHeaderField

public java.lang.String getHeaderField(java.lang.String fieldName)

Get the value of a header field.

Parameters:

fieldName - the field name

Returns:

the field value, or null of no field which such a name has received

getRawContentType

public java.lang.String getRawContentType()

Get the raw value of the content type, as received from the server. Example: 'text/html; charset=ISO-8859-1'.

Returns:

the raw value of the content type, as received from the server, or an empty string if no content type is received

getContentMIMEType

public java.lang.String getContentMIMEType()

Get the received content type (MIME type) without any content type parameter extension. Example: 'text/html'.

Returns:

the received content type (MIME type) in lowercase without any content type extension, or an empty string if no content (MIME type) type is received

getContentTypeCharset

public java.lang.String getContentTypeCharset()

Get the charset of the received content type. Example: 'ISO-8859-1'.

Returns:

the charset of the received content type in uppercase, or an empty string if no charset is received

getFirstReceivedByteTimeStamp

public long getFirstReceivedByteTimeStamp()

Get the timestamp when first byte of the HTTP response header has received.

Returns:

the timestamp when first byte of the HTTP response header has received (Unix time), or -1 if no such data is available

getHeaderReceiveTimeMillis

public long getHeaderReceiveTimeMillis()

Get the elapsed time duration for receiving the HTTP response header. Measured from receiving the first byte of the HTTP response header until the last byte has received.

Returns:

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

getHeaderSize

public int getHeaderSize()

Get the size of the HTTP response header.

Returns:

the size of the HTTP response header (in bytes)

dumpToStdout

public void dumpToStdout()

Dump the HTTP response header to stdout.

toJsonObject

public JsonObject toJsonObject()

Get a JSON object of this instance.

Returns:

a JSON object of this instance