Package pl.morgwai.base.grpc.scopes

Class GrpcModule

java.lang.Object

pl.morgwai.base.grpc.scopes.GrpcModule

All Implemented Interfaces:

Module

public class GrpcModule
extends Object
implements Module

gRPC Guice Scopes, ContextTrackers, Interceptors and some helper methods.

Usually a single app-wide instance is created at the app startup.
In case of servers, gRPC services should be intercepted with serverInterceptor.
In case of clients, gRPC Channels should be intercepted with either clientInterceptor or nestingClientInterceptor.

Field Summary

Fields

Modifier and Type	Field	Description
List<ContextTracker<?>>	allTrackers	Singleton of listenerEventContextTracker.
static Key<List<ContextTracker<?>>>	allTrackersKey	Key of allTrackers.
ClientInterceptor	clientInterceptor	All client Channels must be intercepted either by this Interceptor or by nestingClientInterceptor.
ContextBinder	contextBinder	ContextBinder created with allTrackers.
ContextTracker<ListenerEventContext>	listenerEventContextTracker	Allows tracking of Contexts of a Listener events.
static Key<ContextTracker<ListenerEventContext>>	listenerEventContextTrackerKey	Key of listenerEventContextTracker.
Scope	listenerEventScope	Scopes objects to the Context of a Listener event (either server or client) and as a consequence also to the context of the corresponding user inbound StreamObserver call.
ClientInterceptor	nestingClientInterceptor	All client Channels must be intercepted either by this Interceptor or by clientInterceptor.
Scope	rpcScope	Scopes objects to the Context of an RPC (either ServerRpcContext or ClientRpcContext).
ServerInterceptor	serverInterceptor	All gRPC Services must be intercepted by this Interceptor.

Constructor Summary

Constructors

Constructor	Description
GrpcModule()

Method Summary

Modifier and Type	Method	Description
void	awaitTerminationOfAllExecutors()	Awaits for termination of all executors obtained from this module.
List<GrpcContextTrackingExecutor>	awaitTerminationOfAllExecutors(long timeout, TimeUnit unit)	Awaits for termination of all executors obtained from this module.
void	configure(Binder binder)	Creates infrastructure bindings.
List<GrpcContextTrackingExecutor>	enforceTerminationOfAllExecutors(long timeout, TimeUnit unit)	Enforces termination of all executors obtained from this module.
List<TrackableContext<?>>	getActiveContexts()	Calls getActiveContexts(allTrackers).
List<GrpcContextTrackingExecutor>	getExecutors()	List of all Executors created by this Module.
GrpcContextTrackingExecutor	newContextTrackingExecutor(String name, int poolSize)	Constructs a fixed size, context tracking executor that uses an unbound LinkedBlockingQueue and a new NamingThreadFactory named after this executor.
GrpcContextTrackingExecutor	newContextTrackingExecutor(String name, int poolSize, int queueSize)	Constructs a fixed size, context tracking executor that uses a LinkedBlockingQueue of size queueSize, the default RejectedExecutionHandler and a new NamingThreadFactory named after this executor.
GrpcContextTrackingExecutor	newContextTrackingExecutor(String name, int corePoolSize, int maxPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory)	Constructs a context tracking executor.
GrpcContextTrackingExecutor	newContextTrackingExecutor(String name, int corePoolSize, int maxPoolSize, long keepAliveTime, TimeUnit unit, BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory, RejectedExecutionHandler handler)	Constructs a context tracking executor.
void	shutdownAllExecutors()	Shutdowns all executors obtained from this module.
Awaitable.WithUnit	toAwaitableOfEnforcedTerminationOfAllExecutors()	Creates Awaitable.WithUnit of enforceTerminationOfAllExecutors(long, TimeUnit).
Awaitable.WithUnit	toAwaitableOfTerminationOfAllExecutors()	Creates Awaitable.WithUnit of awaitTerminationOfAllExecutors(long, TimeUnit).

Methods inherited from class java.lang.Object

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

Field Detail

listenerEventContextTracker

public final ContextTracker<ListenerEventContext> listenerEventContextTracker

Allows tracking of Contexts of a Listener events.

See Also:

listenerEventScope

listenerEventScope

public final Scope listenerEventScope

Scopes objects to the Context of a Listener event (either server or client) and as a consequence also to the context of the corresponding user inbound StreamObserver call.

rpcScope

public final Scope rpcScope

Scopes objects to the Context of an RPC (either ServerRpcContext or ClientRpcContext).

allTrackers

public final List<ContextTracker<?>> allTrackers

Singleton of listenerEventContextTracker. Type List<ContextTracker<?>> is bound to it in configure(Binder) method.

contextBinder

public final ContextBinder contextBinder

ContextBinder created with allTrackers.

serverInterceptor

public final ServerInterceptor serverInterceptor

All gRPC Services must be intercepted by this Interceptor.

nestingClientInterceptor

public final ClientInterceptor nestingClientInterceptor

All client Channels must be intercepted either by this Interceptor or by clientInterceptor. If a client call was made within a Context of some enclosing "parent" call (server call or a previous chained client call), this Interceptor will join together Context of such call with its parent RpcContext, so that they will share all RPC-scoped objects.

clientInterceptor

public final ClientInterceptor clientInterceptor

All client Channels must be intercepted either by this Interceptor or by nestingClientInterceptor. This Interceptor will keep ClientRpcContexts separate even if they were made within some enclosing RpcContexts.

listenerEventContextTrackerKey

public static final Key<ContextTracker<ListenerEventContext>> listenerEventContextTrackerKey

Key of listenerEventContextTracker.

allTrackersKey

public static final Key<List<ContextTracker<?>>> allTrackersKey

Key of allTrackers.

Constructor Detail

GrpcModule

public GrpcModule()

Method Detail

getActiveContexts

public List<TrackableContext<?>> getActiveContexts()

Calls getActiveContexts(allTrackers).

configure

public void configure(Binder binder)

Creates infrastructure bindings. Specifically binds the following:

• List<ContextTracker<?>> to allTrackers
• ContextBinder to contextBinder
• Their respective types to listenerEventContextTracker and both contexts

Specified by:

configure in interface Module

getExecutors

public List<GrpcContextTrackingExecutor> getExecutors()

List of all Executors created by this Module.

newContextTrackingExecutor

public GrpcContextTrackingExecutor newContextTrackingExecutor(String name,
                                                              int poolSize)

Constructs a fixed size, context tracking executor that uses an unbound LinkedBlockingQueue and a new NamingThreadFactory named after this executor.

To avoid OutOfMemoryErrors, an external mechanism that limits maximum number of tasks (such as a load balancer or a frontend proxy) should be used.

newContextTrackingExecutor

public GrpcContextTrackingExecutor newContextTrackingExecutor(String name,
                                                              int poolSize,
                                                              int queueSize)

Constructs a fixed size, context tracking executor that uses a LinkedBlockingQueue of size queueSize, the default RejectedExecutionHandler and a new NamingThreadFactory named after this executor.

The default RejectedExecutionHandler throws a RejectedExecutionException if the queue is full or the executor is shutting down. It should usually be handled by sending Status.UNAVAILABLE to the client.

newContextTrackingExecutor

public GrpcContextTrackingExecutor newContextTrackingExecutor(String name,
                                                              int corePoolSize,
                                                              int maxPoolSize,
                                                              long keepAliveTime,
                                                              TimeUnit unit,
                                                              BlockingQueue<Runnable> workQueue,
                                                              ThreadFactory threadFactory)

Constructs a context tracking executor.

See Also:

ThreadPoolExecutor constructor docs for param details

newContextTrackingExecutor

public GrpcContextTrackingExecutor newContextTrackingExecutor(String name,
                                                              int corePoolSize,
                                                              int maxPoolSize,
                                                              long keepAliveTime,
                                                              TimeUnit unit,
                                                              BlockingQueue<Runnable> workQueue,
                                                              ThreadFactory threadFactory,
                                                              RejectedExecutionHandler handler)

Constructs a context tracking executor.

rejectionHandler will receive a task wrapped with a ContextBoundRunnable.

In order for GrpcContextTrackingExecutor.execute(StreamObserver, Runnable) to work properly, the rejectionHandler must throw a RejectedExecutionException.

See Also:

ThreadPoolExecutor constructor docs for param details

shutdownAllExecutors

public void shutdownAllExecutors()

Shutdowns all executors obtained from this module.

enforceTerminationOfAllExecutors

public List<GrpcContextTrackingExecutor> enforceTerminationOfAllExecutors(long timeout,
                                                                          TimeUnit unit)
                                                                   throws InterruptedException

Enforces termination of all executors obtained from this module.

Returns:

an empty list if all executors were terminated, list of unterminated otherwise.

Throws:

InterruptedException

awaitTerminationOfAllExecutors

public List<GrpcContextTrackingExecutor> awaitTerminationOfAllExecutors(long timeout,
                                                                        TimeUnit unit)
                                                                 throws InterruptedException

Awaits for termination of all executors obtained from this module.

Returns:

an empty list if all executors were terminated, list of unterminated otherwise.

Throws:

InterruptedException

awaitTerminationOfAllExecutors

public void awaitTerminationOfAllExecutors()
                                    throws InterruptedException

Awaits for termination of all executors obtained from this module.

Throws:

InterruptedException

toAwaitableOfEnforcedTerminationOfAllExecutors

public Awaitable.WithUnit toAwaitableOfEnforcedTerminationOfAllExecutors()

Creates Awaitable.WithUnit of enforceTerminationOfAllExecutors(long, TimeUnit).

toAwaitableOfTerminationOfAllExecutors

public Awaitable.WithUnit toAwaitableOfTerminationOfAllExecutors()

Creates Awaitable.WithUnit of awaitTerminationOfAllExecutors(long, TimeUnit).