org.camunda.bpm.engine.impl.interceptor

Class ProcessDataContext

java.lang.Object

org.camunda.bpm.engine.impl.interceptor.ProcessDataContext

public class ProcessDataContext
extends Object

Holds the contextual process data.
New context properties are always part of a section that can be started by pushSection(ExecutionEntity). The section keeps track of all pushed properties. Those can easily be cleared by popping the section with popSection() afterwards, e.g. after the successful execution.
A property can be pushed to the logging context (MDC) if there is a configured non-empty context name for it in the process engine configuration. The following configuration options are available:

• loggingContextActivityId - the context property for the activity id
• loggingContextApplicationName - the context property for the application name
• loggingContextBusinessKey - the context property for the business key
• loggingContextDefinitionId - the context property for the definition id
• loggingContextProcessInstanceId - the context property for the instance id
• loggingContextTenantId - the context property for the tenant id

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	basicToMdcPropertyNames
protected boolean	handleMdc
protected String	mdcPropertyActivityId
protected String	mdcPropertyApplicationName
protected String	mdcPropertyBusinessKey
protected String	mdcPropertyDefinitionId
protected String	mdcPropertyInstanceId
protected List<String>	mdcPropertyNames
protected String	mdcPropertyTenantId
protected static String	NULL_VALUE
static String	PROPERTY_ACTIVITY_ID
protected Map<String,Deque<String>>	propertyValues
protected Deque<List<String>>	sections
protected boolean	startNewSection

Constructor Summary

Constructors

Constructor and Description
ProcessDataContext(ProcessEngineConfigurationImpl configuration)

Method Summary

Modifier and Type	Method and Description
protected void	addToCurrentSection(String property)
protected void	addToStack(String value, String property)
protected void	addToStack(String value, String property, boolean updateMdc)
void	clearMdc() Remove all logging context properties from the MDC
void	fetchCurrentContext() Preserve the current MDC values and store them in the context
protected Deque<String>	getDeque(String property)
String	getLatestPropertyValue(String property)
protected String	getMdcProperty(String property)
protected static boolean	isNotBlank(String property)
protected static boolean	isNull(String value)
void	popSection() Pop the latest section, remove all pushed properties of that section and - if logging context properties are defined - update the MDC accordingly.
boolean	pushSection(ExecutionEntity execution) Start a new section that keeps track of the pushed properties.
protected void	removeFromStack(String property)
void	updateMdc() Update the MDC with the current values of this logging context
protected void	updateMdc(String property)
protected static boolean	valuesEqual(String val1, String val2)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_ACTIVITY_ID

public static final String PROPERTY_ACTIVITY_ID

See Also:

Constant Field Values

NULL_VALUE

protected static final String NULL_VALUE

See Also:

Constant Field Values

mdcPropertyActivityId

protected String mdcPropertyActivityId

mdcPropertyApplicationName

protected String mdcPropertyApplicationName

mdcPropertyBusinessKey

protected String mdcPropertyBusinessKey

mdcPropertyDefinitionId

protected String mdcPropertyDefinitionId

mdcPropertyInstanceId

protected String mdcPropertyInstanceId

mdcPropertyTenantId

protected String mdcPropertyTenantId

mdcPropertyNames

protected List<String> mdcPropertyNames

basicToMdcPropertyNames

protected Map<String,String> basicToMdcPropertyNames

handleMdc

protected boolean handleMdc

propertyValues

protected Map<String,Deque<String>> propertyValues

startNewSection

protected boolean startNewSection

sections

protected Deque<List<String>> sections

Constructor Detail

ProcessDataContext

public ProcessDataContext(ProcessEngineConfigurationImpl configuration)

Method Detail

pushSection

public boolean pushSection(ExecutionEntity execution)

Start a new section that keeps track of the pushed properties. If logging context properties are defined, the MDC is updated as well. This also includes clearing the MDC for the first section that is pushed for the logging context so that only the current properties will be present in the MDC (might be less than previously present in the MDC). The previous logging context needs to be reset in the MDC when this one is closed. This can be achieved by using updateMdc(String) with the previous logging context.

Parameters:

execution - the execution to retrieve the context data from

Returns:

true if the section contains any updates and therefore should be popped later by popSection()

popSection

public void popSection()

Pop the latest section, remove all pushed properties of that section and - if logging context properties are defined - update the MDC accordingly.

clearMdc

public void clearMdc()

Remove all logging context properties from the MDC

updateMdc

public void updateMdc()

Update the MDC with the current values of this logging context

fetchCurrentContext

public void fetchCurrentContext()

Preserve the current MDC values and store them in the context

getLatestPropertyValue

public String getLatestPropertyValue(String property)

Parameters:

property - the property to retrieve the latest value for

Returns:

the latest value of the property if there is one, null otherwise

addToStack

protected void addToStack(String value,
                          String property)

addToStack

protected void addToStack(String value,
                          String property,
                          boolean updateMdc)

removeFromStack

protected void removeFromStack(String property)

getDeque

protected Deque<String> getDeque(String property)

addToCurrentSection

protected void addToCurrentSection(String property)

updateMdc

protected void updateMdc(String property)

getMdcProperty

protected String getMdcProperty(String property)

isNotBlank

protected static boolean isNotBlank(String property)

valuesEqual

protected static boolean valuesEqual(String val1,
                                     String val2)

isNull

protected static boolean isNull(String value)