org.mule.runtime.core.routing.outbound

Class FilteringOutboundRouter

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

org.mule.runtime.core.routing.outbound.FilteringOutboundRouter

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, TransformingMatchable

Direct Known Subclasses:

AbstractSequenceRouter

public class FilteringOutboundRouter
extends AbstractOutboundRouter
implements TransformingMatchable

FilteringRouter is a router that accepts events based on a filter set.

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 org.mule.runtime.api.el.MuleExpressionLanguage	expressionManager
protected TemplateParser	parser

Fields inherited from class org.mule.runtime.core.routing.outbound.AbstractOutboundRouter

initialised, logger, resultsHandler, routes, started, 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
FilteringOutboundRouter()

Method Summary

Modifier and Type	Method and Description
Filter	getFilter()
Processor	getRoute(int index, Event event) Will Return the target at the given index and will resolve any template tags on the Endpoint URI if necessary
protected Processor	getTemplateRoute(int index, Event event)
List<Transformer>	getTransformers()
void	initialise()
boolean	isMatch(Event event, Event.Builder builder) Determines if the event should be processed
boolean	isTransformBeforeMatch()
boolean	isUseTemplates()
Event	route(Event event)
void	setFilter(Filter filter)
void	setTransformers(List<Transformer> transformers)
void	setUseTemplates(boolean useTemplates)

Methods inherited from class org.mule.runtime.core.routing.outbound.AbstractOutboundRouter

addRoute, createEventToRoute, dispose, doProcessRoute, getMuleContext, getOwnedMessageProcessors, getResultsHandler, getRouterStatistics, getRoutes, getTransactionConfig, isDynamicRoutes, process, removeRoute, sendRequest, sendRequestEvent, setFlowConstruct, setMessageProcessors, setMuleContext, setResultsHandler, setRouterStatistics, setRoutes, setTransactionConfig, start, 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.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

expressionManager

protected org.mule.runtime.api.el.MuleExpressionLanguage expressionManager

parser

protected TemplateParser parser

Constructor Detail

FilteringOutboundRouter

public FilteringOutboundRouter()

Method Detail

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 AbstractOutboundRouter

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

route

public Event route(Event event)
            throws RoutingException

Specified by:

route in class AbstractOutboundRouter

Throws:

RoutingException

getFilter

public Filter getFilter()

setFilter

public void setFilter(Filter filter)

isMatch

public boolean isMatch(Event event,
                       Event.Builder builder)
                throws org.mule.runtime.api.exception.MuleException

Description copied from interface: Matchable

Determines if the event should be processed

Specified by:

isMatch in interface Matchable

Parameters:

event - the current event to evaluate

builder - an event builder in case the filter needs to make changes to the event.

Returns:

true if the event should be processed by this router

Throws:

org.mule.runtime.api.exception.MuleException - if the event cannot be evaluated

getTransformers

public List<Transformer> getTransformers()

setTransformers

public void setTransformers(List<Transformer> transformers)

getRoute

public Processor getRoute(int index,
                          Event event)
                   throws CouldNotRouteOutboundMessageException

Will Return the target at the given index and will resolve any template tags on the Endpoint URI if necessary

Parameters:

index - the index of the endpoint to get

event - the current event. This is required if template matching is being used

Returns:

the endpoint at the index, with any template tags resolved

Throws:

CouldNotRouteOutboundMessageException - if the template causs the endpoint to become illegal or malformed

getTemplateRoute

protected Processor getTemplateRoute(int index,
                                     Event event)
                              throws CouldNotRouteOutboundMessageException

Throws:

CouldNotRouteOutboundMessageException

isUseTemplates

public boolean isUseTemplates()

setUseTemplates

public void setUseTemplates(boolean useTemplates)

isTransformBeforeMatch

public boolean isTransformBeforeMatch()

Specified by:

isTransformBeforeMatch in interface TransformingMatchable