Package io.grpc

Class ClientInterceptors

java.lang.Object

io.grpc.ClientInterceptors

public class ClientInterceptors
extends 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.

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, 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, List<? extends ClientInterceptor> interceptors)	Create a new Channel that will call interceptors before starting a call on the given channel.

Methods inherited from class java.lang.Object

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

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,
                                       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,
                                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.