org.mule.runtime.core.routing

Class Foreach

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

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

public class Foreach
extends AbstractMessageProcessorOwner
implements org.mule.runtime.api.lifecycle.Initialisable, Processor

The foreach Processor allows iterating over a collection payload, or any collection obtained by an expression, generating a message for each element.

The number of the message being processed is stored in #[mel:variable:counter] and the root message is store in #[mel:flowVars.rootMessage]. Both variables may be renamed by means of setCounterVariableName(String) and setRootMessageVariableName(String).

Defining a groupSize greater than one, allows iterating over collections of elements of the specified size.

The Event sent to the next message processor is the same that arrived to foreach.

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
static String	COUNTER_PROPERTY
protected org.slf4j.Logger	logger
static String	ROOT_MESSAGE_PROPERTY

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

Method Summary

Modifier and Type	Method and Description
protected Event	doProcess(Event event)
protected List<Processor>	getOwnedMessageProcessors()
void	initialise()
Event	process(Event event) Invokes the MessageProcessor.
void	setBatchSize(int batchSize)
void	setCollectionExpression(String expression)
void	setCounterVariableName(String counterVariableName)
void	setMessageProcessors(List<Processor> messageProcessors)
void	setRootMessageVariableName(String rootMessageVariableName)

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

Field Detail

ROOT_MESSAGE_PROPERTY

public static final String ROOT_MESSAGE_PROPERTY

See Also:

Constant Field Values

COUNTER_PROPERTY

public static final String COUNTER_PROPERTY

See Also:

Constant Field Values

logger

protected org.slf4j.Logger logger

Constructor Detail

Foreach

public Foreach()

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

doProcess

protected Event doProcess(Event event)
                   throws org.mule.runtime.api.exception.MuleException,
                          MessagingException

Throws:

org.mule.runtime.api.exception.MuleException

MessagingException

getOwnedMessageProcessors

protected List<Processor> getOwnedMessageProcessors()

Specified by:

getOwnedMessageProcessors in class AbstractMessageProcessorOwner

setMessageProcessors

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

Throws:

org.mule.runtime.api.exception.MuleException

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

setCollectionExpression

public void setCollectionExpression(String expression)

setBatchSize

public void setBatchSize(int batchSize)

setRootMessageVariableName

public void setRootMessageVariableName(String rootMessageVariableName)

setCounterVariableName

public void setCounterVariableName(String counterVariableName)