org.mule.runtime.core.routing.outbound

Class AbstractMessageSequenceSplitter

java.lang.Object

org.mule.runtime.api.meta.AbstractAnnotatedObject

org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase

org.mule.runtime.core.processor.AbstractInterceptingMessageProcessor

org.mule.runtime.core.routing.outbound.AbstractMessageSequenceSplitter

All Implemented Interfaces:

Function<org.reactivestreams.Publisher<Event>,org.reactivestreams.Publisher<Event>>, org.mule.runtime.api.meta.AnnotatedObject, FlowConstructAware, MuleContextAware, InterceptingMessageProcessor, Processor, ReactiveProcessor

Direct Known Subclasses:

AbstractSplitter, Splitter

public abstract class AbstractMessageSequenceSplitter
extends AbstractInterceptingMessageProcessor
implements MuleContextAware

Base implementation of a Message splitter, that converts its payload in a MessageSequence, and process each element of it. Implementations must implement splitMessageIntoSequence(Event) and determine how the message is split.

EIP Reference: http://www .eaipatterns.com/Sequencer.html

Author:

flbulgarelli

See Also:

AbstractSplitter

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 int	batchSize
protected String	counterVariableName
protected RouterResultsHandler	resultsHandler

Fields inherited from class org.mule.runtime.core.processor.AbstractInterceptingMessageProcessorBase

flowConstruct, logger, muleContext, next

Fields inherited from class org.mule.runtime.api.meta.AbstractAnnotatedObject

LOCATION_KEY

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

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractMessageSequenceSplitter()

Method Summary

Modifier and Type	Method and Description
protected boolean	isSplitRequired(Event event)
Event	process(Event event) Invokes the MessageProcessor.
protected List<Event>	processParts(MessageSequence<?> seq, Event originalEvent)
protected void	propagateFlowVars(Event previousResult, Event.Builder builder)
protected Set<String>	resolvePropagatedFlowVars(Event lastResult)
void	setBatchSize(int batchSize) Split the elements in groups of the specified size
void	setCounterVariableName(String counterVariableName)
protected abstract MessageSequence<?>	splitMessageIntoSequence(Event event) Converts the event into a MessageSequence that will retrieve each of the event elements

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

applyNext, getListener, getMuleContext, isEventValid, processNext, setFlowConstruct, setListener, setMuleContext, toString

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

Methods inherited from interface org.mule.runtime.core.api.context.MuleContextAware

setMuleContext

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

setListener

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

Field Detail

resultsHandler

protected RouterResultsHandler resultsHandler

batchSize

protected int batchSize

counterVariableName

protected String counterVariableName

Constructor Detail

AbstractMessageSequenceSplitter

public AbstractMessageSequenceSplitter()

Method Detail

process

public final 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

isSplitRequired

protected boolean isSplitRequired(Event event)

splitMessageIntoSequence

protected abstract MessageSequence<?> splitMessageIntoSequence(Event event)
                                                        throws org.mule.runtime.api.exception.MuleException

Converts the event into a MessageSequence that will retrieve each of the event elements

Parameters:

event - the event to split

Returns:

a sequence of elements

Throws:

org.mule.runtime.api.exception.MuleException

processParts

protected List<Event> processParts(MessageSequence<?> seq,
                                   Event originalEvent)
                            throws org.mule.runtime.api.exception.MuleException

Throws:

org.mule.runtime.api.exception.MuleException

resolvePropagatedFlowVars

protected Set<String> resolvePropagatedFlowVars(Event lastResult)

propagateFlowVars

protected void propagateFlowVars(Event previousResult,
                                 Event.Builder builder)

setBatchSize

public void setBatchSize(int batchSize)

Split the elements in groups of the specified size

setCounterVariableName

public void setCounterVariableName(String counterVariableName)