Package org.threadly.litesockets.protocols.http.request

Class HTTPRequestHeader

java.lang.Object

org.threadly.litesockets.protocols.http.request.HTTPRequestHeader

public class HTTPRequestHeader
extends java.lang.Object

This is an immutable HTTP Request Header. Basically the first line of the http request. This is the first line of an http request formated with spaces "RequestMethod path?query version".

Constructor Summary

Constructors

Constructor	Description
HTTPRequestHeader(java.lang.String requestHeader)	This parses an http request string and creates an Immutable HTTPRequest object for it.
HTTPRequestHeader(java.lang.String requestMethod, java.lang.String requestPath, java.util.Map<java.lang.String,java.util.List<java.lang.String>> requestQuery, java.lang.String httpVersion)	Creates a new Immutable HTTPRequest object from the parts that are in a request.
HTTPRequestHeader(HTTPRequestMethod requestMethod, java.lang.String requestPath, java.util.Map<java.lang.String,java.util.List<java.lang.String>> requestQuery, java.lang.String httpVersion)	Creates a new Immutable HTTPRequest object from the parts that are in a request.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.nio.ByteBuffer	getByteBuffer()	Returns the header as a read-only ByteBuffer.
java.lang.String	getHttpVersion()	Gets the http version.
java.lang.String	getRequestMethod()	Gets the http request method (ie POST, GET, HEAD, etc).
java.lang.String	getRequestPath()	Gets the requestPath set in this request.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getRequestQuery()	Gets the request query.
java.lang.String	getRequestQueryValue(java.lang.String paramKey)	Gets the value to a given query parameter.
int	hashCode()
int	length()	The length in bytes of the http request header.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HTTPRequestHeader

public HTTPRequestHeader(java.lang.String requestHeader)

This parses an http request string and creates an Immutable HTTPRequest object for it.

Parameters:

requestHeader - the string to parse into a HTTPRequest .

Throws:

java.lang.IllegalArgumentException - If the header fails to parse.

HTTPRequestHeader

public HTTPRequestHeader(HTTPRequestMethod requestMethod,
                         java.lang.String requestPath,
                         java.util.Map<java.lang.String,java.util.List<java.lang.String>> requestQuery,
                         java.lang.String httpVersion)

Creates a new Immutable HTTPRequest object from the parts that are in a request.

Parameters:

requestMethod - the HTTPRequestMethod to set.

requestPath - the HTTPRequestMethod to set.

requestQuery - the query to set.

httpVersion - the httpVersion to set.

HTTPRequestHeader

public HTTPRequestHeader(java.lang.String requestMethod,
                         java.lang.String requestPath,
                         java.util.Map<java.lang.String,java.util.List<java.lang.String>> requestQuery,
                         java.lang.String httpVersion)

Creates a new Immutable HTTPRequest object from the parts that are in a request. This can take non-standard request methods.

Parameters:

requestMethod - the HTTPRequestMethod to set.

requestPath - the HTTPRequestMethod to set.

requestQuery - the query to set.

httpVersion - the httpVersion to set.

Method Detail

getRequestMethod

public java.lang.String getRequestMethod()

Gets the http request method (ie POST, GET, HEAD, etc).

Returns:

the request method.

getRequestPath

public java.lang.String getRequestPath()

Gets the requestPath set in this request. This does not include the query portion.

Returns:

the request path.

getRequestQuery

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getRequestQuery()

Gets the request query.

Returns:

the request query.

getRequestQueryValue

public java.lang.String getRequestQueryValue(java.lang.String paramKey)

Gets the value to a given query parameter. This will throw an exception if there is multiple values associated to the key.

Returns:

the request parameter value or null if none is associated

getHttpVersion

public java.lang.String getHttpVersion()

Gets the http version.

Returns:

the http version.

getByteBuffer

public java.nio.ByteBuffer getByteBuffer()

Returns the header as a read-only ByteBuffer. The newline/carriage return is not included!

Returns:

a ByteBuffer of the request header.

length

public int length()

The length in bytes of the http request header.

Returns:

length in bytes of the http request header.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object