Package org.omegazero.http.util

Class AbstractHTTPClientStream

java.lang.Object

org.omegazero.http.util.AbstractHTTPMessageStream

org.omegazero.http.util.AbstractHTTPClientStream

All Implemented Interfaces:

Closeable, AutoCloseable, HTTPClientStream, HTTPMessageStream

public abstract class AbstractHTTPClientStream
extends AbstractHTTPMessageStream
implements HTTPClientStream

A HTTPClientStream with several basic methods implemented.

Since:

1.4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected final HTTPClient	client
protected Consumer<HTTPResponse>	onResponse
protected Consumer<HTTPResponseData>	onResponseData
protected Consumer<HTTPMessageTrailers>	onResponseEnded
protected Consumer<HTTPClientStream>	onServerPush
protected HTTPResponse	response

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

closed, onError, onWritable, request

Constructor Summary

Constructors

Constructor	Description
AbstractHTTPClientStream(HTTPRequest request, HTTPClient client)	Creates a new AbstractHTTPClientStream.

Method Summary

Modifier and Type	Method	Description
void	callOnResponseData(HTTPResponseData data)	Calls the onResponseData callback.
void	callOnResponseEnded(HTTPMessageTrailers trailers)	Calls the onResponseEnded callback and sets AbstractHTTPMessageStream.closed to true.
void	callOnServerPush(HTTPClientStream reqstream)	Calls the onServerPush callback.
HTTPClient	getClient()	Returns the HTTPClient that created this HTTPClientStream.
HTTPResponse	getResponse()	Returns the received response of this HTTPClientStream, or null if no response was received yet.
void	onResponse(Consumer<HTTPResponse> onResponse)	Sets a callback that is called when this HTTPClientStream receives a response.
void	onResponseData(Consumer<HTTPResponseData> onResponseData)	Sets a callback that is called when this HTTPClientStream receives data for the response.
void	onResponseEnded(Consumer<HTTPMessageTrailers> onResponseEnded)	Sets a callback that is called when this HTTPClientStream has finished receiving the response and data, including optional trailers.
void	onServerPush(Consumer<HTTPClientStream> onServerPush)	Sets a callback that is called when this HTTPClientStream receives a pushed request.
void	responseReceived(HTTPResponse response)	Calls the onResponse callback and stores the response, if HTTPResponse.isIntermediateMessage() is false.

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.HTTPClientStream

endRequest, sendRequestData, startRequest

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

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

Field Details

client

protected final HTTPClient client

response

protected HTTPResponse response

onServerPush

protected Consumer<HTTPClientStream> onServerPush

onResponse

protected Consumer<HTTPResponse> onResponse

onResponseData

protected Consumer<HTTPResponseData> onResponseData

onResponseEnded

protected Consumer<HTTPMessageTrailers> onResponseEnded

Constructor Details

AbstractHTTPClientStream

public AbstractHTTPClientStream(HTTPRequest request,
 HTTPClient client)

Creates a new AbstractHTTPClientStream.

Parameters:

request - The request

client - The client

Method Details

callOnServerPush

public void callOnServerPush(HTTPClientStream reqstream)

Calls the onServerPush callback.

Parameters:

reqstream - The pushed response stream

responseReceived

public void responseReceived(HTTPResponse response)

Calls the onResponse callback and stores the response, if HTTPResponse.isIntermediateMessage() is false.

Parameters:

response - The response

callOnResponseData

public void callOnResponseData(HTTPResponseData data)

Calls the onResponseData callback.

Parameters:

data - The object to pass to the callback

callOnResponseEnded

public void callOnResponseEnded(HTTPMessageTrailers trailers)

Calls the onResponseEnded callback and sets AbstractHTTPMessageStream.closed to true.

Parameters:

trailers - Optional trailers to pass to the callback

getClient

public HTTPClient getClient()

Description copied from interface: HTTPClientStream

Returns the HTTPClient that created this HTTPClientStream.

Specified by:

getClient in interface HTTPClientStream

Returns:

The HTTPClient

getResponse

public HTTPResponse getResponse()

Description copied from interface: HTTPClientStream

Returns the received response of this HTTPClientStream, or null if no response was received yet.

Specified by:

getResponse in interface HTTPClientStream

Returns:

The response

onServerPush

public void onServerPush(Consumer<HTTPClientStream> onServerPush)

Description copied from interface: HTTPClientStream

Sets a callback that is called when this HTTPClientStream receives a pushed request.

This callback is always called before the onResponse callback. If the underlying protocol does not support server push, this callback is never called.

The new HTTPClientStream passed to the callback is used to receive the pushed response. The methods HTTPClientStream.startRequest(), HTTPClientStream.sendRequestData(byte[], boolean), and HTTPClientStream.endRequest(HTTPMessageTrailers) should not be called on this HTTPClientStream. The onResponse callback will be called as soon as the pushed response is received.

Specified by:

onServerPush in interface HTTPClientStream

Parameters:

onServerPush - The callback

onResponse

public void onResponse(Consumer<HTTPResponse> onResponse)

Description copied from interface: HTTPClientStream

Sets a callback that is called when this HTTPClientStream receives a response.

No other callbacks in this HTTPClientStream are called before the given callback has returned.

This callback may be called multiple times when receiving multiple responses (for example, a 102 Processing followed by the actual response, see also: HTTPResponse.isIntermediateMessage()).

Specified by:

onResponse in interface HTTPClientStream

Parameters:

onResponse - The callback

onResponseData

public void onResponseData(Consumer<HTTPResponseData> onResponseData)

Description copied from interface: HTTPClientStream

Sets a callback that is called when this HTTPClientStream receives data for the response.

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

Specified by:

onResponseData in interface HTTPClientStream

Parameters:

onResponseData - The callback

onResponseEnded

public void onResponseEnded(Consumer<HTTPMessageTrailers> onResponseEnded)

Description copied from interface: HTTPClientStream

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

If this callback is called, this HTTPClientStream is implicitly closed and no further callbacks will be called.

Specified by:

onResponseEnded in interface HTTPClientStream

Parameters:

onResponseEnded - The callback