Package 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.OutputExpressionNode
org.apache.camel.model.SplitDefinition
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,ExecutorServiceAwareDefinition<SplitDefinition>
,HasExpressionType
,OutputNode
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="eip,routing")
public class SplitDefinition
extends OutputExpressionNode
implements ExecutorServiceAwareDefinition<SplitDefinition>
Splits a single message into many sub-messages.
-
Field Summary
Fields inherited from class org.apache.camel.model.ProcessorDefinition
disabled, inheritErrorHandler
-
Constructor Summary
ConstructorDescriptionSplitDefinition
(org.apache.camel.Expression expression) SplitDefinition
(ExpressionDefinition expression) -
Method Summary
Modifier and TypeMethodDescriptionaggregationStrategy
(String aggregationStrategy) Sets a reference to the AggregationStrategy to be used to assemble the replies from the split messages, into a single outgoing message from the Splitter.aggregationStrategy
(org.apache.camel.AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the split messages, into a single outgoing message from the Splitter.If this option is false then the aggregate method is not used if there was no data to enrich.aggregationStrategyMethodAllowNull
(boolean aggregationStrategyMethodAllowNull) If this option is false then the aggregate method is not used if there was no data to enrich.aggregationStrategyMethodAllowNull
(String aggregationStrategyMethodAllowNull) If this option is false then the aggregate method is not used if there was no data to enrich.aggregationStrategyMethodName
(String methodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.Delimiter used in splitting messages.executorService
(String executorService) Refers to a custom Thread Pool to be used for parallel processing.executorService
(ExecutorService executorService) To use a custom Thread Pool to be used for parallel processing.org.apache.camel.AggregationStrategy
Gets the executor service for executingGets a reference id to lookup the executor service from the registrygetLabel()
Returns a label to describe this node such as the expression if some kind of expression nodeorg.apache.camel.Processor
Uses theProcessor
when preparing theExchange
to be sent.onPrepare
(org.apache.camel.Processor onPrepare) Uses theProcessor
when preparing theExchange
to be sent.If enabled then the aggregate method on AggregationStrategy can be called concurrently.parallelAggregate
(boolean parallelAggregate) If enabled then the aggregate method on AggregationStrategy can be called concurrently.parallelAggregate
(String parallelAggregate) If enabled then the aggregate method on AggregationStrategy can be called concurrently.If enabled then processing each split messages occurs concurrently.parallelProcessing
(boolean parallelProcessing) If enabled then processing each split messages occurs concurrently.parallelProcessing
(String parallelProcessing) If enabled then processing each split messages occurs concurrently.void
setAggregationStrategy
(String aggregationStrategy) Sets a reference to the AggregationStrategy to be used to assemble the replies from the split messages, into a single outgoing message from the Splitter.void
setAggregationStrategy
(org.apache.camel.AggregationStrategy aggregationStrategyBean) Sets the AggregationStrategy to be used to assemble the replies from the split messages, into a single outgoing message from the Splitter.void
setAggregationStrategyMethodAllowNull
(String aggregationStrategyMethodAllowNull) If this option is false then the aggregate method is not used if there was no data to enrich.void
setAggregationStrategyMethodName
(String aggregationStrategyMethodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.void
setDelimiter
(String delimiter) void
setExecutorService
(String executorService) void
setExpression
(ExpressionDefinition expression) Expression of how to split the message body, such as as-is, using a tokenizer, or using a xpath.void
setOnPrepare
(String onPrepare) void
setParallelAggregate
(String parallelAggregate) void
setParallelProcessing
(String parallelProcessing) void
setShareUnitOfWork
(String shareUnitOfWork) void
setStopOnException
(String stopOnException) void
setStreaming
(String streaming) void
setTimeout
(String timeout) Shares theUnitOfWork
with the parent and each of the sub messages.shareUnitOfWork
(boolean shareUnitOfWork) Shares theUnitOfWork
with the parent and each of the sub messages.shareUnitOfWork
(String shareUnitOfWork) Shares theUnitOfWork
with the parent and each of the sub messages.Will now stop further processing if an exception or failure occurred during processing of anExchange
and the caused exception will be thrown.stopOnException
(boolean stopOnException) Will now stop further processing if an exception or failure occurred during processing of anExchange
and the caused exception will be thrown.stopOnException
(String stopOnException) Will now stop further processing if an exception or failure occurred during processing of anExchange
and the caused exception will be thrown.When in streaming mode, then the splitter splits the original message on-demand, and each split message is processed one by one.streaming
(boolean streaming) When in streaming mode, then the splitter splits the original message on-demand, and each split message is processed one by one.When in streaming mode, then the splitter splits the original message on-demand, and each split message is processed one by one.timeout
(long timeout) Sets a total timeout specified in millis, when using parallel processing.Sets a total timeout specified in millis, when using parallel processing.toString()
Methods inherited from class org.apache.camel.model.OutputExpressionNode
getOutputs, setOutputs
Methods inherited from class org.apache.camel.model.ExpressionNode
configureChild, getExpression, getExpressionType, id, preCreateProcessor, setExpression, setExpressionType
Methods inherited from class org.apache.camel.model.ProcessorDefinition
addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, circuitBreaker, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, convertBodyTo, delay, delay, delay, disabled, disabled, disabled, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoCatch, endDoTry, endParent, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getDisabled, getIndex, getInterceptStrategies, getParent, getRouteConfiguration, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, kamelet, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, loopDoWhile, markRollbackOnly, markRollbackOnlyLast, marshal, marshal, marshal, marshal, multicast, multicast, multicast, nodePrefixId, onCompletion, onException, onException, pausable, pausable, pausable, pausable, pipeline, pipeline, pipeline, policy, policy, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrich, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, pollEnrichWith, process, process, process, recipientList, recipientList, recipientList, recipientList, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, resumable, resumable, resumable, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setDisabled, setExchangePattern, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, setRouteConfiguration, sort, sort, sort, split, split, split, split, startupOrder, step, step, stop, threads, threads, threads, threads, throttle, throttle, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, to, to, toD, toD, toD, toD, toD, toD, toD, toF, transacted, transacted, transform, transform, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, unmarshal, validate, validate, validate, wireTap, wireTap, wireTap
Methods inherited from class org.apache.camel.model.OptionalIdentifiedDefinition
description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
Constructor Details
-
SplitDefinition
public SplitDefinition() -
SplitDefinition
public SplitDefinition(org.apache.camel.Expression expression) -
SplitDefinition
-
-
Method Details
-
toString
-
getShortName
- Specified by:
getShortName
in interfaceorg.apache.camel.NamedNode
-
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 interfaceorg.apache.camel.NamedNode
- Overrides:
getLabel
in classExpressionNode
-
delimiter
Delimiter used in splitting messages. Can be turned off using the value false. The default value is ,- Parameters:
delimiter
- the delimiter- Returns:
- the builder
-
aggregationStrategy
public SplitDefinition aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the split 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 -
aggregationStrategy
Sets a reference to the AggregationStrategy to be used to assemble the replies from the split 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
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
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
-
aggregationStrategyMethodAllowNull
public SplitDefinition aggregationStrategyMethodAllowNull(boolean 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
-
aggregationStrategyMethodAllowNull
public SplitDefinition aggregationStrategyMethodAllowNull(String 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
If enabled then processing each split messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. It's only processing the sub messages from the splitter which happens concurrently.- Returns:
- the builder
-
parallelProcessing
If enabled then processing each split messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. It's only processing the sub messages from the splitter which happens concurrently.- Returns:
- the builder
-
parallelProcessing
If enabled then processing each split messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. It's only processing the sub messages from the splitter which happens concurrently.- Returns:
- the builder
-
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
-
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
-
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
When in streaming mode, then the splitter splits the original message on-demand, and each split 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 theExchange.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 split messages in memory and therefore requires more memory. The total size is provided in theExchange.SPLIT_SIZE
header. The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, e.g. in the order they come back. If disabled, Camel will process replies in the same order as the messages was split.- Returns:
- the builder
-
streaming
When in streaming mode, then the splitter splits the original message on-demand, and each split 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 theExchange.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 split messages in memory and therefore requires more memory. The total size is provided in theExchange.SPLIT_SIZE
header. The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, e.g. in the order they come back. If disabled, Camel will process replies in the same order as the messages was split.- Returns:
- the builder
-
streaming
When in streaming mode, then the splitter splits the original message on-demand, and each split 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 theExchange.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 split messages in memory and therefore requires more memory. The total size is provided in theExchange.SPLIT_SIZE
header. The streaming mode also affects the aggregation behavior. If enabled then Camel will process replies out-of-order, e.g. in the order they come back. If disabled, Camel will process replies in the same order as the messages was split.- Returns:
- the builder
-
stopOnException
Will now stop further processing if an exception or failure occurred during processing of anExchange
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
-
stopOnException
Will now stop further processing if an exception or failure occurred during processing of anExchange
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
-
stopOnException
Will now stop further processing if an exception or failure occurred during processing of anExchange
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
To use a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatically implied, and you do not have to enable that option as well.- Specified by:
executorService
in interfaceExecutorServiceAwareDefinition<SplitDefinition>
- Parameters:
executorService
- the executor service- Returns:
- the builder
-
executorService
Refers to a custom Thread Pool to be used for parallel processing. Notice if you set this option, then parallel processing is automatically implied, and you do not have to enable that option as well.- Specified by:
executorService
in interfaceExecutorServiceAwareDefinition<SplitDefinition>
- Parameters:
executorService
- reference for aExecutorService
to lookup in theRegistry
- Returns:
- the builder
-
onPrepare
Uses theProcessor
when preparing theExchange
to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.- Parameters:
onPrepare
- the processor- Returns:
- the builder
-
onPrepare
Uses theProcessor
when preparing theExchange
to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.- Parameters:
onPrepare
- reference to the processor to lookup in theRegistry
- Returns:
- the builder
-
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
-
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
-
getAggregationStrategyBean
public org.apache.camel.AggregationStrategy getAggregationStrategyBean() -
getOnPrepareProcessor
public org.apache.camel.Processor getOnPrepareProcessor() -
getExecutorServiceBean
Description copied from interface:ExecutorServiceAwareDefinition
Gets the executor service for executing- Specified by:
getExecutorServiceBean
in interfaceExecutorServiceAwareDefinition<SplitDefinition>
-
getExecutorServiceRef
Description copied from interface:ExecutorServiceAwareDefinition
Gets a reference id to lookup the executor service from the registry- Specified by:
getExecutorServiceRef
in interfaceExecutorServiceAwareDefinition<SplitDefinition>
-
setExpression
Expression of how to split the message body, such as as-is, using a tokenizer, or using a xpath.- Overrides:
setExpression
in classExpressionNode
-
getDelimiter
-
setDelimiter
-
getParallelProcessing
-
setParallelProcessing
-
getStreaming
-
setStreaming
-
getParallelAggregate
-
setParallelAggregate
-
getStopOnException
-
setStopOnException
-
getAggregationStrategy
-
setAggregationStrategy
Sets a reference to the AggregationStrategy to be used to assemble the replies from the split 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 -
setAggregationStrategy
public void setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategyBean) Sets the AggregationStrategy to be used to assemble the replies from the split 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 -
getAggregationStrategyMethodName
-
setAggregationStrategyMethodName
This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy. -
getAggregationStrategyMethodAllowNull
-
setAggregationStrategyMethodAllowNull
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 -
getTimeout
-
setTimeout
-
getOnPrepare
-
setOnPrepare
-
getExecutorService
-
setExecutorService
-