org.apache.camel.model

Class SplitDefinition

java.lang.Object

org.apache.camel.model.OptionalIdentifiedDefinition<Type>

org.apache.camel.model.ProcessorDefinition<ExpressionNode>

org.apache.camel.model.ExpressionNode

org.apache.camel.model.SplitDefinition

All Implemented Interfaces:

ExecutorServiceAware, Block, ExecutorServiceAwareDefinition<SplitDefinition>, OtherAttributesAware, NamedNode

@Metadata(label="eip,routing")
public class SplitDefinition
extends ExpressionNode
implements ExecutorServiceAwareDefinition<SplitDefinition>

Splits a single message into many sub-messages.

Version:

Field Summary

Fields inherited from class org.apache.camel.model.ProcessorDefinition

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
SplitDefinition()
SplitDefinition(Expression expression)
SplitDefinition(ExpressionDefinition expression)

Method Summary

Methods

Modifier and Type	Method and Description
SplitDefinition	aggregationStrategy(AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter.
SplitDefinition	aggregationStrategyMethodAllowNull() If this option is false then the aggregate method is not used if there was no data to enrich.
SplitDefinition	aggregationStrategyMethodName(String methodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
SplitDefinition	aggregationStrategyRef(String aggregationStrategyRef) Sets a reference to the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter.
Processor	createProcessor(RouteContext routeContext) Override this in definition class and implement logic to create the processor based on the definition model.
SplitDefinition	executorService(ExecutorService executorService) To use a custom Thread Pool to be used for parallel processing.
SplitDefinition	executorServiceRef(String executorServiceRef) Refers to a custom Thread Pool to be used for parallel processing.
AggregationStrategy	getAggregationStrategy()
ExecutorService	getExecutorService() Gets the executor service
String	getExecutorServiceRef() Gets the reference to lookup in the Registry for the executor service to be used.
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
Processor	getOnPrepare()
String	getOnPrepareRef()
Boolean	getParallelAggregate()
Boolean	getParallelProcessing()
Boolean	getShareUnitOfWork()
Boolean	getStopOnException()
Boolean	getStrategyMethodAllowNull()
String	getStrategyMethodName()
String	getStrategyRef()
Boolean	getStreaming()
Long	getTimeout()
Boolean	isStopOnException()
SplitDefinition	onPrepare(Processor onPrepare) Uses the Processor when preparing the Exchange to be send.
SplitDefinition	onPrepareRef(String onPrepareRef) Uses the Processor when preparing the Exchange to be send.
SplitDefinition	parallelAggregate() If enabled then the aggregate method on AggregationStrategy can be called concurrently.
SplitDefinition	parallelProcessing() If enabled then processing each splitted messages occurs concurrently.
SplitDefinition	parallelProcessing(boolean parallelProcessing) If enabled then processing each splitted messages occurs concurrently.
void	setAggregationStrategy(AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter.
void	setExecutorService(ExecutorService executorService) Sets the executor service to be used.
void	setExecutorServiceRef(String executorServiceRef) Sets a reference to lookup in the Registry for the executor service to be used.
void	setExpression(ExpressionDefinition expression) Expression of how to split the message body, such as as-is, using a tokenizer, or using an xpath.
void	setOnPrepare(Processor onPrepare)
void	setOnPrepareRef(String onPrepareRef)
void	setParallelAggregate(Boolean parallelAggregate)
void	setParallelProcessing(Boolean parallelProcessing)
void	setShareUnitOfWork(Boolean shareUnitOfWork)
void	setStopOnException(Boolean stopOnException)
void	setStrategyMethodAllowNull(Boolean strategyMethodAllowNull) If this option is false then the aggregate method is not used if there was no data to enrich.
void	setStrategyMethodName(String strategyMethodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
void	setStrategyRef(String strategyRef) Sets a reference to the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter.
void	setStreaming(Boolean streaming)
void	setTimeout(Long timeout)
SplitDefinition	shareUnitOfWork() Shares the UnitOfWork with the parent and each of the sub messages.
SplitDefinition	stopOnException() Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown.
SplitDefinition	streaming() When in streaming mode, then the splitter splits the original message on-demand, and each splitted message is processed one by one.
SplitDefinition	timeout(long timeout) Sets a total timeout specified in millis, when using parallel processing.
String	toString()

Methods inherited from class org.apache.camel.model.ExpressionNode

configureChild, createFilterProcessor, createPredicate, getExpression, getOutputs, isOutputSupported, preCreateProcessor, setOutputs

Methods inherited from class org.apache.camel.model.ProcessorDefinition

addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, clearOutput, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, makeProcessor, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, onCompletion, onException, onException, pipeline, pipeline, pipeline, pipeline, placeholder, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, sample, sample, sample, script, script, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wireTap, wrapChannel, wrapChannel, wrapInErrorHandler, wrapProcessor

Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition

description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SplitDefinition

public SplitDefinition()

SplitDefinition

public SplitDefinition(Expression expression)

SplitDefinition

public SplitDefinition(ExpressionDefinition expression)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getLabel

public String getLabel()

Description copied from class: ProcessorDefinition

Returns a label to describe this node such as the expression if some kind of expression node

Specified by:

getLabel in interface NamedNode

Overrides:

getLabel in class ExpressionNode

createProcessor

public Processor createProcessor(RouteContext routeContext)
                          throws Exception

Description copied from class: ProcessorDefinition

Override this in definition class and implement logic to create the processor based on the definition model.

Overrides:

createProcessor in class ProcessorDefinition<ExpressionNode>

Throws:

Exception

aggregationStrategy

public SplitDefinition aggregationStrategy(AggregationStrategy aggregationStrategy)

Sets the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

aggregationStrategyRef

public SplitDefinition aggregationStrategyRef(String aggregationStrategyRef)

Sets a reference to the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

aggregationStrategyMethodName

public SplitDefinition aggregationStrategyMethodName(String methodName)

This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.

Parameters:

methodName - the method name to call

Returns:

the builder

aggregationStrategyMethodAllowNull

public SplitDefinition aggregationStrategyMethodAllowNull()

If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy

Returns:

the builder

parallelProcessing

public SplitDefinition parallelProcessing()

If enabled then processing each splitted messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only processing the sub messages from the splitter which happens concurrently.

Returns:

the builder

parallelProcessing

public SplitDefinition parallelProcessing(boolean parallelProcessing)

If enabled then processing each splitted messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only processing the sub messages from the splitter which happens concurrently.

Returns:

the builder

parallelAggregate

public SplitDefinition parallelAggregate()

If enabled then the aggregate method on AggregationStrategy can be called concurrently. Notice that this would require the implementation of AggregationStrategy to be implemented as thread-safe. By default this is false meaning that Camel synchronizes the call to the aggregate method. Though in some use-cases this can be used to archive higher performance when the AggregationStrategy is implemented as thread-safe.

Returns:

the builder

streaming

public SplitDefinition streaming()

When in streaming mode, then the splitter splits the original message on-demand, and each splitted message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the Exchange.SPLIT_SIZE is empty.

In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the splitted messages in memory and therefore requires more memory. The total size is provided in the Exchange.SPLIT_SIZE header.

The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, eg in the order they come back. If disabled, Camel will process replies in the same order as the messages was splitted.

Returns:

the builder

stopOnException

public SplitDefinition stopOnException()

Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown.

Will also stop if processing the exchange failed (has a fault message) or an exception was thrown and handled by the error handler (such as using onException). In all situations the splitter will stop further processing. This is the same behavior as in pipeline, which is used by the routing engine.

The default behavior is to not stop but continue processing till the end

Returns:

the builder

executorService

public SplitDefinition executorService(ExecutorService executorService)

To use a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well.

Specified by:

executorService in interface ExecutorServiceAwareDefinition<SplitDefinition>

Parameters:

executorService - the executor service

Returns:

the builder

executorServiceRef

public SplitDefinition executorServiceRef(String executorServiceRef)

Refers to a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatic implied, and you do not have to enable that option as well.

Specified by:

executorServiceRef in interface ExecutorServiceAwareDefinition<SplitDefinition>

Parameters:

executorServiceRef - reference for a ExecutorService to lookup in the Registry

Returns:

the builder

onPrepare

public SplitDefinition onPrepare(Processor onPrepare)

Uses the Processor when preparing the Exchange to be send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send.

Parameters:

onPrepare - the processor

Returns:

the builder

onPrepareRef

public SplitDefinition onPrepareRef(String onPrepareRef)

Uses the Processor when preparing the Exchange to be send. This can be used to deep-clone messages that should be send, or any custom logic needed before the exchange is send.

Parameters:

onPrepareRef - reference to the processor to lookup in the Registry

Returns:

the builder

timeout

public SplitDefinition timeout(long timeout)

Sets a total timeout specified in millis, when using parallel processing. If the Splitter hasn't been able to split and process all the sub messages within the given timeframe, then the timeout triggers and the Splitter breaks out and continues. Notice if you provide a TimeoutAwareAggregationStrategy then the timeout method is invoked before breaking out. If the timeout is reached with running tasks still remaining, certain tasks for which it is difficult for Camel to shut down in a graceful manner may continue to run. So use this option with a bit of care.

Parameters:

timeout - timeout in millis

Returns:

the builder

shareUnitOfWork

public SplitDefinition shareUnitOfWork()

Shares the UnitOfWork with the parent and each of the sub messages. Splitter will by default not share unit of work between the parent exchange and each splitted exchange. This means each splitted exchange has its own individual unit of work.

Returns:

the builder.

See Also:

SubUnitOfWork

setExpression

public void setExpression(ExpressionDefinition expression)

Expression of how to split the message body, such as as-is, using a tokenizer, or using an xpath.

Overrides:

setExpression in class ExpressionNode

getAggregationStrategy

public AggregationStrategy getAggregationStrategy()

setAggregationStrategy

public void setAggregationStrategy(AggregationStrategy aggregationStrategy)

Sets the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

getParallelProcessing

public Boolean getParallelProcessing()

setParallelProcessing

public void setParallelProcessing(Boolean parallelProcessing)

getStreaming

public Boolean getStreaming()

setStreaming

public void setStreaming(Boolean streaming)

getParallelAggregate

public Boolean getParallelAggregate()

setParallelAggregate

public void setParallelAggregate(Boolean parallelAggregate)

getStopOnException

public Boolean getStopOnException()

setStopOnException

public void setStopOnException(Boolean stopOnException)

isStopOnException

public Boolean isStopOnException()

getExecutorService

public ExecutorService getExecutorService()

Description copied from interface: ExecutorServiceAware

Gets the executor service

Specified by:

getExecutorService in interface ExecutorServiceAware

Returns:

the executor

setExecutorService

public void setExecutorService(ExecutorService executorService)

Description copied from interface: ExecutorServiceAware

Sets the executor service to be used.

Specified by:

setExecutorService in interface ExecutorServiceAware

Parameters:

executorService - the executor

getStrategyRef

public String getStrategyRef()

setStrategyRef

public void setStrategyRef(String strategyRef)

Sets a reference to the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

getStrategyMethodName

public String getStrategyMethodName()

setStrategyMethodName

public void setStrategyMethodName(String strategyMethodName)

This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.

getStrategyMethodAllowNull

public Boolean getStrategyMethodAllowNull()

setStrategyMethodAllowNull

public void setStrategyMethodAllowNull(Boolean strategyMethodAllowNull)

If this option is false then the aggregate method is not used if there was no data to enrich. If this option is true then null values is used as the oldExchange (when no data to enrich), when using POJOs as the AggregationStrategy

getExecutorServiceRef

public String getExecutorServiceRef()

Description copied from interface: ExecutorServiceAware

Gets the reference to lookup in the Registry for the executor service to be used.

Specified by:

getExecutorServiceRef in interface ExecutorServiceAware

Returns:

the reference, or null if the executor was set directly

setExecutorServiceRef

public void setExecutorServiceRef(String executorServiceRef)

Description copied from interface: ExecutorServiceAware

Sets a reference to lookup in the Registry for the executor service to be used.

Specified by:

setExecutorServiceRef in interface ExecutorServiceAware

Parameters:

executorServiceRef - reference for the executor

getTimeout

public Long getTimeout()

setTimeout

public void setTimeout(Long timeout)

getOnPrepareRef

public String getOnPrepareRef()

setOnPrepareRef

public void setOnPrepareRef(String onPrepareRef)

getOnPrepare

public Processor getOnPrepare()

setOnPrepare

public void setOnPrepare(Processor onPrepare)

getShareUnitOfWork

public Boolean getShareUnitOfWork()

setShareUnitOfWork

public void setShareUnitOfWork(Boolean shareUnitOfWork)