Package org.cyclos.impl

Class InvocationContext

java.lang.Object

org.cyclos.impl.InvocationContext

public final class InvocationContext
extends Object

Contains the context of a service method execution

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InvocationContext.ConversionContext	Contains the context used for bean conversion within an invocation

Method Summary

Modifier and Type	Method	Description
void	addBeforeEndListener(Runnable callback)	Adds a callback to run right before committing the current database transaction
void	addCommitListener(boolean requiresTransaction, boolean afterAwakingPollingTasks, Runnable callback)	Adds a callback to run after the current transaction commits
void	addCommitListener(boolean requiresTransaction, Runnable callback)	Adds a callback to run after the current transaction commits
void	addRollbackListener(boolean requiresTransaction, boolean afterAwakingPollingTasks, Runnable callback)	Adds a callback to run after the current transaction rolls-back
void	addRollbackListener(boolean requiresTransaction, Runnable callback)	Adds a callback to run after the current transaction rolls-back
void	addTransactionEndListener(boolean requiresTransaction, boolean afterAwakingPollingTasks, Runnable callback)	Adds a callback both as commit and rollback listener
void	addTransactionEndListener(boolean requiresTransaction, Runnable callback)	Adds a callback both as commit and rollback listener
ApplicationContext	applicationContext()
void	awakePollingTask(PollingTask pollingTask)	Registers the given PollingTask to be awaked when this invocation ends
static <T> T	bean(Class<T> beanType)	Returns a Spring bean with the given class.
void	clearAttributes()
void	clearCache(CacheType<?,?> type)	Registers the given CacheType to be cleared when this invocation ends
void	delegateAcquiredResources(InvocationContext context)	Passes the acquired resources to the given context, so that when it is released, those resources will be released as well
static InvocationContext	ensure()	Returns the current context, throwing an IllegalStateException if none
<K extends Serializable> void	evictCacheKeyPredicate(CacheType<K,?> type, SerializablePredicate<K> predicate)
void	evictCacheKeys(CacheType<?,?> type, Set<? extends Serializable> keys)	Registers the given keys to be evicted from the cache described at CacheType to be cleared when this invocation ends
FormatterImpl	formatter(ConfigurationAccessor configuration)	Returns a formatter which is suitable for the given configuration accessor, or null if it is to represent the current session's configuration
static InvocationContext	get()	Returns the current context
static ApplicationContext	getApplicationContext()	Returns the current application context
<T> T	getAttribute(Object key)	Returns the value of an attribute.
<T> T	getAttribute(Object key, Supplier<T> supplier)	Returns the value of an attribute, producing it if not bound to the key
static InvocationContext.ConversionContext	getConversionContext()	Returns the InvocationContext.ConversionContext already associated with this thread, cleaning the processed objects, as they may change per invocation
static CacheFlusher	getCurrentCacheFlusher()	Returns the current CacheFlusher in the stack
javax.persistence.EntityManager	getEntityManager()	Returns the current EntityManager
static FormatterImpl	getFormatter(ConfigurationAccessor configuration)	Returns a formatter which is suitable for the given configuration accessor, or null if it is to represent the current session's configuration
StoredFileContentAction	getLastStoredFileContentAction()
static SessionData	getSessionData()	Returns the current session data
TransactionLevel	getTransactionLevel()
TransactionStatus	getTransactionStatus()
boolean	hasLock(LockKey key)	Returns whether the current thread owns the given lock
boolean	hasWrite()
static InvocationContext	init(SessionData sessionData, ApplicationContext applicationContext)	Initializes the current invocation context
boolean	isEvicted(CacheType<?,?> type, Serializable key)	Returns whether the given cache key has been evicted in this invocation
static void	markWrite()
static InvocationContext	nested(SessionData sessionData, InvocationContext oldContext)	Creates a new invocation context based on the given one
static CacheFlusher	newCacheFlusher()	Creates a new CacheFlusher, keeping trace of it on a stack
void	registerLock(LockKey key)	Registers the given lock
void	releaseAfterTransaction(boolean commit)	Releases any acquired resources.
void	releaseWithinTransaction()	Releases resources which should be released while still within a transaction
void	releaseWithoutTransaction()	Releases those acquired resources when there is no transaction.
static void	remove()	Removes the current context
SessionData	sessionData()
static void	set(InvocationContext context)	Sets the current invocation context
void	setAttribute(Object key, Object value)
void	setEntityManager(javax.persistence.EntityManager entityManager)
void	setLastStoredFileContentAction(StoredFileContentAction lastContentAction)
void	setTransactionLevel(TransactionLevel transactionLevel)
void	setTransactionStatus(TransactionStatus transactionStatus)
static BeanWrapper	wrap(Object bean)	Returns a BeanWrapper for the given bean

Methods inherited from class java.lang.Object

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

Method Detail

bean

public static <T> T bean(Class<T> beanType)

Returns a Spring bean with the given class. Equivalent to getApplicationContext() then BeanFactory.getBean(Class)

ensure

public static InvocationContext ensure()

Returns the current context, throwing an IllegalStateException if none

get

public static InvocationContext get()

Returns the current context

getApplicationContext

public static ApplicationContext getApplicationContext()

Returns the current application context

getConversionContext

public static InvocationContext.ConversionContext getConversionContext()

Returns the InvocationContext.ConversionContext already associated with this thread, cleaning the processed objects, as they may change per invocation

getCurrentCacheFlusher

public static CacheFlusher getCurrentCacheFlusher()

Returns the current CacheFlusher in the stack

getFormatter

public static FormatterImpl getFormatter(ConfigurationAccessor configuration)

Returns a formatter which is suitable for the given configuration accessor, or null if it is to represent the current session's configuration

getSessionData

public static SessionData getSessionData()

Returns the current session data

init

public static InvocationContext init(SessionData sessionData,
                                     ApplicationContext applicationContext)

Initializes the current invocation context

markWrite

public static void markWrite()

nested

public static InvocationContext nested(SessionData sessionData,
                                       InvocationContext oldContext)

Creates a new invocation context based on the given one

newCacheFlusher

public static CacheFlusher newCacheFlusher()

Creates a new CacheFlusher, keeping trace of it on a stack

remove

public static void remove()

Removes the current context

set

public static void set(InvocationContext context)

Sets the current invocation context

wrap

public static BeanWrapper wrap(Object bean)

Returns a BeanWrapper for the given bean

addBeforeEndListener

public void addBeforeEndListener(Runnable callback)

Adds a callback to run right before committing the current database transaction

addCommitListener

public void addCommitListener(boolean requiresTransaction,
                              boolean afterAwakingPollingTasks,
                              Runnable callback)

Adds a callback to run after the current transaction commits

addCommitListener

public void addCommitListener(boolean requiresTransaction,
                              Runnable callback)

Adds a callback to run after the current transaction commits

addRollbackListener

public void addRollbackListener(boolean requiresTransaction,
                                boolean afterAwakingPollingTasks,
                                Runnable callback)

Adds a callback to run after the current transaction rolls-back

addRollbackListener

public void addRollbackListener(boolean requiresTransaction,
                                Runnable callback)

Adds a callback to run after the current transaction rolls-back

addTransactionEndListener

public void addTransactionEndListener(boolean requiresTransaction,
                                      boolean afterAwakingPollingTasks,
                                      Runnable callback)

Adds a callback both as commit and rollback listener

addTransactionEndListener

public void addTransactionEndListener(boolean requiresTransaction,
                                      Runnable callback)

Adds a callback both as commit and rollback listener

applicationContext

public ApplicationContext applicationContext()

awakePollingTask

public void awakePollingTask(PollingTask pollingTask)

Registers the given PollingTask to be awaked when this invocation ends

clearAttributes

public void clearAttributes()

clearCache

public void clearCache(CacheType<?,?> type)

Registers the given CacheType to be cleared when this invocation ends

delegateAcquiredResources

public void delegateAcquiredResources(InvocationContext context)

Passes the acquired resources to the given context, so that when it is released, those resources will be released as well

evictCacheKeyPredicate

public <K extends Serializable> void evictCacheKeyPredicate(CacheType<K,?> type,
                                                            SerializablePredicate<K> predicate)

evictCacheKeys

public void evictCacheKeys(CacheType<?,?> type,
                           Set<? extends Serializable> keys)

Registers the given keys to be evicted from the cache described at CacheType to be cleared when this invocation ends

formatter

public FormatterImpl formatter(ConfigurationAccessor configuration)

Returns a formatter which is suitable for the given configuration accessor, or null if it is to represent the current session's configuration

getAttribute

public <T> T getAttribute(Object key)

Returns the value of an attribute. If is an entity, makes sure it is attached to the current entityManager

getAttribute

public <T> T getAttribute(Object key,
                          Supplier<T> supplier)

Returns the value of an attribute, producing it if not bound to the key

getEntityManager

public javax.persistence.EntityManager getEntityManager()

Returns the current EntityManager

getLastStoredFileContentAction

public StoredFileContentAction getLastStoredFileContentAction()

getTransactionLevel

public TransactionLevel getTransactionLevel()

getTransactionStatus

public TransactionStatus getTransactionStatus()

hasLock

public boolean hasLock(LockKey key)

Returns whether the current thread owns the given lock

hasWrite

public boolean hasWrite()

isEvicted

public boolean isEvicted(CacheType<?,?> type,
                         Serializable key)

Returns whether the given cache key has been evicted in this invocation

registerLock

public void registerLock(LockKey key)

Registers the given lock

releaseAfterTransaction

public void releaseAfterTransaction(boolean commit)

Releases any acquired resources. Must be invoked after the caller transaction has ended

releaseWithinTransaction

public void releaseWithinTransaction()

Releases resources which should be released while still within a transaction

releaseWithoutTransaction

public void releaseWithoutTransaction()

Releases those acquired resources when there is no transaction.

sessionData

public SessionData sessionData()

setAttribute

public void setAttribute(Object key,
                         Object value)

setEntityManager

public void setEntityManager(javax.persistence.EntityManager entityManager)

setLastStoredFileContentAction

public void setLastStoredFileContentAction(StoredFileContentAction lastContentAction)

setTransactionLevel

public void setTransactionLevel(TransactionLevel transactionLevel)

setTransactionStatus

public void setTransactionStatus(TransactionStatus transactionStatus)