Package io.servicetalk.http.utils

Class PayloadSizeLimitingHttpServiceFilter

java.lang.Object

io.servicetalk.http.utils.PayloadSizeLimitingHttpServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class PayloadSizeLimitingHttpServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory

Limits the request payload size. The filter will throw an exception which may result in stream/connection closure. A PayloadTooLargeException will be thrown when the maximum payload size is exceeded.

Constructor Summary

Constructors

Constructor	Description
PayloadSizeLimitingHttpServiceFilter(int maxRequestPayloadSize)	Create a new instance.

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

Constructor Details

PayloadSizeLimitingHttpServiceFilter

public PayloadSizeLimitingHttpServiceFilter(int maxRequestPayloadSize)

Create a new instance.

Parameters:

maxRequestPayloadSize - The maximum request payload size allowed.

Method Details

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.

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.