Package io.servicetalk.grpc.api

Class GrpcExceptionMapperServiceFilter

java.lang.Object

io.servicetalk.grpc.api.GrpcExceptionMapperServiceFilter

All Implemented Interfaces:

HttpExecutionStrategyInfluencer, StreamingHttpServiceFilterFactory, ExecutionStrategyInfluencer<HttpExecutionStrategy>

public final class GrpcExceptionMapperServiceFilter
extends Object
implements StreamingHttpServiceFilterFactory

Filter that maps known Throwable subtypes into an gRPC response with an appropriate GrpcStatusCode.

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	Description
static final StreamingHttpServiceFilterFactory	INSTANCE	Instance of GrpcExceptionMapperServiceFilter.

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

Instance of GrpcExceptionMapperServiceFilter.

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.