org.mule.runtime.core.routing

Class ScatterGatherRouter

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.ScatterGatherRouter

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

public class ScatterGatherRouter
extends AbstractMessageProcessorOwner
implements MessageRouter

The Scatter-Gather router will broadcast copies of the current message to every endpoint registered with the router in parallel.

It is very similar to the <all> implemented in the MulticastingRouter class, except that this router processes in parallel instead of sequentially.

Differences with MulticastingRouter router:

• When using MulticastingRouter changes to the payload performed in route n are visible in route (n+1). When using ScatterGatherRouter, each route has different shallow copies of the original event
• MulticastingRouter throws CouldNotRouteOutboundMessageException upon route failure and stops processing. When catching the exception, you'll have no information about the result of any prior routes. ScatterGatherRouter will process all routes no matter what. It will also aggregate the results of all routes into a Collection in which each entry has the ExceptionPayload set accordingly and then will throw a CompositeRoutingException which will give you visibility over the output of other routes.

For advanced use cases, a custom AggregationStrategy can be applied to customize the logic used to aggregate the route responses back into one single element or to throw exception

EIP Reference:

Since:

3.5.0

Nested Class Summary

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

ReactiveProcessor.ProcessingType

Field Summary

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

Method Summary

Modifier and Type	Method and Description
void	addRoute(Processor processor) Adds a new message processor to the list of routes
org.reactivestreams.Publisher<Event>	apply(org.reactivestreams.Publisher<Event> publisher) Applies a Publisher function transforming a stream of Event's.
protected List<Processor>	getOwnedMessageProcessors()
void	initialise()
Event	process(Event event) Invokes the MessageProcessor.
void	removeRoute(Processor processor) Removes a message processor from the list of routes
void	setAggregationStrategy(AggregationStrategy aggregationStrategy)
void	setParallel(boolean parallel)
void	setRoutes(List<Processor> routes)
void	setTimeout(long timeout)
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

dispose, getFlowConstruct, getMuleContext, setFlowConstruct, setMessagingExceptionHandler, setMuleContext

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.ReactiveProcessor

getProcessingType

Methods inherited from interface java.util.function.Function

andThen, compose, identity

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

ScatterGatherRouter

public ScatterGatherRouter()

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

apply

public org.reactivestreams.Publisher<Event> apply(org.reactivestreams.Publisher<Event> publisher)

Description copied from interface: Processor

Applies a Publisher function transforming a stream of Event's.

The default implementation delegates to Processor.process(Event) and will:

1. propagate any exception thrown
2. drop events if invocation of Processor.process(Event) returns null.

Specified by:

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

Specified by:

apply in interface Processor

Parameters:

publisher - the event stream to transform

Returns:

the transformed event stream

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

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

addRoute

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

Adds a new message processor to the list of routes

Specified by:

addRoute in interface MessageRouter

Parameters:

processor - new destination message processor

Throws:

IllegalStateException - if invoked after initialise() is completed

org.mule.runtime.api.exception.MuleException

removeRoute

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

Removes a message processor from the list of routes

Specified by:

removeRoute in interface MessageRouter

Parameters:

processor - destination message processor to remove

Throws:

IllegalStateException - if invoked after initialise() is completed

org.mule.runtime.api.exception.MuleException

getOwnedMessageProcessors

protected List<Processor> getOwnedMessageProcessors()

Specified by:

getOwnedMessageProcessors in class AbstractMessageProcessorOwner

setAggregationStrategy

public void setAggregationStrategy(AggregationStrategy aggregationStrategy)

setParallel

public void setParallel(boolean parallel)

setTimeout

public void setTimeout(long timeout)

setRoutes

public void setRoutes(List<Processor> routes)