com.dkfqs.tools.http

Class HTTPRequestHeader

java.lang.Object

com.dkfqs.tools.http.HTTPRequestHeader

public class HTTPRequestHeader
extends java.lang.Object

A HTTP request header.

Method Summary

Modifier and Type	Method and Description
boolean	addOrReplaceHeaderField(java.lang.String fieldName, java.lang.String fieldValue) Add or replace a HTTP header field.
void	dumpToStdout() Dump the HTTP request header to stdout.
java.lang.String	getAsString() Get the full HTTP request header as a single string.
HTTPContentType	getContentType() Get all parts of the HTTP header field "Content-Type".
java.lang.String	getFirstRequestLine() Get the first line of the HTTP request header.
java.lang.String	getHeaderField(java.lang.String fieldName) Get the value of a HTTP header field.
java.util.ArrayList<HTTPHeaderField>	getHeaderFieldList() Get a list of all HTTP header fields.
java.util.ArrayList<java.lang.String>	getHeaderFields() Get all HTTP header fields.
long	getHeaderSendTimeMillis() Get the elapsed time duration for sending the HTTP request header.
int	getHeaderSize() Get the size of the HTTP request header.
java.lang.String	getHttpRequestMethod() Get the HTTP request method.
long	getStartHeaderSendTimestamp() Get the timestamp of the start of sending the HTTP request header.
java.lang.String	getSyntheticHeaderFields() Get all HTTP request header fields as a single string (without the first line of the HTTP request header).
boolean	hasHeaderField(java.lang.String fieldName) Get if a HTTP header field exists.
boolean	removeHeaderField(java.lang.String fieldName) Remove a HTTP header field.
void	replaceParseUrl(ParseURL replaceParseURL) For HTTP Client debugger only! Completely replace the parsed URL by a new one.
void	setHeaderFieldList(java.util.ArrayList<HTTPHeaderField> headerFieldList) Set (replace) the list of all HTTP header fields.
void	setHeaderFields(java.util.ArrayList<java.lang.String> headerFields) Set (replace) all HTTP header fields.
void	setSyntheticHeaderFields(java.lang.String syntheticHeaderFields) Set (replace) all HTTP request header fields (without the first line of the HTTP request header).
JsonObject	toJsonObject() Get a JSON object of this instance (first header line, array of header fields and content type).
boolean	updateOriginHeaderField(java.lang.String oldUrl, java.lang.String newUrl) Update the 'Origin' header field in case if the protocol, or host, or port of the URL has changed.

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 request header as a single string.

Returns:

the full HTTP request header as a single string

getSyntheticHeaderFields

public java.lang.String getSyntheticHeaderFields()

Get all HTTP request header fields as a single string (without the first line of the HTTP request header).

Returns:

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

See Also:

setSyntheticHeaderFields(String)

setSyntheticHeaderFields

public void setSyntheticHeaderFields(java.lang.String syntheticHeaderFields)

Set (replace) all HTTP request header fields (without the first line of the HTTP request header).

Parameters:

syntheticHeaderFields - all HTTP request header fields as a single string (without the first line of the HTTP request header)

See Also:

getSyntheticHeaderFields()

addOrReplaceHeaderField

public boolean addOrReplaceHeaderField(java.lang.String fieldName,
                                       java.lang.String fieldValue)

Add or replace a HTTP header field.

Parameters:

fieldName - the header field name

fieldValue - the header field value

Returns:

true if a new header field was added

updateOriginHeaderField

public boolean updateOriginHeaderField(java.lang.String oldUrl,
                                       java.lang.String newUrl)
                                throws java.net.MalformedURLException

Update the 'Origin' header field in case if the protocol, or host, or port of the URL has changed. Note: if no 'Origin' header field was set, then calling this method has no effect.

Parameters:

oldUrl - the old URL

newUrl - the new URL

Returns:

true if the (already existing) 'Origin' header field was updated with a new value

Throws:

java.net.MalformedURLException - if the old URL or the new URL is invalid

hasHeaderField

public boolean hasHeaderField(java.lang.String fieldName)

Get if a HTTP header field exists.

Parameters:

fieldName - the header field name

Returns:

true if the HTTP header field exists

removeHeaderField

public boolean removeHeaderField(java.lang.String fieldName)

Remove a HTTP header field.

Parameters:

fieldName - the header field name

Returns:

true if the HTTP header field was found and removed

getHeaderField

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

Get the value of a HTTP header field.

Parameters:

fieldName - the header field name

Returns:

the value of a HTTP header field, or null if no such header field exists

getHeaderSize

public int getHeaderSize()

Get the size of the HTTP request header.

Returns:

the size of the HTTP request header (in bytes)

getHttpRequestMethod

public java.lang.String getHttpRequestMethod()

Get the HTTP request method.

Returns:

the HTTP request method (always in uppercase)

getFirstRequestLine

public java.lang.String getFirstRequestLine()

Get the first line of the HTTP request header.

Returns:

the first line of the HTTP request header

replaceParseUrl

public void replaceParseUrl(ParseURL replaceParseURL)

For HTTP Client debugger only! Completely replace the parsed URL by a new one. Warning: Dont' use this method for normal cases.

Parameters:

replaceParseURL - the new parsed URL

getHeaderFieldList

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

Get a list of all HTTP header fields.

Returns:

the list of all HTTP header fields

setHeaderFieldList

public void setHeaderFieldList(java.util.ArrayList<HTTPHeaderField> headerFieldList)

Set (replace) the list of all HTTP header fields.

Parameters:

headerFieldList - the list of all HTTP header fields

getHeaderFields

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

Get all HTTP header fields.

Returns:

all HTTP header fields

setHeaderFields

public void setHeaderFields(java.util.ArrayList<java.lang.String> headerFields)

Set (replace) all HTTP header fields.

Parameters:

headerFields - An array list of all HTTP header fields

Throws:

java.lang.IllegalArgumentException - if one or multiple HTTP header fields have an invalid format

getContentType

public HTTPContentType getContentType()

Get all parts of the HTTP header field "Content-Type".

Returns:

all parts of the HTTP header field "Content-Type"

getStartHeaderSendTimestamp

public long getStartHeaderSendTimestamp()

Get the timestamp of the start of sending the HTTP request header.

Returns:

the timestamp of the start of sending the HTTP request header (Unix time), or -1 if no such data is available

getHeaderSendTimeMillis

public long getHeaderSendTimeMillis()

Get the elapsed time duration for sending the HTTP request header. Measured from start to send the first byte of the HTTP request header until the last byte has sent.

Returns:

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

dumpToStdout

public void dumpToStdout()
                  throws java.io.IOException

Dump the HTTP request header to stdout.

Throws:

java.io.IOException - if somewhat fails

toJsonObject

public JsonObject toJsonObject()

Get a JSON object of this instance (first header line, array of header fields and content type).

Returns:

a JSON object of this instance