org.mule.runtime.core.context.notification

Class MessageProcessingFlowTraceManager

java.lang.Object

org.mule.runtime.api.util.ComponentLocationProvider

org.mule.runtime.core.api.execution.LocationExecutionContextProvider

org.mule.runtime.core.context.notification.MessageProcessingFlowTraceManager

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, MuleContextAware, FlowTraceManager, ExceptionContextProvider

public class MessageProcessingFlowTraceManager
extends LocationExecutionContextProvider
implements FlowTraceManager, MuleContextAware, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Disposable

Manager for handling message processing troubleshooting data.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FLOW_STACK_INFO_KEY

Fields inherited from class org.mule.runtime.core.api.execution.LocationExecutionContextProvider

PASSWORD_ATTRIBUTE_MASK, SOURCE_ELEMENT_ANNOTATION_KEY

Fields inherited from class org.mule.runtime.api.util.ComponentLocationProvider

NAME_ANNOTATION_KEY, SOURCE_FILE_ANNOTATION_KEY, SOURCE_FILE_LINE_ANNOTATION_KEY

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
MessageProcessingFlowTraceManager()

Method Summary

Modifier and Type	Method and Description
void	dispose()
Map<String,Object>	getContextInfo(EnrichedNotificationInfo notificationInfo, Processor lastProcessed, FlowConstruct flowConstruct)
protected void	handleNotificationListeners()
void	initialise()
void	onFlowComplete(EnrichedNotificationInfo notificationInfo) Handles the completion of the current flow for the given event.
void	onFlowStart(EnrichedNotificationInfo notificationInfo, String flowName) Handles the start of the passed flowName for the given event.
void	onMessageProcessorNotificationPreInvoke(MessageProcessorNotification notification) Callback method for when a message processor is about to be invoked.
void	onPipelineNotificationComplete(PipelineMessageNotification notification) Callback method for when a flow or sub-flow called from a flow-ref component has been completed.
void	onPipelineNotificationStart(PipelineMessageNotification notification) Callback method for when a flow or sub-flow is about to be called from a flow-ref.
protected void	removeNotificationListeners()
void	setMuleContext(MuleContext context)

Methods inherited from class org.mule.runtime.core.api.execution.LocationExecutionContextProvider

addMetadataAnnotationsFromXml, getSourceXML, maskPasswords

Methods inherited from class org.mule.runtime.api.util.ComponentLocationProvider

getDocName, getSourceFile, getSourceFileLine, resolveProcessorRepresentation

Methods inherited from class java.lang.Object

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

Field Detail

FLOW_STACK_INFO_KEY

public static final String FLOW_STACK_INFO_KEY

See Also:

Constant Field Values

Constructor Detail

MessageProcessingFlowTraceManager

public MessageProcessingFlowTraceManager()

Method Detail

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

Parameters:

context - the Mule node.

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

handleNotificationListeners

protected void handleNotificationListeners()

removeNotificationListeners

protected void removeNotificationListeners()

onMessageProcessorNotificationPreInvoke

public void onMessageProcessorNotificationPreInvoke(MessageProcessorNotification notification)

Callback method for when a message processor is about to be invoked.

Updates the internal state of the event's ProcessorsTrace and FlowCallStack accordingly.

Parameters:

notification - the notification that contains the event and the processor that is about to be invoked.

See Also:

DefaultProcessorsTrace.addExecutedProcessors(String), DefaultFlowCallStack.setCurrentProcessorPath(String)

onPipelineNotificationComplete

public void onPipelineNotificationComplete(PipelineMessageNotification notification)

Callback method for when a flow or sub-flow called from a flow-ref component has been completed.

Parameters:

notification - the notification that contains the event and the processor that is about to be invoked.

onPipelineNotificationStart

public void onPipelineNotificationStart(PipelineMessageNotification notification)

Callback method for when a flow or sub-flow is about to be called from a flow-ref.

Parameters:

notification - the notification that contains the event and the processor that is about to be invoked.

onFlowStart

public void onFlowStart(EnrichedNotificationInfo notificationInfo,
                        String flowName)

Description copied from interface: FlowTraceManager

Handles the start of the passed flowName for the given event.

Specified by:

onFlowStart in interface FlowTraceManager

Parameters:

notificationInfo - the notification information about the event for which the flow is being started

flowName - the name of the flow that is about to start

onFlowComplete

public void onFlowComplete(EnrichedNotificationInfo notificationInfo)

Description copied from interface: FlowTraceManager

Handles the completion of the current flow for the given event.

Specified by:

onFlowComplete in interface FlowTraceManager

Parameters:

notificationInfo - the notification information about the event for which the flow is being completed

getContextInfo

public Map<String,Object> getContextInfo(EnrichedNotificationInfo notificationInfo,
                                         Processor lastProcessed,
                                         FlowConstruct flowConstruct)

Specified by:

getContextInfo in interface ExceptionContextProvider

Returns:

info entries to be added to the logged exception message