org.mule.runtime.core.exception

Class ErrorHandler

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

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

org.mule.runtime.core.exception.ErrorHandler

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

public class ErrorHandler
extends AbstractMuleObjectOwner<MessagingExceptionHandlerAcceptor>
implements MessagingExceptionHandlerAcceptor, MuleContextAware, org.mule.runtime.api.lifecycle.Lifecycle, GlobalNameableObject

Selects which "on error" handler to execute based on filtering. Replaces the choice-exception-strategy from Mule 3. On error handlers must implement MessagingExceptionHandlerAcceptor to be part of ErrorHandler.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected String	globalName

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
ErrorHandler()

Method Summary

Modifier and Type	Method and Description
boolean	accept(Event event)
boolean	acceptsAll()
org.reactivestreams.Publisher<Event>	apply(MessagingException exception)
List<MessagingExceptionHandlerAcceptor>	getExceptionListeners()
String	getGlobalName()
protected List<MessagingExceptionHandlerAcceptor>	getOwnedObjects()
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).
void	initialise()
void	setExceptionListeners(List<MessagingExceptionHandlerAcceptor> exceptionListeners)
void	setGlobalName(String globalName)

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

dispose, getFlowConstruct, getMuleContext, setFlowConstruct, setMessagingExceptionHandler, 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.core.api.context.MuleContextAware

setMuleContext

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

Field Detail

globalName

protected String globalName

Constructor Detail

ErrorHandler

public ErrorHandler()

Method Detail

getGlobalName

public String getGlobalName()

Specified by:

getGlobalName in interface GlobalNameableObject

setGlobalName

public void setGlobalName(String globalName)

Specified by:

setGlobalName in interface GlobalNameableObject

handleException

public 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

setExceptionListeners

public void setExceptionListeners(List<MessagingExceptionHandlerAcceptor> exceptionListeners)

getExceptionListeners

public List<MessagingExceptionHandlerAcceptor> getExceptionListeners()

initialise

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

Specified by:

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

Overrides:

initialise in class AbstractMuleObjectOwner<MessagingExceptionHandlerAcceptor>

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

getOwnedObjects

protected List<MessagingExceptionHandlerAcceptor> getOwnedObjects()

Specified by:

getOwnedObjects in class AbstractMuleObjectOwner<MessagingExceptionHandlerAcceptor>

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.