Package org.omegazero.http.util

Class AbstractHTTPServerStream

java.lang.Object

org.omegazero.http.util.AbstractHTTPMessageStream

org.omegazero.http.util.AbstractHTTPServerStream

All Implemented Interfaces:

Closeable, AutoCloseable, HTTPMessageStream, HTTPServerStream

public abstract class AbstractHTTPServerStream
extends AbstractHTTPMessageStream
implements HTTPServerStream

A HTTPServerStream with several basic methods implemented.

Since:

1.4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<HTTPRequestData>	onRequestData
protected Consumer<HTTPMessageTrailers>	onRequestEnded
protected final HTTPServer	server

Fields inherited from class org.omegazero.http.util.AbstractHTTPMessageStream

closed, onError, onWritable, request

Constructor Summary

Constructors

Constructor	Description
AbstractHTTPServerStream(HTTPRequest request, HTTPServer server)	Creates a new AbstractHTTPServerStream.

Method Summary

Modifier and Type	Method	Description
void	callOnRequestData(HTTPRequestData data)	Calls the onRequestData callback.
void	callOnRequestEnded(HTTPMessageTrailers trailers)	Calls the onRequestEnded callback.
HTTPServer	getServer()	Returns the HTTPServer that created this HTTPServerStream.
void	onRequestData(Consumer<HTTPRequestData> onRequestData)	Sets a callback that is called when this HTTPServerStream receives data for the request.
void	onRequestEnded(Consumer<HTTPMessageTrailers> onRequestEnded)	Sets a callback that is called when this HTTPServerStream has finished receiving the request and data, including optional trailers.
void	respond(int status, byte[] data, String... headers)	Responds to this HTTPServerStream with a new HTTP response with the given status, data and headers, if no response was already sent.
void	respond(HTTPResponseData response)	Responds to this HTTPServerStream with the given full response, if no response was already sent.

Methods inherited from class org.omegazero.http.util.AbstractHTTPMessageStream

callOnError, callOnWritable, getRequest, internalError, isClosed, onError, onWritable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegazero.http.util.HTTPMessageStream

close, close, getRequest, isClosed, onError, onWritable, setReceiveData

Methods inherited from interface org.omegazero.http.util.HTTPServerStream

endResponse, sendResponseData, startResponse, startServerPush

Field Details

server

protected final HTTPServer server

onRequestData

protected Consumer<HTTPRequestData> onRequestData

onRequestEnded

protected Consumer<HTTPMessageTrailers> onRequestEnded

Constructor Details

AbstractHTTPServerStream

public AbstractHTTPServerStream(HTTPRequest request,
 HTTPServer server)

Creates a new AbstractHTTPServerStream.

Parameters:

request - The request

server - The server

Method Details

callOnRequestData

public void callOnRequestData(HTTPRequestData data)

Calls the onRequestData callback.

Parameters:

data - The object to pass to the callback

callOnRequestEnded

public void callOnRequestEnded(HTTPMessageTrailers trailers)

Calls the onRequestEnded callback.

Parameters:

trailers - Optional trailers to pass to the callback

getServer

public HTTPServer getServer()

Description copied from interface: HTTPServerStream

Returns the HTTPServer that created this HTTPServerStream.

Specified by:

getServer in interface HTTPServerStream

Returns:

The HTTPServer

onRequestData

public void onRequestData(Consumer<HTTPRequestData> onRequestData)

Description copied from interface: HTTPServerStream

Sets a callback that is called when this HTTPServerStream receives data for the request.

If HTTPMessageData.isLastPacket() is true for a HTTPRequestData object passed to the callback, it is followed by a onRequestEnded callback.

Specified by:

onRequestData in interface HTTPServerStream

Parameters:

onRequestData - The callback

onRequestEnded

public void onRequestEnded(Consumer<HTTPMessageTrailers> onRequestEnded)

Description copied from interface: HTTPServerStream

Sets a callback that is called when this HTTPServerStream has finished receiving the request and data, including optional trailers.

If this callback is called, it ends this HTTPServerStream and no further callbacks will be called.

Specified by:

onRequestEnded in interface HTTPServerStream

Parameters:

onRequestEnded - The callback

respond

public void respond(HTTPResponseData response)

Responds to this HTTPServerStream with the given full response, if no response was already sent. This method implicitly closes this HTTPServerStream.

See HTTPResponder.respond(HTTPRequest, HTTPResponseData) for additional information.

Specified by:

respond in interface HTTPServerStream

Parameters:

response - The response

See Also:

• HTTPServerStream.respond(int, byte[], String...)
• HTTPServerStream.startResponse(HTTPResponse)

Implementation Note:

Calls HTTPResponder.respond(HTTPRequest, HTTPResponseData)

respond

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

Responds to this HTTPServerStream with a new HTTP response with the given status, data and headers, if no response was already sent. This method implicitly closes this HTTPServerStream.

See HTTPResponder.respond(HTTPRequest, int, byte[], String...) for additional information.

Specified by:

respond in interface HTTPServerStream

Parameters:

status - The status code of the response

data - The data to send in the response

headers - Headers to send in the response

See Also:

• HTTPServerStream.respond(HTTPResponseData)
• HTTPServerStream.startResponse(HTTPResponse)

Implementation Note:

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