org.flowable.common.engine.impl.interceptor

Class CommandContext

java.lang.Object

org.flowable.common.engine.impl.interceptor.CommandContext

public class CommandContext
extends Object

Author:

Tom Baeyens, Agim Emruli, Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	attributes
protected ClassLoader	classLoader
protected Clock	clock
protected List<CommandContextCloseListener>	closeListeners
protected Command<?>	command
protected CommandExecutor	commandExecutor
protected LinkedList<String>	engineCfgStack
protected Map<String,AbstractEngineConfiguration>	engineConfigurations
protected Throwable	exception
protected com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected LinkedList<Object>	resultStack
protected boolean	reused
protected Map<Class<?>,SessionFactory>	sessionFactories
protected Map<Class<?>,Session>	sessions
protected boolean	useClassForNameClassLoading

Constructor Summary

Constructors

Constructor and Description
CommandContext(Command<?> command)

Method Summary

Modifier and Type	Method and Description
void	addAttribute(String key, Object value)
void	addCloseListener(CommandContextCloseListener commandContextCloseListener)
void	addEngineConfiguration(String engineKey, String scopeType, AbstractEngineConfiguration engineConfiguration)
void	close()
protected void	closeSessions()
void	exception(Throwable exception) Stores the provided exception on this CommandContext instance.
protected void	executeCloseListenersAfterSessionFlushed()
protected void	executeCloseListenersClosed()
protected void	executeCloseListenersCloseFailure()
protected void	executeCloseListenersClosing()
protected void	flushSessions()
Object	getAttribute(String key)
ClassLoader	getClassLoader()
Clock	getClock()
List<CommandContextCloseListener>	getCloseListeners()
Command<?>	getCommand()
CommandExecutor	getCommandExecutor()
Map<String,AbstractEngineConfiguration>	getEngineConfigurations()
Throwable	getException()
com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Object	getResult()
<T> T	getSession(Class<T> sessionClass)
Map<Class<?>,SessionFactory>	getSessionFactories()
Map<Class<?>,Session>	getSessions()
boolean	isReused()
boolean	isRootUsageOfCurrentEngine()
boolean	isUseClassForNameClassLoading()
protected void	logException()
String	popEngineCfgStack()
void	pushEngineCfgToStack(String engineCfgKey)
void	removeAttribute(String key)
void	resetException()
protected void	rethrowExceptionIfNeeded()
void	setClassLoader(ClassLoader classLoader)
void	setClock(Clock clock)
void	setCommandExecutor(CommandExecutor commandExecutor)
void	setEngineConfigurations(Map<String,AbstractEngineConfiguration> engineConfigurations)
void	setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
void	setResult(Object result)
void	setReused(boolean reused)
void	setSessionFactories(Map<Class<?>,SessionFactory> sessionFactories)
void	setUseClassForNameClassLoading(boolean useClassForNameClassLoading)

Methods inherited from class java.lang.Object

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

Field Detail

engineConfigurations

protected Map<String,AbstractEngineConfiguration> engineConfigurations

engineCfgStack

protected LinkedList<String> engineCfgStack

command

protected Command<?> command

sessionFactories

protected Map<Class<?>,SessionFactory> sessionFactories

sessions

protected Map<Class<?>,Session> sessions

exception

protected Throwable exception

closeListeners

protected List<CommandContextCloseListener> closeListeners

attributes

protected Map<String,Object> attributes

reused

protected boolean reused

resultStack

protected LinkedList<Object> resultStack

commandExecutor

protected CommandExecutor commandExecutor

classLoader

protected ClassLoader classLoader

useClassForNameClassLoading

protected boolean useClassForNameClassLoading

clock

protected Clock clock

objectMapper

protected com.fasterxml.jackson.databind.ObjectMapper objectMapper

Constructor Detail

CommandContext

public CommandContext(Command<?> command)

Method Detail

close

public void close()

logException

protected void logException()

rethrowExceptionIfNeeded

protected void rethrowExceptionIfNeeded()
                                 throws Error

Throws:

Error

addCloseListener

public void addCloseListener(CommandContextCloseListener commandContextCloseListener)

getCloseListeners

public List<CommandContextCloseListener> getCloseListeners()

executeCloseListenersClosing

protected void executeCloseListenersClosing()

executeCloseListenersAfterSessionFlushed

protected void executeCloseListenersAfterSessionFlushed()

executeCloseListenersClosed

protected void executeCloseListenersClosed()

executeCloseListenersCloseFailure

protected void executeCloseListenersCloseFailure()

flushSessions

protected void flushSessions()

closeSessions

protected void closeSessions()

exception

public void exception(Throwable exception)

Stores the provided exception on this CommandContext instance. That exception will be rethrown at the end of closing the CommandContext instance. If there is already an exception being stored, a 'masked exception' message will be logged.

resetException

public void resetException()

addAttribute

public void addAttribute(String key,
                         Object value)

getAttribute

public Object getAttribute(String key)

removeAttribute

public void removeAttribute(String key)

getSession

public <T> T getSession(Class<T> sessionClass)

getSessionFactories

public Map<Class<?>,SessionFactory> getSessionFactories()

setSessionFactories

public void setSessionFactories(Map<Class<?>,SessionFactory> sessionFactories)

getEngineConfigurations

public Map<String,AbstractEngineConfiguration> getEngineConfigurations()

setEngineConfigurations

public void setEngineConfigurations(Map<String,AbstractEngineConfiguration> engineConfigurations)

pushEngineCfgToStack

public void pushEngineCfgToStack(String engineCfgKey)

popEngineCfgStack

public String popEngineCfgStack()

isRootUsageOfCurrentEngine

public boolean isRootUsageOfCurrentEngine()

Returns:

Returns whether (at the time of calling this method) the current engine is being executed as the 'root engine'. Or said differently: this will return false when the current engine is being used in a nested Command execution call and will return true if it is the root usage of the current engine. For example: CMMN engine executes process task, that in its turn calls a CMMN task. The hierarchy of engine will be CMMN (a) - BPMN (b) - CMMN (c). If this method is called in the context of (c), false is returned. In the context of (a), true will be returned. For (b), there is but one usage and it will be true.

addEngineConfiguration

public void addEngineConfiguration(String engineKey,
                                   String scopeType,
                                   AbstractEngineConfiguration engineConfiguration)

getCommandExecutor

public CommandExecutor getCommandExecutor()

setCommandExecutor

public void setCommandExecutor(CommandExecutor commandExecutor)

getClassLoader

public ClassLoader getClassLoader()

setClassLoader

public void setClassLoader(ClassLoader classLoader)

isUseClassForNameClassLoading

public boolean isUseClassForNameClassLoading()

setUseClassForNameClassLoading

public void setUseClassForNameClassLoading(boolean useClassForNameClassLoading)

getClock

public Clock getClock()

setClock

public void setClock(Clock clock)

getObjectMapper

public com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()

setObjectMapper

public void setObjectMapper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

getCommand

public Command<?> getCommand()

getSessions

public Map<Class<?>,Session> getSessions()

getException

public Throwable getException()

isReused

public boolean isReused()

setReused

public void setReused(boolean reused)

getResult

public Object getResult()

setResult

public void setResult(Object result)