org.mule.context.notification

Class MessageProcessingFlowTraceManager

java.lang.Object

org.mule.api.execution.LocationExecutionContextProvider

org.mule.context.notification.MessageProcessingFlowTraceManager

All Implemented Interfaces:

MuleContextAware, FlowTraceManager, ExceptionContextProvider, Disposable, Initialisable

public class MessageProcessingFlowTraceManager
extends LocationExecutionContextProvider
implements FlowTraceManager, MuleContextAware, Initialisable, 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 interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
MessageProcessingFlowTraceManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() A lifecycle method where implementor should free up any resources.
Map<String,Object>	getContextInfo(MuleEvent muleEvent, MessageProcessor lastProcessed)
protected void	handleNotificationListeners()
void	initialise() Method used to perform any initialisation work.
void	onFlowComplete(MuleEvent muleEvent) Handles the completion of the current flow for the given event.
void	onFlowStart(MuleEvent muleEvent, 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.api.execution.LocationExecutionContextProvider

addMetadataAnnotationsFromXml, getDocName, getSourceFile, getSourceFileLine, getSourceXML, 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

initialise

public void initialise()
                throws InitialisationException

Description copied from interface: Initialisable

Method used to perform any initialisation work. If a fatal error occurs during initialisation an InitialisationException should be thrown, causing the Mule instance to shutdown. If the error is recoverable, say by retrying to connect, a RecoverableException should be thrown. There is no guarantee that by throwing a Recoverable exception that the Mule instance will not shut down.

Specified by:

initialise in interface Initialisable

Throws:

InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

RecoverableException - if an error occurs that can be recovered from

dispose

public void dispose()

Description copied from interface: Disposable

A lifecycle method where implementor should free up any resources. If an exception is thrown it should just be logged and processing should continue. This method should not throw Runtime exceptions.

Specified by:

dispose in interface 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(MuleEvent muleEvent,
               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:

muleEvent - the event for which the flow is being started

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

onFlowComplete

public void onFlowComplete(MuleEvent muleEvent)

Description copied from interface: FlowTraceManager

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

Specified by:

onFlowComplete in interface FlowTraceManager

Parameters:

muleEvent - the event for which the flow is being completed

getContextInfo

public Map<String,Object> getContextInfo(MuleEvent muleEvent,
                                MessageProcessor lastProcessed)

Specified by:

getContextInfo in interface ExceptionContextProvider

Returns:

info entries to be added to the logged exception message