Package io.servicetalk.http.utils

Class HttpRequestAutoDrainingServiceFilter

java.lang.Object

io.servicetalk.http.utils.HttpRequestAutoDrainingServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class HttpRequestAutoDrainingServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory

Configure automatic consumption of request payload body when it is not consumed by the service.

For persistent HTTP connections it is required to eventually consume the entire request payload to enable reading of the next request. This is required because requests are pipelined for HTTP/1.1, so if the previous request is not completely read, next request can not be read from the socket. For cases when there is a possibility that user may forget to consume request payload, this filter can be used to automatically consume request payload body on the server-side. An example of guaranteed consumption are non-streaming APIs.

See Also:

• for adding this filter automatically when the server is constructed.

Field Summary

Fields

Modifier and Type	Field	Description
static final StreamingHttpServiceFilterFactory	INSTANCE	Singleton instance of the draining service filter.

Method Summary

Modifier and Type	Method	Description
StreamingHttpServiceFilter	create(StreamingHttpService service)	Create a StreamingHttpServiceFilter using the provided StreamingHttpService.
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

Field Details

INSTANCE

public static final StreamingHttpServiceFilterFactory INSTANCE

Singleton instance of the draining service filter.

Method Details

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.

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.