Package io.servicetalk.http.api

Class StreamingHttpClientFilter

java.lang.Object

io.servicetalk.http.api.StreamingHttpClientFilter

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, GracefulAutoCloseable, FilterableStreamingHttpClient, StreamingHttpRequester, StreamingHttpRequestFactory, AutoCloseable

public class StreamingHttpClientFilter
extends Object
implements FilterableStreamingHttpClient

A StreamingHttpClient that delegates all methods to a different StreamingHttpClient.

See Also:

• StreamingHttpClientFilterFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamingHttpClientFilter(FilterableStreamingHttpClient delegate)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
Completable	closeAsync()	Used to close/shutdown a resource.
Completable	closeAsyncGracefully()	Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
protected final FilterableStreamingHttpClient	delegate()	Get the FilterableStreamingHttpClient this method delegates to.
HttpExecutionContext	executionContext()	Get the HttpExecutionContext used during construction of this object.
StreamingHttpResponseFactory	httpResponseFactory()	Get a StreamingHttpResponseFactory.
StreamingHttpRequest	newRequest(HttpRequestMethod method, String requestTarget)	Create a new HttpRequestFactory.
Completable	onClose()	Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
Completable	onClosing()	Returns a Completable that is notified when closing begins.
final Single<StreamingHttpResponse>	request(StreamingHttpRequest request)	Send a request.
protected Single<StreamingHttpResponse>	request(StreamingHttpRequester delegate, StreamingHttpRequest request)	Called when the filter needs to delegate the request using the provided StreamingHttpRequester on which to call StreamingHttpRequester.request(StreamingHttpRequest).
Single<? extends FilterableReservedStreamingHttpConnection>	reserveConnection(HttpRequestMetaData metaData)	Reserve a StreamingHttpConnection based on provided HttpRequestMetaData.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.http.api.StreamingHttpRequester

close, closeGracefully

Methods inherited from interface io.servicetalk.http.api.StreamingHttpRequestFactory

connect, delete, get, head, options, patch, post, put, trace

Constructor Details

StreamingHttpClientFilter

protected StreamingHttpClientFilter(FilterableStreamingHttpClient delegate)

Create a new instance.

Parameters:

delegate - The FilterableStreamingHttpClient to delegate all calls to.

Method Details

request

public final Single<StreamingHttpResponse> request(StreamingHttpRequest request)

Description copied from interface: StreamingHttpRequester

Send a request.

Specified by:

request in interface StreamingHttpRequester

Parameters:

request - the request to send.

Returns:

The response.

reserveConnection

public Single<? extends FilterableReservedStreamingHttpConnection> reserveConnection(HttpRequestMetaData metaData)

Description copied from interface: FilterableStreamingHttpClient

Reserve a StreamingHttpConnection based on provided HttpRequestMetaData.

Specified by:

reserveConnection in interface FilterableStreamingHttpClient

Parameters:

metaData - Allows the underlying layers to know what StreamingHttpConnections are valid to reserve for future requests with the same HttpRequestMetaData. For example this may provide some insight into shard or other info.

Returns:

a Single that provides a FilterableReservedStreamingHttpConnection upon completion.

executionContext

public HttpExecutionContext executionContext()

Description copied from interface: StreamingHttpRequester

Get the HttpExecutionContext used during construction of this object.

Note that the ExecutionContext.ioExecutor() will not necessarily be associated with a specific thread unless that was how this object was built.

Specified by:

executionContext in interface StreamingHttpRequester

Returns:

the HttpExecutionContext used during construction of this object.

httpResponseFactory

public StreamingHttpResponseFactory httpResponseFactory()

Description copied from interface: StreamingHttpRequester

Get a StreamingHttpResponseFactory.

Specified by:

httpResponseFactory in interface StreamingHttpRequester

Returns:

a StreamingHttpResponseFactory.

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.

onClosing

public Completable onClosing()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified when closing begins.

Closing begin might be when a close operation is initiated locally (e.g. subscribing to AsyncCloseable.closeAsync()) or it could also be a transport event received from a remote peer (e.g. read a connection: close header).

For backwards compatibility this method maybe functionally equivalent to ListenableAsyncCloseable.onClose(). Therefore, provides a best-effort leading edge notification of closing, but may fall back to notification on trailing edge.

The goal of this method is often to notify asap when closing so this method may not be offloaded and care must be taken to avoid blocking if subscribing to the return Completable.

Specified by:

onClosing in interface ListenableAsyncCloseable

Returns:

a Completable that is notified when closing begins.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Specified by:

closeAsyncGracefully in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

newRequest

public StreamingHttpRequest newRequest(HttpRequestMethod method,
 String requestTarget)

Description copied from interface: StreamingHttpRequestFactory

Create a new HttpRequestFactory.

Specified by:

newRequest in interface StreamingHttpRequestFactory

Parameters:

method - The HttpRequestMethod.

requestTarget - The request target.

Returns:

a new HttpRequestFactory.

toString

public String toString()

Overrides:

toString in class Object

delegate

protected final FilterableStreamingHttpClient delegate()

Get the FilterableStreamingHttpClient this method delegates to.

Returns:

the FilterableStreamingHttpClient this method delegates to.

request

protected Single<StreamingHttpResponse> request(StreamingHttpRequester delegate,
 StreamingHttpRequest request)

Called when the filter needs to delegate the request using the provided StreamingHttpRequester on which to call StreamingHttpRequester.request(StreamingHttpRequest).

Parameters:

delegate - The StreamingHttpRequester to delegate requests to.

request - The request to delegate.

Returns:

the response.