Package pl.morgwai.base.guice.scopes

Classes for building Guice Scopes, that get automatically transferred when dispatching work to other threads.

Code organization guidelines for deriving libs:

Deriving libs should usually define their "central class" extending Module containing the following:

• instances of ContextTrackers for all defined TrackableContext subclasses
• instances of corresponding ContextScopes
• List<ContextTracker<?>> allTrackers instance var containing all the above ContextTracker instances
• ContextBinder contextBinder = new ContextBinder(allTrackers) instance var
• getActiveContexts() method returning ContextTracker.getActiveContexts(allTrackers)
• configure(binder) method that creates the following bindings:
  • List<ContextTracker<?>> to allTrackers
  • ContextBinder to contextBinder
  • Their respective types to the defined ContextTracker instances
  • Their respective types to Providers of the defined Context instances, usually defined similarly to 1 of the below:
    • for TrackableContexts: respectiveTrackerInstance::getCurrentContext
    • for induced InjectionContexts: () -> inducingContextTracker.getCurrentContext().getRespectiveInducedContext()

See Also:

project homepage

Class Summary

Class	Description
ContextBinder	Binds closures to Contexts that were active at the time of a given binding.
ContextBoundBiConsumer<T,U>	A decorator that executes its wrapped BiConsumer within supplied Contexts.
ContextBoundBiFunction<T,U,R>	A decorator that executes its wrapped BiFunction within supplied Contexts.
ContextBoundCallable<T>	A decorator that executes its wrapped Callable within supplied Contexts.
ContextBoundClosure<ClosureT>	Base class for decorators that execute their wrapped closures within supplied Contexts.
ContextBoundConsumer<T>	A decorator that executes its wrapped Consumer within supplied Contexts.
ContextBoundFunction<T,R>	A decorator that executes its wrapped Function within supplied Contexts.
ContextBoundRunnable	A decorator that executes its wrapped Runnable within supplied Contexts.
ContextBoundSupplier<T>	A decorator that executes its wrapped Supplier within supplied Contexts.
ContextScope<ContextT extends TrackableContext<? super ContextT>>	Scopes objects to the Context that is current during a given provisioning.
ContextTracker<ContextT extends TrackableContext<? super ContextT>>	Allows to track which Thread is running within which Context.
InducedContextScope<BaseContextT extends TrackableContext<? super BaseContextT>,InducedContextT extends InjectionContext>	Scopes objects to the InducedContextT instance induced by the instance of BaseContextT current during a given provisioning.
InjectionContext	Stores objects scoped to the context of some event/call/request/session, such as an RPC, a servlet request processing, a session combining several events etc.
TrackableContext<ContextT extends TrackableContext<ContextT>>	An InjectionContext that can execute tasks within itself, so that it can be tracked across Threads using its associated ContextTracker.