io.servicetalk.http.api

Class StreamingHttpClientFilter

Object

StreamingHttpClientFilter

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, FilterableStreamingHttpClient, StreamingHttpRequester, StreamingHttpRequestFactory

public class StreamingHttpClientFilter
extends Object
implements FilterableStreamingHttpClient

A StreamingHttpClient that delegates all methods to a different StreamingHttpClient.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Completable	closeAsync()
Completable	closeAsyncGracefully()
protected 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()
Single<StreamingHttpResponse>	request(HttpExecutionStrategy strategy, StreamingHttpRequest request) Deprecated.
Single<StreamingHttpResponse>	request(StreamingHttpRequest request) Send a request.
protected Single<StreamingHttpResponse>	request(StreamingHttpRequester delegate, HttpExecutionStrategy strategy, StreamingHttpRequest request) Deprecated. Use request(StreamingHttpRequester, StreamingHttpRequest). If an HttpExecutionStrategy needs to be altered, provide a value for HttpContextKeys.HTTP_EXECUTION_STRATEGY_KEY in the request context.
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(HttpExecutionStrategy strategy, HttpRequestMetaData metaData) Deprecated.
Single<? extends FilterableReservedStreamingHttpConnection>	reserveConnection(HttpRequestMetaData metaData) Reserve a StreamingHttpConnection based on provided HttpRequestMetaData.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface StreamingHttpRequestFactory

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

Constructor Detail

StreamingHttpClientFilter

protected StreamingHttpClientFilter(FilterableStreamingHttpClient delegate)

Create a new instance.

Parameters:

delegate - The FilterableStreamingHttpClient to delegate all calls to.

Method Detail

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.

request

@Deprecated
public final Single<StreamingHttpResponse> request(HttpExecutionStrategy strategy,
                                                               StreamingHttpRequest request)

Deprecated.

Description copied from interface: StreamingHttpRequester

Send a request using the specified strategy.

Specified by:

request in interface StreamingHttpRequester

Parameters:

strategy - HttpExecutionStrategy to use for executing the request.

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 the ReservedStreamingHttpConnection upon completion.

reserveConnection

@Deprecated
public Single<? extends FilterableReservedStreamingHttpConnection> reserveConnection(HttpExecutionStrategy strategy,
                                                                                                 HttpRequestMetaData metaData)

Deprecated.

Description copied from interface: FilterableStreamingHttpClient

Reserve a StreamingHttpConnection based on provided HttpRequestMetaData.

Specified by:

reserveConnection in interface FilterableStreamingHttpClient

Parameters:

strategy - HttpExecutionStrategy to use.

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 the ReservedStreamingHttpConnection 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()

Specified by:

onClose in interface ListenableAsyncCloseable

closeAsync

public Completable closeAsync()

Specified by:

closeAsync in interface AsyncCloseable

closeAsyncGracefully

public Completable closeAsyncGracefully()

Specified by:

closeAsyncGracefully in interface AsyncCloseable

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

@Deprecated
protected Single<StreamingHttpResponse> request(StreamingHttpRequester delegate,
                                                            HttpExecutionStrategy strategy,
                                                            StreamingHttpRequest request)

Deprecated. Use request(StreamingHttpRequester, StreamingHttpRequest). If an HttpExecutionStrategy needs to be altered, provide a value for HttpContextKeys.HTTP_EXECUTION_STRATEGY_KEY in the request context.

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

Parameters:

delegate - The StreamingHttpRequester to delegate requests to.

strategy - The HttpExecutionStrategy to use for executing the request.

request - The request to delegate.

Returns:

the response.

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.