Package org.omegazero.http.h1

Class HTTP1RequestReceiver

java.lang.Object

org.omegazero.http.h1.HTTP1MessageReceiver

org.omegazero.http.h1.HTTP1RequestReceiver

public class HTTP1RequestReceiver
extends HTTP1MessageReceiver

A special HTTP1MessageReceiver used for receiving HTTPRequests.

Since:

1.2.1

Field Summary

Fields inherited from class org.omegazero.http.h1.HTTP1MessageReceiver

DEFAULT_MAX_HEADER_SIZE, lHeaders

Constructor Summary

Constructors

Constructor	Description
HTTP1RequestReceiver(boolean secure)	Creates a new HTTP1RequestReceiver with the default maximum message size.
HTTP1RequestReceiver(int maxHeaderSize, boolean secure)	Creates a new HTTP1RequestReceiver.

Method Summary

Modifier and Type	Method	Description
HTTPRequest	get()	Returns the HTTPMessage after successfully receiving it (HTTP1MessageReceiver.receive(byte[], int) returns a non-negative integer).
<T extends HTTPRequest> T	get(HTTPRequestSupplier<T> supplier)	Returns the HTTPRequest after successfully receiving it.
protected void	receiveHeader(String key, String value)	Called when a HTTP header is received.
protected void	receiveStartLine(String[] startLine)	Called when a HTTP/1 start line is received.
void	reset()	Resets this HTTP1MessageReceiver to allow receipt of additional HTTPMessages.

Methods inherited from class org.omegazero.http.h1.HTTP1MessageReceiver

getHeaderSize, getVersion, isStartLineReceived, msgInit, receive, receiveVersion

Methods inherited from class java.lang.Object

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

Constructor Details

HTTP1RequestReceiver

public HTTP1RequestReceiver(boolean secure)

Creates a new HTTP1RequestReceiver with the default maximum message size.

Parameters:

secure - Whether the data is being received over a secure channel. This determines whether the scheme attribute of requests will be set to http or https

HTTP1RequestReceiver

public HTTP1RequestReceiver(int maxHeaderSize,
 boolean secure)

Creates a new HTTP1RequestReceiver.

Parameters:

maxHeaderSize - The maximum size in bytes of a single HTTP message

secure - Whether the data is being received over a secure channel. This determines whether the scheme attribute of requests will be set to http or https

Method Details

receiveStartLine

protected void receiveStartLine(String[] startLine)
                         throws InvalidHTTPMessageException

Description copied from class: HTTP1MessageReceiver

Called when a HTTP/1 start line is received.

Specified by:

receiveStartLine in class HTTP1MessageReceiver

Parameters:

startLine - The start line components

Throws:

InvalidHTTPMessageException - If the start line is malformed

receiveHeader

protected void receiveHeader(String key,
 String value)
                      throws InvalidHTTPMessageException

Description copied from class: HTTP1MessageReceiver

Called when a HTTP header is received.

Overrides:

receiveHeader in class HTTP1MessageReceiver

Parameters:

key - The header name

value - The header value

Throws:

InvalidHTTPMessageException - If the header has an invalid value or otherwise invalid

get

public HTTPRequest get()

Returns the HTTPMessage after successfully receiving it (HTTP1MessageReceiver.receive(byte[], int) returns a non-negative integer).

A call to this method should be followed by a call to HTTP1MessageReceiver.reset() to allow the next HTTP message to be received.

It is unspecified whether multiple calls to this method return the same HTTPMessage instance.

Specified by:

get in class HTTP1MessageReceiver

Returns:

The HTTPMessage

See Also:

• get(HTTPRequestSupplier)

get

public <T extends HTTPRequest> T get(HTTPRequestSupplier<T> supplier)

Returns the HTTPRequest after successfully receiving it. See get().

Type Parameters:

T - The specific HTTPRequest type this method creates

Parameters:

supplier - A HTTPRequestSupplier for creating the HTTPRequest

Returns:

The HTTPRequest

Throws:

IllegalStateException - If no HTTPMessage was received yet

reset

public void reset()

Description copied from class: HTTP1MessageReceiver

Resets this HTTP1MessageReceiver to allow receipt of additional HTTPMessages.

Overrides:

reset in class HTTP1MessageReceiver