Package io.servicetalk.http.api

Class ContentEncodingHttpRequesterFilter

java.lang.Object

io.servicetalk.http.api.ContentEncodingHttpRequesterFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class ContentEncodingHttpRequesterFilter
extends Object
implements StreamingHttpClientFilterFactory, StreamingHttpConnectionFilterFactory

A StreamingHttpClientFilter that adds encoding / decoding functionality for requests and responses respectively, as these are specified by the spec Content-Encoding.

Append this filter before others that are expected to to see compressed content for this request/response, and after other filters that expect to manipulate the original payload.

Constructor Summary

Constructors

Constructor	Description
ContentEncodingHttpRequesterFilter(BufferDecoderGroup decompressors)	Create a new instance and specify the supported decompression (advertised in HttpHeaderNames.ACCEPT_ENCODING).

Method Summary

Modifier and Type	Method	Description
StreamingHttpClientFilter	create(FilterableStreamingHttpClient client)	Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.
StreamingHttpConnectionFilter	create(FilterableStreamingHttpConnection connection)	Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.
HttpExecutionStrategy	requiredOffloads()	Return an ExecutionStrategy that describes the offloads required by the influencer.

Methods inherited from class java.lang.Object

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

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

influenceStrategy

Constructor Details

ContentEncodingHttpRequesterFilter

public ContentEncodingHttpRequesterFilter(BufferDecoderGroup decompressors)

Create a new instance and specify the supported decompression (advertised in HttpHeaderNames.ACCEPT_ENCODING). The compression is specified via HttpRequestMetaData.contentEncoding(). The order of entries may impact the selection preference.

Parameters:

decompressors - the decompression supported to decode responses accordingly and also used to advertise HttpHeaderNames.ACCEPT_ENCODING to the server.

Method Details

create

public StreamingHttpClientFilter create(FilterableStreamingHttpClient client)

Description copied from interface: StreamingHttpClientFilterFactory

Creates a StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

Specified by:

create in interface StreamingHttpClientFilterFactory

Parameters:

client - FilterableStreamingHttpClient to filter

Returns:

StreamingHttpClientFilter using the provided StreamingHttpClientFilter.

create

public StreamingHttpConnectionFilter create(FilterableStreamingHttpConnection connection)

Description copied from interface: StreamingHttpConnectionFilterFactory

Create a StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

Specified by:

create in interface StreamingHttpConnectionFilterFactory

Parameters:

connection - FilterableStreamingHttpConnection to filter

Returns:

StreamingHttpConnectionFilter using the provided FilterableStreamingHttpConnection.

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

Return an ExecutionStrategy that describes the offloads required by the influencer.

The provided default implementation requests offloading of all operations. Implementations that require no offloading should be careful to return HttpExecutionStrategies.offloadNone() rather than HttpExecutionStrategies.offloadNever(). Implementations should avoid returning HttpExecutionStrategies.defaultStrategy(), instead returning the strategy they require or HttpExecutionStrategies.offloadAll() if offloading for all paths is required (safe default).

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>

Specified by:

requiredOffloads in interface HttpExecutionStrategyInfluencer

Returns:

the ExecutionStrategy required by the influencer.