io.servicetalk.http.api

Class HttpExceptionMapperServiceFilter

Object

HttpExceptionMapperServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class HttpExceptionMapperServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory

Filter that maps known Exception subtypes into an HTTP response with an appropriate HttpResponseStatus.

This filter is recommended to be placed as early as possible to make sure it captures all exceptions that may be generated by other filters.

Field Summary

Fields

Modifier and Type	Field and Description
static StreamingHttpServiceFilterFactory	INSTANCE Instance of HttpExceptionMapperServiceFilter.

Method Summary

Modifier and Type	Method and Description
StreamingHttpServiceFilter	create(StreamingHttpService service) Create a StreamingHttpServiceFilter using the provided StreamingHttpService.
HttpExecutionStrategy	requiredOffloads()

Methods inherited from class Object

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

Methods inherited from interface HttpExecutionStrategyInfluencer

defaultStreamingInfluencer, influenceStrategy

Field Detail

INSTANCE

public static final StreamingHttpServiceFilterFactory INSTANCE

Instance of HttpExceptionMapperServiceFilter.

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.

requiredOffloads

public HttpExecutionStrategy requiredOffloads()

Description copied from interface: HttpExecutionStrategyInfluencer

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 HttpExecutionStrategyInfluencer

Specified by:

requiredOffloads in interface ExecutionStrategyInfluencer<HttpExecutionStrategy>