org.mule.runtime.core.exception

Class TemplateOnErrorHandler

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

org.mule.runtime.core.exception.TemplateOnErrorHandler

All Implemented Interfaces:

Function<MessagingException,org.reactivestreams.Publisher<Event>>, 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, Acceptor, FlowConstructAware, MuleContextAware, ExceptionHandler, MessagingExceptionHandler, MessagingExceptionHandlerAcceptor, MessagingExceptionHandlerAware, GlobalNameableObject

Direct Known Subclasses:

OnErrorContinueHandler, OnErrorPropagateHandler

public abstract class TemplateOnErrorHandler
extends AbstractExceptionListener
implements MessagingExceptionHandlerAcceptor

Field Summary

Fields inherited from class org.mule.runtime.core.exception.AbstractExceptionListener

commitTxFilter, enableNotifications, globalName, initialised, logException, logger, messageProcessors, NOT_SET, 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
TemplateOnErrorHandler()

Method Summary

Modifier and Type	Method and Description
boolean	accept(Event event)
boolean	acceptsAll()
protected Event	afterRouting(MessagingException exception, Event event)
org.reactivestreams.Publisher<Event>	apply(MessagingException exception)
protected Event	beforeRouting(MessagingException exception, Event event)
protected void	doInitialise(MuleContext muleContext)
protected List<Processor>	getOwnedMessageProcessors()
Event	handleException(MessagingException exception, Event event) Take some action when a messaging exception has occurred (i.e., there was a message in play when the exception occurred).
protected void	markExceptionAsHandled(Exception exception)
protected Event	nullifyExceptionPayloadIfRequired(Event event)
protected Event	processReplyTo(Event event, Exception e)
protected org.reactivestreams.Publisher<Event>	routeAsync(Event event, MessagingException t)
void	setErrorType(String errorType)
void	setHandleException(boolean handleException)
void	setMessageProcessors(List<Processor> processors)
void	setMessagingExceptionHandler(MessagingExceptionHandler messagingExceptionHandler)
void	setWhen(String when)

Methods inherited from class org.mule.runtime.core.exception.AbstractExceptionListener

addEndpoint, buildRouter, closeStream, commit, doLogException, fireNotification, fireNotification, getCommitTxFilter, getExceptionType, getGlobalName, getMessageProcessors, getRollbackTxFilter, initialise, isEnableNotifications, isInitialised, isLogException, isRollback, logException, logFatal, removeMessageProcessor, rollback, routeException, setCommitTxFilter, setEnableNotifications, setGlobalName, setLogException, setRollbackTxFilter

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 java.util.function.Function

andThen, compose, identity

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

Constructor Detail

TemplateOnErrorHandler

public TemplateOnErrorHandler()

Method Detail

handleException

public final Event handleException(MessagingException exception,
                                   Event event)

Description copied from interface: MessagingExceptionHandler

Take some action when a messaging exception has occurred (i.e., there was a message in play when the exception occurred).

Specified by:

handleException in interface MessagingExceptionHandler

Parameters:

exception - which occurred

event - which was being processed when the exception occurred

Returns:

new event to route on to the rest of the flow, generally with ExceptionPayload set on the message

apply

public org.reactivestreams.Publisher<Event> apply(MessagingException exception)

Specified by:

apply in interface Function<MessagingException,org.reactivestreams.Publisher<Event>>

Specified by:

apply in interface MessagingExceptionHandler

setMessageProcessors

public void setMessageProcessors(List<Processor> processors)

Overrides:

setMessageProcessors in class AbstractExceptionListener

getOwnedMessageProcessors

protected List<Processor> getOwnedMessageProcessors()

Overrides:

getOwnedMessageProcessors in class AbstractExceptionListener

markExceptionAsHandled

protected void markExceptionAsHandled(Exception exception)

processReplyTo

protected Event processReplyTo(Event event,
                               Exception e)

nullifyExceptionPayloadIfRequired

protected Event nullifyExceptionPayloadIfRequired(Event event)

routeAsync

protected org.reactivestreams.Publisher<Event> routeAsync(Event event,
                                                          MessagingException t)

doInitialise

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

Overrides:

doInitialise in class AbstractExceptionListener

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

setWhen

public void setWhen(String when)

accept

public boolean accept(Event event)

Specified by:

accept in interface Acceptor

Parameters:

event - Event to route through exception handler

Returns:

true if this MessagingExceptionHandler should handler exception false otherwise

acceptsAll

public boolean acceptsAll()

Specified by:

acceptsAll in interface Acceptor

Returns:

true if accepts any message, false otherwise.

afterRouting

protected Event afterRouting(MessagingException exception,
                             Event event)

beforeRouting

protected Event beforeRouting(MessagingException exception,
                              Event event)

setMessagingExceptionHandler

public void setMessagingExceptionHandler(MessagingExceptionHandler messagingExceptionHandler)

Specified by:

setMessagingExceptionHandler in interface MessagingExceptionHandlerAware

Overrides:

setMessagingExceptionHandler in class AbstractExceptionListener

setHandleException

public void setHandleException(boolean handleException)

setErrorType

public void setErrorType(String errorType)