org.mule.runtime.core.exception

Class AbstractExceptionListener

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.core.processor.AbstractMuleObjectOwner<Processor>

org.mule.runtime.core.processor.AbstractMessageProcessorOwner

org.mule.runtime.core.exception.AbstractExceptionListener

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Lifecycle, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable, org.mule.runtime.api.meta.AnnotatedObject, FlowConstructAware, MuleContextAware, MessagingExceptionHandlerAware, GlobalNameableObject

Direct Known Subclasses:

AbstractMessagingExceptionStrategy, AbstractSystemExceptionStrategy, TemplateOnErrorHandler

public abstract class AbstractExceptionListener
extends AbstractMessageProcessorOwner
implements GlobalNameableObject

This is the base class for exception strategies which contains several helper methods. However, you should probably inherit from AbstractMessagingExceptionStrategy (if you are creating a Messaging Exception Strategy) or AbstractSystemExceptionStrategy (if you are creating a System Exception Strategy) rather than directly from this class.

Field Summary

Fields

Modifier and Type	Field and Description
protected WildcardFilter	commitTxFilter
protected boolean	enableNotifications
protected String	globalName
protected AtomicBoolean	initialised
protected String	logException
protected org.slf4j.Logger	logger
protected List<Processor>	messageProcessors
protected static String	NOT_SET
protected WildcardFilter	rollbackTxFilter

Fields inherited from class org.mule.runtime.core.processor.AbstractMuleObjectOwner

flowConstruct, messagingExceptionHandler, muleContext

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

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

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.meta.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractExceptionListener()

Method Summary

Modifier and Type	Method and Description
void	addEndpoint(Processor processor)
protected MulticastingRouter	buildRouter()
protected void	closeStream(org.mule.runtime.api.message.Message message)
protected void	commit()
protected void	doInitialise(MuleContext context)
protected void	doLogException(Throwable t)
protected void	fireNotification(Exception ex, Event event)
protected void	fireNotification(ServerNotification notification) Fires a server notification to all registered ExceptionNotificationListener eventManager.
WildcardFilter	getCommitTxFilter()
protected Throwable	getExceptionType(Throwable t, Class<? extends Throwable> exceptionType)
String	getGlobalName()
List<Processor>	getMessageProcessors()
protected List<Processor>	getOwnedMessageProcessors()
WildcardFilter	getRollbackTxFilter()
void	initialise() The initialise method is call every time the Exception stategy is assigned to a service or connector.
boolean	isEnableNotifications()
boolean	isInitialised()
String	isLogException() Determines whether the handled exception will be logged to its standard logger in the ERROR level before being handled.
protected boolean	isRollback(Throwable t)
protected void	logException(Throwable t, Event event) Used to log the error passed into this Exception Listener
protected void	logFatal(Event event, Throwable t) Logs a fatal error message to the logging system.
boolean	removeMessageProcessor(Processor processor)
protected void	rollback(Exception ex)
protected Event	routeException(Event event, FlowConstruct flowConstruct, Throwable t) Routes the current exception to an error endpoint such as a Dead Letter Queue (jms) This method is only invoked if there is a Message available to dispatch.
void	setCommitTxFilter(WildcardFilter commitTxFilter)
void	setEnableNotifications(boolean enableNotifications)
void	setGlobalName(String globalName)
void	setLogException(String logException)
void	setMessageProcessors(List<Processor> processors)
void	setMessagingExceptionHandler(MessagingExceptionHandler messagingExceptionHandler)
void	setRollbackTxFilter(WildcardFilter rollbackTxFilter)

Methods inherited from class org.mule.runtime.core.processor.AbstractMessageProcessorOwner

getOwnedObjects

Methods inherited from class org.mule.runtime.core.processor.AbstractMuleObjectOwner

dispose, getFlowConstruct, getMuleContext, setFlowConstruct, setMuleContext, start, stop

Methods inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.runtime.api.lifecycle.Startable

start

Methods inherited from interface org.mule.runtime.api.lifecycle.Stoppable

stop

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

dispose

Methods inherited from interface org.mule.runtime.core.api.context.MuleContextAware

setMuleContext

Methods inherited from interface org.mule.runtime.core.api.construct.FlowConstructAware

setFlowConstruct

Methods inherited from interface org.mule.runtime.api.meta.AnnotatedObject

getAnnotation, getAnnotations, getLocation, setAnnotations

Field Detail

NOT_SET

protected static final String NOT_SET

See Also:

Constant Field Values

logger

protected transient org.slf4j.Logger logger

messageProcessors

protected List<Processor> messageProcessors

initialised

protected AtomicBoolean initialised

rollbackTxFilter

protected WildcardFilter rollbackTxFilter

commitTxFilter

protected WildcardFilter commitTxFilter

enableNotifications

protected boolean enableNotifications

logException

protected String logException

globalName

protected String globalName

Constructor Detail

AbstractExceptionListener

public AbstractExceptionListener()

Method Detail

getGlobalName

public String getGlobalName()

Specified by:

getGlobalName in interface GlobalNameableObject

setGlobalName

public void setGlobalName(String globalName)

Specified by:

setGlobalName in interface GlobalNameableObject

isRollback

protected boolean isRollback(Throwable t)

getMessageProcessors

public List<Processor> getMessageProcessors()

setMessageProcessors

public void setMessageProcessors(List<Processor> processors)

addEndpoint

public void addEndpoint(Processor processor)

removeMessageProcessor

public boolean removeMessageProcessor(Processor processor)

getExceptionType

protected Throwable getExceptionType(Throwable t,
                                     Class<? extends Throwable> exceptionType)

initialise

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

The initialise method is call every time the Exception stategy is assigned to a service or connector. This implementation ensures that initialise is called only once. The actual initialisation code is contained in the doInitialise() method.

Specified by:

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

Overrides:

initialise in class AbstractMuleObjectOwner<Processor>

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

doInitialise

protected void doInitialise(MuleContext context)
                     throws org.mule.runtime.api.lifecycle.InitialisationException

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

fireNotification

protected void fireNotification(Exception ex,
                                Event event)

routeException

protected Event routeException(Event event,
                               FlowConstruct flowConstruct,
                               Throwable t)

Routes the current exception to an error endpoint such as a Dead Letter Queue (jms) This method is only invoked if there is a Message available to dispatch. The message dispatched from this method will be an ExceptionMessage which contains the exception thrown the Message and any context information.

Parameters:

event - the MuleEvent being processed when the exception occurred

flowConstruct - the flow that was processing the event when the exception occurred.

t - the exception thrown. This will be sent with the ExceptionMessage

See Also:

ExceptionMessage

buildRouter

protected MulticastingRouter buildRouter()

closeStream

protected void closeStream(org.mule.runtime.api.message.Message message)

logException

protected void logException(Throwable t,
                            Event event)

Used to log the error passed into this Exception Listener

Parameters:

t - the exception thrown

doLogException

protected void doLogException(Throwable t)

logFatal

protected void logFatal(Event event,
                        Throwable t)

Logs a fatal error message to the logging system. This should be used mostly if an error occurs in the exception listener itself. This implementation logs the the message itself to the logs if it is not null

Parameters:

event - The MuleEvent currently being processed

t - the fatal exception to log

isInitialised

public boolean isInitialised()

fireNotification

protected void fireNotification(ServerNotification notification)

Fires a server notification to all registered ExceptionNotificationListener eventManager.

Parameters:

notification - the notification to fire.

getCommitTxFilter

public WildcardFilter getCommitTxFilter()

setCommitTxFilter

public void setCommitTxFilter(WildcardFilter commitTxFilter)

isEnableNotifications

public boolean isEnableNotifications()

setEnableNotifications

public void setEnableNotifications(boolean enableNotifications)

isLogException

public String isLogException()

Determines whether the handled exception will be logged to its standard logger in the ERROR level before being handled.

setLogException

public void setLogException(String logException)

getRollbackTxFilter

public WildcardFilter getRollbackTxFilter()

setRollbackTxFilter

public void setRollbackTxFilter(WildcardFilter rollbackTxFilter)

getOwnedMessageProcessors

protected List<Processor> getOwnedMessageProcessors()

Specified by:

getOwnedMessageProcessors in class AbstractMessageProcessorOwner

setMessagingExceptionHandler

public void setMessagingExceptionHandler(MessagingExceptionHandler messagingExceptionHandler)

Specified by:

setMessagingExceptionHandler in interface MessagingExceptionHandlerAware

Overrides:

setMessagingExceptionHandler in class AbstractMuleObjectOwner<Processor>

commit

protected void commit()

rollback

protected void rollback(Exception ex)