org.mule.runtime.core.exception

Class MessagingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.mule.runtime.api.exception.MuleException

org.mule.runtime.core.exception.MessagingException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FlowExecutionException, MessageRedeliveredException

public class MessagingException
extends org.mule.runtime.api.exception.MuleException

MessagingException is a general message exception thrown when errors specific to Message processing occur..

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Event	event The MuleEvent being processed when the error occurred
protected org.mule.runtime.api.message.Message	muleMessage The Message being processed when the error occurred
static String	PAYLOAD_INFO_KEY
static String	PAYLOAD_TYPE_INFO_KEY
protected Event	processedEvent

Fields inherited from class org.mule.runtime.api.exception.MuleException

INFO_LOCATION_KEY, INFO_SOURCE_XML_KEY, verboseExceptions

Constructor Summary

Constructors

Constructor and Description
MessagingException(Event event, MessagingException original)
MessagingException(Event event, Throwable cause)
MessagingException(Event event, Throwable cause, Processor failingMessageProcessor)
MessagingException(org.mule.runtime.api.i18n.I18nMessage message, Event event)
MessagingException(org.mule.runtime.api.i18n.I18nMessage message, Event event, Processor failingMessageProcessor)
MessagingException(org.mule.runtime.api.i18n.I18nMessage message, Event event, Throwable cause)
MessagingException(org.mule.runtime.api.i18n.I18nMessage message, Event event, Throwable cause, Processor failingMessageProcessor)
MessagingException(org.mule.runtime.api.i18n.I18nMessage message, org.mule.runtime.api.message.Message muleMessage, MuleContext context) Deprecated. use MessagingException(Message, MuleEvent)
MessagingException(org.mule.runtime.api.i18n.I18nMessage message, org.mule.runtime.api.message.Message muleMessage, MuleContext context, Throwable cause) Deprecated. use MessagingException(Message, MuleEvent, Throwable)

Method Summary

Modifier and Type	Method and Description
boolean	causedBy(Class e) Evaluates if the exception was caused (instance of) by the provided exception type
boolean	causedExactlyBy(Class e) Evaluates if the exception was caused by the type and only the type provided exception type i,e: if cause exception is NullPointerException will only return true if provided exception type is NullPointerException
boolean	causedRollback() Signals if the exception cause rollback of any current transaction if any or if the message source should rollback incoming message
boolean	causeMatches(String regex) Checks the cause exception type name matches the provided regex.
protected void	extractMuleMessage(Event event)
protected String	generateMessage(org.mule.runtime.api.i18n.I18nMessage message, MuleContext muleContext)
Event	getEvent()
Processor	getFailingMessageProcessor()
org.mule.runtime.api.message.Message	getMuleMessage() Deprecated. use #getEvent().getMessage() instead
Throwable	getRootCause()
boolean	handled() Signals if exception has been handled or not
boolean	inErrorHandler() Signals if the exception occurred in an error handler
void	setCauseRollback(boolean causeRollback) Marks exception as rollback cause.
void	setHandled(boolean handled) Marks an exception as handled so it won't be re-throwed
void	setInErrorHandler(boolean inErrorHandler) Marks the exception so that onTerminate is called on the source instead of onError if not handled
void	setProcessedEvent(Event processedEvent) Sets the event that should be processed once this exception is caught

Methods inherited from class org.mule.runtime.api.exception.MuleException

addInfo, appendMessage, appendSummaryMessage, equals, getDetailedMessage, getExceptionCode, getI18nMessage, getInfo, getMessage, getMessageCode, getSummaryMessage, getVerboseMessage, hashCode, initialise, isVerboseExceptions, prependMessage, setExceptionCode, setMessage, setMessage

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PAYLOAD_INFO_KEY

public static final String PAYLOAD_INFO_KEY

See Also:

Constant Field Values

PAYLOAD_TYPE_INFO_KEY

public static final String PAYLOAD_TYPE_INFO_KEY

See Also:

Constant Field Values

muleMessage

protected transient org.mule.runtime.api.message.Message muleMessage

The Message being processed when the error occurred

event

protected final transient Event event

The MuleEvent being processed when the error occurred

processedEvent

protected transient Event processedEvent

Constructor Detail

MessagingException

@Deprecated
public MessagingException(org.mule.runtime.api.i18n.I18nMessage message,
                                      org.mule.runtime.api.message.Message muleMessage,
                                      MuleContext context)

Deprecated. use MessagingException(Message, MuleEvent)

MessagingException

public MessagingException(org.mule.runtime.api.i18n.I18nMessage message,
                          Event event)

MessagingException

public MessagingException(org.mule.runtime.api.i18n.I18nMessage message,
                          Event event,
                          Processor failingMessageProcessor)

MessagingException

@Deprecated
public MessagingException(org.mule.runtime.api.i18n.I18nMessage message,
                                      org.mule.runtime.api.message.Message muleMessage,
                                      MuleContext context,
                                      Throwable cause)

Deprecated. use MessagingException(Message, MuleEvent, Throwable)

MessagingException

public MessagingException(org.mule.runtime.api.i18n.I18nMessage message,
                          Event event,
                          Throwable cause)

MessagingException

public MessagingException(org.mule.runtime.api.i18n.I18nMessage message,
                          Event event,
                          Throwable cause,
                          Processor failingMessageProcessor)

MessagingException

public MessagingException(Event event,
                          Throwable cause)

MessagingException

public MessagingException(Event event,
                          MessagingException original)

MessagingException

public MessagingException(Event event,
                          Throwable cause,
                          Processor failingMessageProcessor)

Method Detail

generateMessage

protected String generateMessage(org.mule.runtime.api.i18n.I18nMessage message,
                                 MuleContext muleContext)

getMuleMessage

@Deprecated
public org.mule.runtime.api.message.Message getMuleMessage()

Deprecated. use #getEvent().getMessage() instead

getEvent

public Event getEvent()

Returns:

event associated with the exception

setProcessedEvent

public void setProcessedEvent(Event processedEvent)

Sets the event that should be processed once this exception is caught

Parameters:

processedEvent - event bounded to the exception

causedBy

public boolean causedBy(Class e)

Evaluates if the exception was caused (instance of) by the provided exception type

Parameters:

e - exception type to check against

Returns:

true if the cause exception is an instance of the provided exception type

causedExactlyBy

public boolean causedExactlyBy(Class e)

Evaluates if the exception was caused by the type and only the type provided exception type i,e: if cause exception is NullPointerException will only return true if provided exception type is NullPointerException

Parameters:

e - exception type to check against

Returns:

true if the cause exception is exaclty the provided exception type

getRootCause

public Throwable getRootCause()

Returns:

the exception thrown by the failing message processor

causeMatches

public boolean causeMatches(String regex)

Checks the cause exception type name matches the provided regex. Supports any java regex plus *, * prefix, * sufix

Parameters:

regex - regular expression to match against the exception type name

Returns:

true if the exception matches the regex, false otherwise

causedRollback

public boolean causedRollback()

Signals if the exception cause rollback of any current transaction if any or if the message source should rollback incoming message

Returns:

true if exception cause rollback, false otherwise

setCauseRollback

public void setCauseRollback(boolean causeRollback)

Marks exception as rollback cause. Useful for message sources that can provide some rollback mechanism.

Parameters:

causeRollback -

setHandled

public void setHandled(boolean handled)

Marks an exception as handled so it won't be re-throwed

Parameters:

handled - true if the exception must be mark as handled, false otherwise

handled

public boolean handled()

Signals if exception has been handled or not

Returns:

true if exception has been handled, false otherwise

setInErrorHandler

public void setInErrorHandler(boolean inErrorHandler)

Marks the exception so that onTerminate is called on the source instead of onError if not handled

Parameters:

inErrorHandler - true if the exception has occurred in an error handler, false otherwise

inErrorHandler

public boolean inErrorHandler()

Signals if the exception occurred in an error handler

Returns:

true if happened inside error handler

getFailingMessageProcessor

public Processor getFailingMessageProcessor()

Returns:

MessageProcessor that causes the failure

extractMuleMessage

protected void extractMuleMessage(Event event)