Class QContext

java.lang.Object

com.kingsrook.qqq.backend.core.context.QContext

public class QContext
extends Object

A collection of thread-local variables, to define the current context of the QQQ code that is running. e.g., what QInstance is being used, what QSession is active, etc.

Method Summary

Modifier and Type	Method	Description
static CapturedContext	capture()	Capture all values from the current thread - meant to be used with the init overload that takes a CapturedContext, for setting up a child thread.
static void	clear()	Clear all values in the current thread.
static void	clearTransaction()
static Stack<AbstractActionInput>	getActionStack()
static Optional<AbstractActionInput>	getFirstActionInStack()
static Serializable	getObject(String key)	get one named object from the Context for the current thread.
static <T extends Serializable> Optional<T>	getObject(String key, Class<T> type)	get one named object from the Context for the current thread, cast to the specified type if possible.
static Map<String,Serializable>	getObjects()	get the full map of named objects for the current thread (possibly null).
static QBackendTransaction	getQBackendTransaction()
static QInstance	getQInstance()
static QSession	getQSession()
static void	init(CapturedContext capturedContext)	Init a new thread with the context captured from a different thread.
static void	init(QInstance qInstance, QSession qSession)	Most common method to set or init the context - e.g., set the current thread with a QInstance and QSession.
static void	init(QInstance qInstance, QSession qSession, QBackendTransaction transaction, AbstractActionInput actionInput)	Full flavor init method - also take a transaction and action input (to seed the stack).
static void	popAction()
static void	pushAction(AbstractActionInput action)
static void	removeObject(String key)	remove a named object from the Context of the current thread.
static void	setObject(String key, Serializable object)	put a named object into the Context for the current thread.
static void	setObjects(Map<String,Serializable> objects)	fully replace the map of named objets for the current thread.
static void	setQInstance(QInstance qInstance)
static void	setQSession(QSession qSession)
static void	setTransaction(QBackendTransaction transaction)
static <T extends Throwable> void	withTemporaryContext(CapturedContext context, UnsafeVoidVoidMethod<T> method)

Methods inherited from class java.lang.Object

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

Method Details

init

public static void init(QInstance qInstance,
 QSession qSession)

Most common method to set or init the context - e.g., set the current thread with a QInstance and QSession.

init

public static void init(QInstance qInstance,
 QSession qSession,
 QBackendTransaction transaction,
 AbstractActionInput actionInput)

Full flavor init method - also take a transaction and action input (to seed the stack).

withTemporaryContext

public static <T extends Throwable> void withTemporaryContext(CapturedContext context,
 UnsafeVoidVoidMethod<T> method)
                                                       throws T

Throws:

T

init

public static void init(CapturedContext capturedContext)

Init a new thread with the context captured from a different thread. e.g., when starting some async task.

capture

public static CapturedContext capture()

Capture all values from the current thread - meant to be used with the init overload that takes a CapturedContext, for setting up a child thread.

clear

public static void clear()

Clear all values in the current thread.

getQInstance

public static QInstance getQInstance()

getQSession

public static QSession getQSession()

getQBackendTransaction

public static QBackendTransaction getQBackendTransaction()

getActionStack

public static Stack<AbstractActionInput> getActionStack()

pushAction

public static void pushAction(AbstractActionInput action)

popAction

public static void popAction()

setQInstance

public static void setQInstance(QInstance qInstance)

setQSession

public static void setQSession(QSession qSession)

setTransaction

public static void setTransaction(QBackendTransaction transaction)

clearTransaction

public static void clearTransaction()

getFirstActionInStack

public static Optional<AbstractActionInput> getFirstActionInStack()

getObject

public static Serializable getObject(String key)

get one named object from the Context for the current thread. may return null.

getObject

public static <T extends Serializable> Optional<T> getObject(String key,
 Class<T> type)

get one named object from the Context for the current thread, cast to the specified type if possible. if not found, or wrong type, empty is returned.

setObject

public static void setObject(String key,
 Serializable object)

put a named object into the Context for the current thread.

removeObject

public static void removeObject(String key)

remove a named object from the Context of the current thread.

getObjects

public static Map<String,Serializable> getObjects()

get the full map of named objects for the current thread (possibly null).

setObjects

public static void setObjects(Map<String,Serializable> objects)

fully replace the map of named objets for the current thread.