Class TransmitStatusRuntimeExceptionInterceptor

java.lang.Object

io.grpc.util.TransmitStatusRuntimeExceptionInterceptor

All Implemented Interfaces:

ServerInterceptor

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/2189")
public final class TransmitStatusRuntimeExceptionInterceptor
extends Object
implements ServerInterceptor

A class that intercepts uncaught exceptions of type StatusRuntimeException and handles them by closing the ServerCall, and transmitting the exception's status and metadata to the client.

Without this interceptor, gRPC will strip all details and close the ServerCall with a generic Status.UNKNOWN code.

Security warning: the Status and Metadata may contain sensitive server-side state information, and generally should not be sent to clients. Only install this interceptor if all clients are trusted.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	TransmitStatusRuntimeExceptionInterceptor.SerializingServerCall<ReqT,RespT>	A ServerCall that wraps around a non thread safe delegate and provides thread safe access by serializing everything on an executor.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TransmitStatusRuntimeExceptionInterceptor()

Method Summary

Modifier and Type	Method	Description
static ServerInterceptor	instance()
<ReqT,RespT> ServerCall.Listener<ReqT>	interceptCall(ServerCall<ReqT,RespT> call, Metadata headers, ServerCallHandler<ReqT,RespT> next)	Intercept ServerCall dispatch by the next ServerCallHandler.

Methods inherited from class Object

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

Constructor Details

TransmitStatusRuntimeExceptionInterceptor

private TransmitStatusRuntimeExceptionInterceptor()

Method Details

instance

public static ServerInterceptor instance()

interceptCall

public <ReqT,RespT> ServerCall.Listener<ReqT> interceptCall(ServerCall<ReqT,RespT> call,
 Metadata headers,
 ServerCallHandler<ReqT,RespT> next)

Description copied from interface: ServerInterceptor

Intercept ServerCall dispatch by the next ServerCallHandler. General semantics of ServerCallHandler.startCall(ServerCall, Metadata) apply and the returned ServerCall.Listener must not be null.

If the implementation throws an exception, call will be closed with an error. Implementations must not throw an exception if they started processing that may use call on another thread.

Specified by:

interceptCall in interface ServerInterceptor

Parameters:

call - object to receive response messages

headers - which can contain extra call metadata from ClientCall.start(ClientCall.Listener, Metadata), e.g. authentication credentials.

next - next processor in the interceptor chain

Returns:

listener for processing incoming messages for call, never null.