Package io.grpc

Class ClientInterceptors

java.lang.Object

io.grpc.ClientInterceptors

public class ClientInterceptors
extends java.lang.Object

Utility methods for working with ClientInterceptors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientInterceptors.CheckedForwardingClientCall<ReqT,RespT>	A ForwardingClientCall that delivers exceptions from its start logic to the call listener.
private static class	ClientInterceptors.InterceptorChannel

Field Summary

Fields

Modifier and Type	Field	Description
private static ClientCall<java.lang.Object,java.lang.Object>	NOOP_CALL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ClientInterceptors()

Method Summary

Modifier and Type	Method	Description
static Channel	intercept(Channel channel, ClientInterceptor... interceptors)	Create a new Channel that will call interceptors before starting a call on the given channel.
static Channel	intercept(Channel channel, java.util.List<? extends ClientInterceptor> interceptors)	Create a new Channel that will call interceptors before starting a call on the given channel.
static Channel	interceptForward(Channel channel, ClientInterceptor... interceptors)	Create a new Channel that will call interceptors before starting a call on the given channel.
static Channel	interceptForward(Channel channel, java.util.List<? extends ClientInterceptor> interceptors)	Create a new Channel that will call interceptors before starting a call on the given channel.
(package private) static <WReqT,WRespT> ClientInterceptor	wrapClientInterceptor(ClientInterceptor interceptor, MethodDescriptor.Marshaller<WReqT> reqMarshaller, MethodDescriptor.Marshaller<WRespT> respMarshaller)	Creates a new ClientInterceptor that transforms requests into WReqT and responses into WRespT before passing them into the interceptor.

Methods inherited from class java.lang.Object

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

Field Detail

NOOP_CALL

private static final ClientCall<java.lang.Object,java.lang.Object> NOOP_CALL

Constructor Detail

ClientInterceptors

private ClientInterceptors()

Method Detail

interceptForward

public static Channel interceptForward(Channel channel,
                                       ClientInterceptor... interceptors)

Create a new Channel that will call interceptors before starting a call on the given channel. The first interceptor will have its ClientInterceptor.interceptCall(io.grpc.MethodDescriptor<ReqT, RespT>, io.grpc.CallOptions, io.grpc.Channel) called first.

Parameters:

channel - the underlying channel to intercept.

interceptors - array of interceptors to bind to channel.

Returns:

a new channel instance with the interceptors applied.

interceptForward

public static Channel interceptForward(Channel channel,
                                       java.util.List<? extends ClientInterceptor> interceptors)

Create a new Channel that will call interceptors before starting a call on the given channel. The first interceptor will have its ClientInterceptor.interceptCall(io.grpc.MethodDescriptor<ReqT, RespT>, io.grpc.CallOptions, io.grpc.Channel) called first.

Parameters:

channel - the underlying channel to intercept.

interceptors - a list of interceptors to bind to channel.

Returns:

a new channel instance with the interceptors applied.

intercept

public static Channel intercept(Channel channel,
                                ClientInterceptor... interceptors)

Create a new Channel that will call interceptors before starting a call on the given channel. The last interceptor will have its ClientInterceptor.interceptCall(io.grpc.MethodDescriptor<ReqT, RespT>, io.grpc.CallOptions, io.grpc.Channel) called first.

Parameters:

channel - the underlying channel to intercept.

interceptors - array of interceptors to bind to channel.

Returns:

a new channel instance with the interceptors applied.

intercept

public static Channel intercept(Channel channel,
                                java.util.List<? extends ClientInterceptor> interceptors)

Create a new Channel that will call interceptors before starting a call on the given channel. The last interceptor will have its ClientInterceptor.interceptCall(io.grpc.MethodDescriptor<ReqT, RespT>, io.grpc.CallOptions, io.grpc.Channel) called first.

Parameters:

channel - the underlying channel to intercept.

interceptors - a list of interceptors to bind to channel.

Returns:

a new channel instance with the interceptors applied.

wrapClientInterceptor

static <WReqT,WRespT> ClientInterceptor wrapClientInterceptor(ClientInterceptor interceptor,
                                                                    MethodDescriptor.Marshaller<WReqT> reqMarshaller,
                                                                    MethodDescriptor.Marshaller<WRespT> respMarshaller)

Creates a new ClientInterceptor that transforms requests into WReqT and responses into WRespT before passing them into the interceptor.