@Metadata(label="eip,routing") public class SplitDefinition extends ExpressionNode implements ExecutorServiceAwareDefinition<SplitDefinition>
inheritErrorHandler, log
Constructor and Description |
---|
SplitDefinition() |
SplitDefinition(Expression expression) |
SplitDefinition(ExpressionDefinition expression) |
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 |
getStopOnAggregateException() |
Boolean |
getStopOnException() |
Boolean |
getStrategyMethodAllowNull() |
String |
getStrategyMethodName() |
String |
getStrategyRef() |
Boolean |
getStreaming() |
Long |
getTimeout() |
Boolean |
isStopOnException() |
SplitDefinition |
onPrepare(Processor onPrepare)
|
SplitDefinition |
onPrepareRef(String onPrepareRef)
|
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 |
setStopOnAggregateException(Boolean stopOnAggregateException) |
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 |
stopOnAggregateException()
If enabled, unwind exceptions occurring at aggregation time to the error handler when parallelProcessing is used.
|
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() |
configureChild, createFilterProcessor, createPredicate, getExpression, getOutputs, isOutputSupported, preCreateProcessor, setOutputs
addInterceptStrategies, addInterceptStrategy, addOutput, addRoutes, aggregate, aggregate, aggregate, aggregate, aop, attribute, bean, bean, bean, bean, bean, bean, bean, bean, beanRef, beanRef, beanRef, beanRef, beanRef, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, createChannel, createChildProcessor, createCompositeProcessor, createOutputsProcessor, createOutputsProcessor, createOutputsProcessorImpl, createProcessor, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, end, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrichRef, enrichRef, enrichRef, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, loadBalance, loadBalance, log, log, log, log, log, log, loop, loop, loop, loopDoWhile, 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, pollEnrich, pollEnrich, pollEnrichRef, pollEnrichRef, pollEnrichWith, pollEnrichWith, pollEnrichWith, process, process, process, processRef, recipientList, recipientList, recipientList, recipientList, removeFaultHeader, removeHeader, removeHeaders, removeHeaders, removeProperties, removeProperties, removeProperty, resequence, resequence, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setFaultBody, setFaultHeader, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setOutHeader, setOutHeader, setParent, setProperty, setProperty, sort, sort, sort, split, split, split, startupOrder, stop, threads, threads, threads, threads, throttle, throttle, throttle, throwException, throwException, to, to, to, to, to, to, to, to, to, to, toD, 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
description, description, getCustomId, getDescription, getDescriptionText, getId, getShortName, hasCustomIdAssigned, idOrCreate, setCustomId, setDescription, setId
public SplitDefinition()
public SplitDefinition(Expression expression)
public SplitDefinition(ExpressionDefinition expression)
public String getLabel()
ProcessorDefinition
getLabel
in interface NamedNode
getLabel
in class ExpressionNode
public Processor createProcessor(RouteContext routeContext) throws Exception
ProcessorDefinition
createProcessor
in class ProcessorDefinition<ExpressionNode>
Exception
public SplitDefinition aggregationStrategy(AggregationStrategy aggregationStrategy)
public SplitDefinition aggregationStrategyRef(String aggregationStrategyRef)
public SplitDefinition aggregationStrategyMethodName(String methodName)
methodName
- the method name to callpublic SplitDefinition aggregationStrategyMethodAllowNull()
public SplitDefinition parallelProcessing()
public SplitDefinition parallelProcessing(boolean parallelProcessing)
public SplitDefinition parallelAggregate()
public SplitDefinition stopOnAggregateException()
false
for the sake of backward compatibility.public SplitDefinition streaming()
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.public SplitDefinition stopOnException()
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 endpublic SplitDefinition executorService(ExecutorService executorService)
executorService
in interface ExecutorServiceAwareDefinition<SplitDefinition>
executorService
- the executor servicepublic SplitDefinition executorServiceRef(String executorServiceRef)
executorServiceRef
in interface ExecutorServiceAwareDefinition<SplitDefinition>
executorServiceRef
- reference for a ExecutorService
to lookup in the Registry
public SplitDefinition onPrepare(Processor onPrepare)
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.onPrepare
- the processorpublic SplitDefinition onPrepareRef(String onPrepareRef)
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.onPrepareRef
- reference to the processor to lookup in the Registry
public SplitDefinition timeout(long timeout)
timeout
- timeout in millispublic SplitDefinition shareUnitOfWork()
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.SubUnitOfWork
public void setExpression(ExpressionDefinition expression)
setExpression
in class ExpressionNode
public AggregationStrategy getAggregationStrategy()
public void setAggregationStrategy(AggregationStrategy aggregationStrategy)
public Boolean getParallelProcessing()
public void setParallelProcessing(Boolean parallelProcessing)
public Boolean getStreaming()
public void setStreaming(Boolean streaming)
public Boolean getParallelAggregate()
public void setParallelAggregate(Boolean parallelAggregate)
public Boolean getStopOnAggregateException()
public void setStopOnAggregateException(Boolean stopOnAggregateException)
public Boolean getStopOnException()
public void setStopOnException(Boolean stopOnException)
public Boolean isStopOnException()
public ExecutorService getExecutorService()
ExecutorServiceAware
getExecutorService
in interface ExecutorServiceAware
public void setExecutorService(ExecutorService executorService)
ExecutorServiceAware
setExecutorService
in interface ExecutorServiceAware
executorService
- the executorpublic String getStrategyRef()
public void setStrategyRef(String strategyRef)
public String getStrategyMethodName()
public void setStrategyMethodName(String strategyMethodName)
public Boolean getStrategyMethodAllowNull()
public void setStrategyMethodAllowNull(Boolean strategyMethodAllowNull)
public String getExecutorServiceRef()
ExecutorServiceAware
Registry
for the executor service to be used.getExecutorServiceRef
in interface ExecutorServiceAware
public void setExecutorServiceRef(String executorServiceRef)
ExecutorServiceAware
Registry
for the executor service to be used.setExecutorServiceRef
in interface ExecutorServiceAware
executorServiceRef
- reference for the executorpublic Long getTimeout()
public void setTimeout(Long timeout)
public String getOnPrepareRef()
public void setOnPrepareRef(String onPrepareRef)
public Processor getOnPrepare()
public void setOnPrepare(Processor onPrepare)
public Boolean getShareUnitOfWork()
public void setShareUnitOfWork(Boolean shareUnitOfWork)
Apache Camel