Package org.omegazero.http.common

Class HTTPRequest

java.lang.Object

org.omegazero.common.util.SimpleAttachmentContainer

org.omegazero.http.common.HTTPHeaderContainer

org.omegazero.http.common.HTTPMessage

org.omegazero.http.common.HTTPRequest

All Implemented Interfaces:

Serializable, org.omegazero.common.util.AttachmentContainer

public class HTTPRequest
extends HTTPMessage

Represents a HTTP request, a specific type of HTTPMessage.

Since:

1.2.1

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	authority	The HTTP request authority.
protected HTTPResponder	httpResponder	The HTTPResponder to use in the respond methods.
protected String	method	The HTTP request method.
protected String	path	The HTTP request path.
protected String	scheme	The HTTP request scheme.

Fields inherited from class org.omegazero.http.common.HTTPMessage

chunkedTransfer, createdTime, httpVersion, locked, other

Fields inherited from class org.omegazero.http.common.HTTPHeaderContainer

headerFields

Fields inherited from class org.omegazero.common.util.SimpleAttachmentContainer

attachments

Constructor Summary

Constructors

Constructor	Description
HTTPRequest(String method, String scheme, String authority, String path, String version, HTTPHeaderContainer headers)	Creates a new HTTPRequest.
HTTPRequest(HTTPRequest request)	Copies the given HTTPRequest.

Method Summary

Modifier and Type	Method	Description
String	getAuthority()	Returns the HTTP request authority (URI component) of this HTTPRequest, or null if this HTTPMessage does not contain an authority component.
HTTPResponder	getHttpResponder()	Returns the HTTPResponder set using setHttpResponder(HTTPResponder) used in respond(HTTPResponseData) and similar methods.
String	getMethod()	Returns the HTTP request method of this HTTPRequest.
HTTPResponse	getOther()	Returns the other HTTPMessage of the HTTP message exchange this HTTPMessage is part of.
String	getPath()	Returns the HTTP request path (URI component) of this HTTPRequest.
String	getScheme()	Returns the HTTP request scheme (URI component) of this HTTPRequest.
boolean	hasResponse()	Returns true if this HTTPRequest has a response.
String	requestLine()	Generates a HTTP/1-style request line of the form [method] [requestURI] HTTP/[version number].
String	requestURI()	Generates the request URI of this HTTPRequest.
void	respond(int status, byte[] data, String... headers)	Responds to this HTTPRequest using an HTTPResponder set for this object.
void	respond(HTTPResponseData response)	Responds to this HTTPRequest using an HTTPResponder set for this object.
void	setAuthority(String authority)	Sets the HTTP authority (URI component) of this HTTPRequest.
void	setHttpResponder(HTTPResponder httpResponder)	Sets a HTTPResponder used in respond(HTTPResponseData) and similar methods.
void	setMethod(String method)	Sets the HTTP request method of this HTTPRequest.
void	setPath(String path)	Sets the HTTP path (URI component) of this HTTPRequest.
void	setScheme(String scheme)	Sets the HTTP scheme (URI component) of this HTTPRequest.

Methods inherited from class org.omegazero.http.common.HTTPMessage

checkLocked, getCreatedTime, getHttpVersion, isChunkedTransfer, isLocked, lock, setChunkedTransfer, setHttpVersion, setOther

Methods inherited from class org.omegazero.http.common.HTTPHeaderContainer

addHeader, addHeader, appendHeader, appendHeader, appendHeader, deleteHeader, deleteHeader, editHeader, extractHeader, extractHeaders, fromLegacy, getHeader, getHeader, getHeader, getHeader, getHeaderCount, headerExists, headerIterator, headerNameCount, headerNameSet, headers, headerSet, setHeader, toString

Methods inherited from class org.omegazero.common.util.SimpleAttachmentContainer

getAttachment, hasAttachment, removeAttachment, setAttachment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omegazero.common.util.AttachmentContainer

requireAttachment

Field Details

method

protected String method

The HTTP request method.

scheme

protected String scheme

The HTTP request scheme.

authority

protected String authority

The HTTP request authority.

path

protected String path

The HTTP request path.

httpResponder

protected transient HTTPResponder httpResponder

The HTTPResponder to use in the respond methods.

Constructor Details

HTTPRequest

public HTTPRequest(String method,
 String scheme,
 String authority,
 String path,
 String version,
 HTTPHeaderContainer headers)

Creates a new HTTPRequest.

Note that no deep copy of the headers will be created, meaning changes made to the given HTTPHeaderContainer will reflect on this HTTPRequest.

Parameters:

method - The request method

scheme - The request URL scheme (e.g. "http")

authority - The request URL authority or, if not provided, the value of the "Host" header (e.g. "example.com"). May be null if neither is provided

path - The request URL path component

version - The HTTP version

headers - The HTTP headers, or null to create an empty set of headers

HTTPRequest

public HTTPRequest(HTTPRequest request)

Copies the given HTTPRequest.

Parameters:

request - The HTTPRequest to copy from

See Also:

• HTTPMessage(HTTPMessage)

Method Details

requestURI

public String requestURI()

Generates the request URI of this HTTPRequest. This always contains the URL scheme and authority component, and the path component if the path is not equal to "*".

Returns:

The request URI of this HTTPRequest

requestLine

public String requestLine()

Generates a HTTP/1-style request line of the form [method] [requestURI] HTTP/[version number].

Returns:

A request line

getMethod

public String getMethod()

Returns the HTTP request method of this HTTPRequest.

Returns:

The HTTP request method

See Also:

• setMethod(String)

getScheme

public String getScheme()

Returns the HTTP request scheme (URI component) of this HTTPRequest.

Returns:

The HTTP request scheme

See Also:

• setScheme(String)

getAuthority

public String getAuthority()

Returns the HTTP request authority (URI component) of this HTTPRequest, or null if this HTTPMessage does not contain an authority component.

Returns:

The HTTP request authority

See Also:

• setAuthority(String)

getPath

public String getPath()

Returns the HTTP request path (URI component) of this HTTPRequest.

Returns:

The HTTP request path

See Also:

• setPath(String)

setMethod

public void setMethod(String method)

Sets the HTTP request method of this HTTPRequest.

Parameters:

method - The new HTTP request method

Throws:

IllegalStateException - If this HTTPMessage is locked

See Also:

• getMethod()

setScheme

public void setScheme(String scheme)

Sets the HTTP scheme (URI component) of this HTTPRequest.

Parameters:

scheme - The new HTTP request scheme

Throws:

IllegalStateException - If this HTTPMessage is locked

See Also:

• getScheme()

setAuthority

public void setAuthority(String authority)

Sets the HTTP authority (URI component) of this HTTPRequest.

Parameters:

authority - The new HTTP request authority

Throws:

IllegalStateException - If this HTTPMessage is locked

See Also:

• getAuthority()

setPath

public void setPath(String path)

Sets the HTTP path (URI component) of this HTTPRequest.

Parameters:

path - The new HTTP request path

Throws:

IllegalStateException - If this HTTPMessage is locked

See Also:

• getPath()

getHttpResponder

public HTTPResponder getHttpResponder()

Returns the HTTPResponder set using setHttpResponder(HTTPResponder) used in respond(HTTPResponseData) and similar methods.

Returns:

The HTTPResponder

setHttpResponder

public void setHttpResponder(HTTPResponder httpResponder)

Sets a HTTPResponder used in respond(HTTPResponseData) and similar methods.

Parameters:

httpResponder - The HTTPResponder

Throws:

IllegalStateException - If this HTTPMessage is locked

hasResponse

public boolean hasResponse()

Returns true if this HTTPRequest has a response.

Returns:

true if this HTTPRequest has a response

getOther

public HTTPResponse getOther()

Description copied from class: HTTPMessage

Returns the other HTTPMessage of the HTTP message exchange this HTTPMessage is part of. This may be null.

For example, for HTTPRequests, this would be the response of the request, and vice versa.

Overrides:

getOther in class HTTPMessage

Returns:

The other HTTPMessage involved in the HTTP message exchange

respond

public void respond(HTTPResponseData response)

Responds to this HTTPRequest using an HTTPResponder set for this object.

Parameters:

response - The response

Throws:

IllegalStateException - If no HTTPResponder is set

See Also:

• setHttpResponder(HTTPResponder)
• HTTPResponder.respond(HTTPRequest, HTTPResponseData)

respond

public void respond(int status,
 byte[] data,
 String... headers)

Responds to this HTTPRequest using an HTTPResponder set for this object.

Parameters:

status - The status code of the response

data - The data to send in the response

headers - Headers to send in the response

Throws:

IllegalStateException - If no HTTPResponder is set

See Also:

• setHttpResponder(HTTPResponder)
• HTTPResponder.respond(HTTPRequest, int, byte[], String...)