org.mule.runtime.core.routing.outbound

Class AbstractOutboundRouter

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.routing.outbound.AbstractOutboundRouter

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,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, FlowConstructAware, MuleContextAware, MessagingExceptionHandlerAware, MessageRouter, Processor, ReactiveProcessor, Matchable, MatchableMessageProcessor, MatchableMessageRouter, OutboundRouter, RouterStatisticsRecorder

Direct Known Subclasses:

FilteringOutboundRouter, FirstSuccessful, RoundRobin, UntilSuccessful

public abstract class AbstractOutboundRouter
extends AbstractMessageProcessorOwner
implements OutboundRouter

AbstractOutboundRouter is a base router class that tracks statistics about message processing through the router.

Nested Class Summary

Nested classes/interfaces inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

ReactiveProcessor.ProcessingType

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicBoolean	initialised
protected org.slf4j.Logger	logger logger used by this class
protected RouterResultsHandler	resultsHandler
protected List<Processor>	routes
protected AtomicBoolean	started
protected TransactionConfig	transactionConfig

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

Method Summary

Modifier and Type	Method and Description
void	addRoute(Processor route) Adds a new message processor to the list of routes
protected Event	createEventToRoute(Event routedEvent, org.mule.runtime.api.message.Message message) Create a new event to be routed to the target MP
void	dispose()
protected Event	doProcessRoute(Processor route, Event event)
MuleContext	getMuleContext()
protected List<Processor>	getOwnedMessageProcessors()
RouterResultsHandler	getResultsHandler()
RouterStatistics	getRouterStatistics()
List<Processor>	getRoutes() Gets a list of MessageProcessor instances associated with this router
TransactionConfig	getTransactionConfig()
void	initialise()
boolean	isDynamicRoutes() Determines whether this router supports dynamic route.
Event	process(Event event) Invokes the MessageProcessor.
void	removeRoute(Processor route) Removes a message processor from the list of routes
protected abstract Event	route(Event event)
protected Event	sendRequest(Event originalEvent, Event eventToRoute, Processor route, boolean awaitResponse)
protected Event	sendRequestEvent(Event originalEvent, Event eventToRoute, Processor route, boolean awaitResponse) Send message event to destination.
void	setFlowConstruct(FlowConstruct flowConstruct)
void	setMessageProcessors(List<Processor> routes) Deprecated.
void	setMuleContext(MuleContext context)
void	setResultsHandler(RouterResultsHandler resultsHandler)
void	setRouterStatistics(RouterStatistics stats)
void	setRoutes(List<Processor> routes)
void	setTransactionConfig(TransactionConfig transactionConfig)
void	start()
void	stop()

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

getOwnedObjects

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

getFlowConstruct, setMessagingExceptionHandler

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.core.api.routing.Matchable

isMatch

Methods inherited from interface org.mule.runtime.core.api.processor.Processor

apply

Methods inherited from interface org.mule.runtime.core.api.processor.ReactiveProcessor

getProcessingType

Methods inherited from interface java.util.function.Function

andThen, compose, identity

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

getAnnotation, getAnnotations, getLocation, setAnnotations

Field Detail

logger

protected transient org.slf4j.Logger logger

logger used by this class

routes

protected List<Processor> routes

transactionConfig

protected TransactionConfig transactionConfig

resultsHandler

protected RouterResultsHandler resultsHandler

initialised

protected AtomicBoolean initialised

started

protected AtomicBoolean started

Constructor Detail

AbstractOutboundRouter

public AbstractOutboundRouter()

Method Detail

process

public Event process(Event event)
              throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Processor

Invokes the MessageProcessor.

Specified by:

process in interface Processor

Parameters:

event - MuleEvent to be processed

Returns:

optional response MuleEvent

Throws:

org.mule.runtime.api.exception.MuleException

route

protected abstract Event route(Event event)
                        throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

sendRequest

protected final Event sendRequest(Event originalEvent,
                                  Event eventToRoute,
                                  Processor route,
                                  boolean awaitResponse)
                           throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

getRoutes

public List<Processor> getRoutes()

Description copied from interface: OutboundRouter

Gets a list of MessageProcessor instances associated with this router

Specified by:

getRoutes in interface OutboundRouter

Returns:

a list of MessageProcessor instances

setMessageProcessors

@Deprecated
public void setMessageProcessors(List<Processor> routes)
                                      throws org.mule.runtime.api.exception.MuleException

Deprecated.

Throws:

org.mule.runtime.api.exception.MuleException

setRoutes

public void setRoutes(List<Processor> routes)
               throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

addRoute

public void addRoute(Processor route)
              throws org.mule.runtime.api.exception.MuleException

Description copied from interface: MessageRouter

Adds a new message processor to the list of routes

Specified by:

addRoute in interface MessageRouter

Parameters:

route - new destination message processor

Throws:

org.mule.runtime.api.exception.MuleException

removeRoute

public void removeRoute(Processor route)
                 throws org.mule.runtime.api.exception.MuleException

Description copied from interface: MessageRouter

Removes a message processor from the list of routes

Specified by:

removeRoute in interface MessageRouter

Parameters:

route - destination message processor to remove

Throws:

org.mule.runtime.api.exception.MuleException

getTransactionConfig

public TransactionConfig getTransactionConfig()

setTransactionConfig

public void setTransactionConfig(TransactionConfig transactionConfig)

Specified by:

setTransactionConfig in interface OutboundRouter

isDynamicRoutes

public boolean isDynamicRoutes()

Description copied from interface: OutboundRouter

Determines whether this router supports dynamic route. i.e. routes that are not configured at design time. routes might be pulled from the message or payload.

Specified by:

isDynamicRoutes in interface OutboundRouter

getResultsHandler

public RouterResultsHandler getResultsHandler()

setResultsHandler

public void setResultsHandler(RouterResultsHandler resultsHandler)

sendRequestEvent

protected Event sendRequestEvent(Event originalEvent,
                                 Event eventToRoute,
                                 Processor route,
                                 boolean awaitResponse)
                          throws org.mule.runtime.api.exception.MuleException

Send message event to destination.

Throws:

org.mule.runtime.api.exception.MuleException

doProcessRoute

protected Event doProcessRoute(Processor route,
                               Event event)
                        throws org.mule.runtime.api.exception.MuleException,
                               MessagingException

Throws:

org.mule.runtime.api.exception.MuleException

MessagingException

createEventToRoute

protected Event createEventToRoute(Event routedEvent,
                                   org.mule.runtime.api.message.Message message)

Create a new event to be routed to the target MP

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<Processor>

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

dispose

public void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable

Overrides:

dispose in class AbstractMuleObjectOwner<Processor>

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Overrides:

start in class AbstractMuleObjectOwner<Processor>

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Overrides:

stop in class AbstractMuleObjectOwner<Processor>

Throws:

org.mule.runtime.api.exception.MuleException

getMuleContext

public MuleContext getMuleContext()

Overrides:

getMuleContext in class AbstractMuleObjectOwner<Processor>

setRouterStatistics

public void setRouterStatistics(RouterStatistics stats)

Specified by:

setRouterStatistics in interface RouterStatisticsRecorder

getRouterStatistics

public RouterStatistics getRouterStatistics()

getOwnedMessageProcessors

protected List<Processor> getOwnedMessageProcessors()

Specified by:

getOwnedMessageProcessors in class AbstractMessageProcessorOwner

setMuleContext

public void setMuleContext(MuleContext context)

Specified by:

setMuleContext in interface MuleContextAware

Overrides:

setMuleContext in class AbstractMuleObjectOwner<Processor>

Parameters:

context - the Mule node.

setFlowConstruct

public void setFlowConstruct(FlowConstruct flowConstruct)

Specified by:

setFlowConstruct in interface FlowConstructAware

Overrides:

setFlowConstruct in class AbstractMuleObjectOwner<Processor>