io.servicetalk.http.api

Class ContentCodingHttpServiceFilter

Object

ContentCodingHttpServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory

public final class ContentCodingHttpServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory, HttpExecutionStrategyInfluencer

A StreamingHttpService that adds encoding / decoding functionality for responses and requests 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 see/manipulate the original payload.

Constructor Summary

Constructors

Constructor and Description
ContentCodingHttpServiceFilter(List<ContentCodec> supportedCodings) Enable support of the provided encodings for this server's responses.
ContentCodingHttpServiceFilter(List<ContentCodec> supportedRequestCodings, List<ContentCodec> supportedResponseCodings) Enable support of the provided encodings for both client requests and server responses.

Method Summary

Modifier and Type	Method and Description
StreamingHttpServiceFilter	create(StreamingHttpService service) Create a StreamingHttpServiceFilter using the provided StreamingHttpService.
HttpExecutionStrategy	influenceStrategy(HttpExecutionStrategy strategy) Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Methods inherited from class Object

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

Methods inherited from interface StreamingHttpServiceFilterFactory

append

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer

Constructor Detail

ContentCodingHttpServiceFilter

public ContentCodingHttpServiceFilter(List<ContentCodec> supportedCodings)

Enable support of the provided encodings for this server's responses. The encodings will be used for server responses compression where enabled and matched with client ones.

Client requests that have compressed payloads will be rejected. To enable support of compressed requests, see ContentCodingHttpServiceFilter(List, List).

Parameters:

supportedCodings - the codecs used to compress responses when allowed.

ContentCodingHttpServiceFilter

public ContentCodingHttpServiceFilter(List<ContentCodec> supportedRequestCodings,
                                      List<ContentCodec> supportedResponseCodings)

Enable support of the provided encodings for both client requests and server responses. The encodings can differ for requests and responses, allowing a server that supports different compressions for requests and different ones for responses.

To disable support of compressed requests use an Collections.emptyList() for the supportedRequestCodings param or use ContentCodingHttpServiceFilter(List) constructor instead.

The order of the codecs provided, affect selection priority alongside the order of the incoming accept-encoding header from the client.

Parameters:

supportedRequestCodings - the codecs used to decompress client requests if compressed.

supportedResponseCodings - the codecs used to compress server responses if client accepts them.

Method Detail

create

public StreamingHttpServiceFilter create(StreamingHttpService service)

Description copied from interface: StreamingHttpServiceFilterFactory

Create a StreamingHttpServiceFilter using the provided StreamingHttpService.

Specified by:

create in interface StreamingHttpServiceFilterFactory

Parameters:

service - StreamingHttpService to filter

Returns:

StreamingHttpServiceFilter using the provided StreamingHttpService.

influenceStrategy

public HttpExecutionStrategy influenceStrategy(HttpExecutionStrategy strategy)

Description copied from interface: HttpExecutionStrategyInfluencer

Optionally modify the passed HttpExecutionStrategy to a new HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer.

Specified by:

influenceStrategy in interface HttpExecutionStrategyInfluencer

Parameters:

strategy - HttpExecutionStrategy to influence.

Returns:

HttpExecutionStrategy that suits this HttpExecutionStrategyInfluencer