Package pl.morgwai.base.servlet.scopes

Class ServletModule

java.lang.Object

pl.morgwai.base.servlet.scopes.ServletModule

All Implemented Interfaces:

Module

public class ServletModule
extends Object
implements Module

Contains servlet and websocket Guice Scopes, ContextTrackers and some helper methods. A single app-wide instance is created at app startup: GuiceServletContextListener.servletModule.

Field Summary

Fields

Modifier and Type	Field	Description
List<ContextTracker<?>>	allTrackers	Contains all trackers.
ContextTracker<ContainerCallContext>	containerCallContextTracker	Allows tracking of ServletRequestContexts and WebsocketEventContexts.
Scope	containerCallScope	Scopes bindings to either a ServletRequestContext or a WebsocketEventContext.
Scope	httpSessionScope	Scopes bindings to the context of a given HttpSession.
Scope	websocketConnectionScope	Scopes bindings to the context of a websocket connection (jakarta.websocket.Session).

Constructor Summary

Constructors

Constructor	Description
ServletModule()

Method Summary

Modifier and Type	Method	Description
void	configure(Binder binder)	Binds containerCallContextTracker and all contexts for injection.
ContextTrackingExecutor	newContextTrackingExecutor(String name, int poolSize)	Constructs an executor backed by a new fixed size ThreadPoolExecutor that uses a NamedThreadFactory and an unbound LinkedBlockingQueue.
ContextTrackingExecutor	newContextTrackingExecutor(String name, int poolSize, BlockingQueue<Runnable> workQueue)	Constructs an executor backed by a new fixed size ThreadPoolExecutor that uses a NamedThreadFactory.
ContextTrackingExecutor	newContextTrackingExecutor(String name, int poolSize, BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory)	Constructs an executor backed by a new fixed size ThreadPoolExecutor.
ContextTrackingExecutor	newContextTrackingExecutor(String name, ExecutorService backingExecutor, int poolSize)	Constructs an executor backed by backingExecutor.

Methods inherited from class java.lang.Object

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

Field Detail

containerCallContextTracker

public final ContextTracker<ContainerCallContext> containerCallContextTracker

Allows tracking of ServletRequestContexts and WebsocketEventContexts.

containerCallScope

public final Scope containerCallScope

Scopes bindings to either a ServletRequestContext or a WebsocketEventContext. Objects bound in this scope can be obtained both in servlets and endpoints.

See Also:

ContainerCallContext

httpSessionScope

public final Scope httpSessionScope

Scopes bindings to the context of a given HttpSession. Available both to servlets and websocket endpoints.

NOTE: there's no way to create an HttpSession from the websocket endpoint layer if it does not exist yet. To safely use this scope in websocket endpoints, other layers must ensure that a session exists (for example a Filter targeting URL patterns of websockets can be used).

websocketConnectionScope

public final Scope websocketConnectionScope

Scopes bindings to the context of a websocket connection (jakarta.websocket.Session).

allTrackers

public final List<ContextTracker<?>> allTrackers

Contains all trackers. configure(Binder) binds List<ContextTracker<?>> to it for use with ContextTrackingExecutor.getActiveContexts(List).

Constructor Detail

ServletModule

public ServletModule()

Method Detail

configure

public void configure(Binder binder)

Binds containerCallContextTracker and all contexts for injection. Binds List<ContextTracker<?>> to allTrackers that contains all trackers for use with ContextTrackingExecutor.getActiveContexts(List).

Specified by:

configure in interface Module

newContextTrackingExecutor

public ContextTrackingExecutor newContextTrackingExecutor(String name,
                                                          int poolSize)

Constructs an executor backed by a new fixed size ThreadPoolExecutor that uses a NamedThreadFactory and an unbound LinkedBlockingQueue.

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

Returned executor will be shutdown automatically at app shutdown.

newContextTrackingExecutor

public ContextTrackingExecutor newContextTrackingExecutor(String name,
                                                          int poolSize,
                                                          BlockingQueue<Runnable> workQueue)

Constructs an executor backed by a new fixed size ThreadPoolExecutor that uses a NamedThreadFactory.

ContextTrackingExecutor.execute(Runnable) throws a RejectedExecutionException if workQueue is full. It should usually be handled by sending HttpServletResponse.SC_SERVICE_UNAVAILABLE to the client.

Returned executor will be shutdown automatically at app shutdown.

newContextTrackingExecutor

public ContextTrackingExecutor newContextTrackingExecutor(String name,
                                                          int poolSize,
                                                          BlockingQueue<Runnable> workQueue,
                                                          ThreadFactory threadFactory)

Constructs an executor backed by a new fixed size ThreadPoolExecutor.

ContextTrackingExecutor.execute(Runnable) throws a RejectedExecutionException if workQueue is full. It should usually be handled by sending HttpServletResponse.SC_SERVICE_UNAVAILABLE to the client.

Returned executor will be shutdown automatically at app shutdown.

newContextTrackingExecutor

public ContextTrackingExecutor newContextTrackingExecutor(String name,
                                                          ExecutorService backingExecutor,
                                                          int poolSize)

Constructs an executor backed by backingExecutor.

NOTE: backingExecutor.execute(task) must throw RejectedExecutionException in case of rejection for execute(httpResponse, task) to work properly.

poolSize is informative only, to be returned by ContextTrackingExecutor.getPoolSize().

Returned executor will be shutdown automatically at app shutdown.