org.camunda.bpm.engine.impl.interceptor

Class ProcessDataLoggingContext

java.lang.Object

org.camunda.bpm.engine.impl.interceptor.ProcessDataLoggingContext

public class ProcessDataLoggingContext
extends Object

Holds the contextual process data used in logging.
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 is only pushed to the logging context 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

Constructor Summary

Constructors

Constructor and Description
ProcessDataLoggingContext(ProcessEngineConfigurationImpl configuration)

Method Summary

Modifier and Type	Method and Description
protected void	addToCurrentSection(String property)
protected void	addToStack(String value, String property, boolean addToMdc)
protected void	addToStackAndMdc(String value, String property)
void	clearMdc() Remove all logging context properties from the MDC
void	fetchCurrentContext() Preserve the current MDC values and store them in the logging context
protected Deque<String>	getDeque(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 update the MDC accordingly
boolean	pushSection(ExecutionEntity execution) Start a new section that keeps track of the pushed properties and update the MDC.
protected void	removeFromStackAndUpdateMdc(String property)
void	update() 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

Constructor Detail

ProcessDataLoggingContext

public ProcessDataLoggingContext(ProcessEngineConfigurationImpl configuration)

Method Detail

pushSection

public boolean pushSection(ExecutionEntity execution)

Start a new section that keeps track of the pushed properties and update the MDC. 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 logging context data from

Returns:

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

popSection

public void popSection()

Pop the latest section, remove all pushed properties of that section and update the MDC accordingly

clearMdc

public void clearMdc()

Remove all logging context properties from the MDC

update

public void update()

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 logging context

addToStackAndMdc

protected void addToStackAndMdc(String value,
                                String property)

addToStack

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

removeFromStackAndUpdateMdc

protected void removeFromStackAndUpdateMdc(String property)

getDeque

protected Deque<String> getDeque(String property)

addToCurrentSection

protected void addToCurrentSection(String property)

updateMdc

protected void updateMdc(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)