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

Class HTTPRequest

java.lang.Object

org.threadly.litesockets.protocols.http.request.HTTPRequest

public class HTTPRequest
extends java.lang.Object

This is an immutable HTTPRequest object. This is what is sent to the server when doing an HTTPRequest. This object is created via HTTPRequestBuilder.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_TIMEOUT_MS
static int	MAX_TIMEOUT_MS
static int	MIN_TIMEOUT_MS

Method Summary

Modifier and Type	Method	Description
static HTTPRequestBuilder	builder()	Creates a new HTTPRequestBuilder.
boolean	equals(java.lang.Object o)
java.nio.ByteBuffer	getByteBuffer()	Returns a ByteBuffer for this header.
HTTPHeaders	getHTTPHeaders()	Returns the HTTPHeaders object for this request.
HTTPRequestHeader	getHTTPRequestHeader()	Returns the HTTPRequestHeader object for this request.
int	hashCode()
HTTPRequestBuilder	makeBuilder()	Create an HTTPRequestBuilder from this header.
static HTTPRequest	parseRequest(java.lang.String request)	Creates a new HTTPRequest object from a string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_TIMEOUT_MS

public static final int DEFAULT_TIMEOUT_MS

See Also:

Constant Field Values

MIN_TIMEOUT_MS

public static final int MIN_TIMEOUT_MS

See Also:

Constant Field Values

MAX_TIMEOUT_MS

public static final int MAX_TIMEOUT_MS

See Also:

Constant Field Values

Method Detail

getHTTPHeaders

public HTTPHeaders getHTTPHeaders()

Returns the HTTPHeaders object for this request.

Returns:

the HTTPHeaders object for this request.

getHTTPRequestHeader

public HTTPRequestHeader getHTTPRequestHeader()

Returns the HTTPRequestHeader object for this request.

Returns:

the HTTPRequestHeader object for this request.

getByteBuffer

public java.nio.ByteBuffer getByteBuffer()

Returns a ByteBuffer for this header. The buffer is read-only.

Returns:

a ByteBuffer for this 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

makeBuilder

public HTTPRequestBuilder makeBuilder()

Create an HTTPRequestBuilder from this header.

Returns:

an HTTPRequestBuilder based on this HTTPRequest.

builder

public static HTTPRequestBuilder builder()

Creates a new HTTPRequestBuilder.

Returns:

a new HTTPRequestBuilder.

parseRequest

public static HTTPRequest parseRequest(java.lang.String request)
                                throws HTTPParsingException

Creates a new HTTPRequest object from a string.

Parameters:

request - the HTTP Request string to parse.

Returns:

an HTTPRequest from the provided string.

Throws:

HTTPParsingException - is thrown if there are any problems parsing the HTTPRequest.