Package org.apache.camel.model
Class MulticastDefinition
java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<Type>
org.apache.camel.model.ProcessorDefinition<Type>
org.apache.camel.model.OutputDefinition<MulticastDefinition>
org.apache.camel.model.MulticastDefinition
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,ExecutorServiceAwareDefinition<MulticastDefinition>
,OutputNode
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
@Metadata(label="eip,routing")
public class MulticastDefinition
extends OutputDefinition<MulticastDefinition>
implements ExecutorServiceAwareDefinition<MulticastDefinition>
Routes the same message to multiple paths either sequentially or in parallel.
-
Field Summary
Fields inherited from class org.apache.camel.model.OutputDefinition
outputs
Fields inherited from class org.apache.camel.model.ProcessorDefinition
disabled, inheritErrorHandler
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast using a fluent builder.aggregationStrategy
(String aggregationStrategy) Sets a reference to the AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast.aggregationStrategy
(org.apache.camel.AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast.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.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
Set theProcessor
to use when preparing theExchange
to be send using a fluent builder.Uses theProcessor
when preparing theExchange
to be send.onPrepare
(org.apache.camel.Processor onPrepare) Uses theProcessor
when preparing theExchange
to be send.If enabled then the aggregate method on AggregationStrategy can be called concurrently.If enabled then sending messages to the multicasts occurs concurrently.parallelProcessing
(boolean parallelProcessing) If enabled then sending messages to the multicasts occurs concurrently.void
setAggregationStrategy
(String aggregationStrategy) Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast.void
setAggregationStrategy
(org.apache.camel.AggregationStrategy aggregationStrategy) Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast.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
setExecutorService
(String executorService) Refers to a custom Thread Pool to be used for parallel processing.void
setOnPrepare
(String onPrepare) void
setOutputs
(List<ProcessorDefinition<?>> outputs) 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.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.If enabled then Camel will process replies out-of-order, eg in the order they come back.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.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, configureChild, 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, id, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, 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, 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, preCreateProcessor, 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, 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, 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, description, getCamelContext, getCustomId, getDescription, getDescriptionText, getId, getLineNumber, getLocation, hasCustomIdAssigned, idOrCreate, setCamelContext, setCustomId, setDescription, setGeneratedId, setId, setLineNumber, setLocation
-
Constructor Details
-
MulticastDefinition
public MulticastDefinition()
-
-
Method Details
-
getOutputs
- Overrides:
getOutputs
in classOutputDefinition<MulticastDefinition>
-
setOutputs
- Overrides:
setOutputs
in classOutputDefinition<MulticastDefinition>
-
toString
- Overrides:
toString
in classOutputDefinition<MulticastDefinition>
-
getShortName
- Specified by:
getShortName
in interfaceorg.apache.camel.NamedNode
- Overrides:
getShortName
in classOutputDefinition<MulticastDefinition>
-
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 classProcessorDefinition<MulticastDefinition>
-
aggregationStrategy
Sets the AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast using a fluent builder. -
aggregationStrategy
public MulticastDefinition aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy. If an exception is thrown from the aggregate method in the AggregationStrategy, then by default, that exception is not handled by the error handler. The error handler can be enabled to react if enabling the shareUnitOfWork option. -
aggregationStrategy
Sets a reference to the AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy. If an exception is thrown from the aggregate method in the AggregationStrategy, then by default, that exception is not handled by the error handler. The error handler can be enabled to react if enabling the shareUnitOfWork option. -
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
-
parallelProcessing
If enabled then sending messages to the multicasts occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the multicasts which happens concurrently.- Returns:
- the builder
-
parallelProcessing
If enabled then sending messages to the multicasts occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only the sending and processing the replies from the multicasts 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
-
streaming
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 defined by the multicast.- 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 multicast 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 multicast 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<MulticastDefinition>
- 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<MulticastDefinition>
- Parameters:
executorService
- reference for aExecutorService
to lookup in theRegistry
- Returns:
- the builder
-
onPrepare
Set theProcessor
to use when preparing theExchange
to be send using a fluent builder. -
onPrepare
Uses theProcessor
when preparing theExchange
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
-
onPrepare
Uses theProcessor
when preparing theExchange
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
- 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 Multicast hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Multicast 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 Multicast hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Multicast 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<MulticastDefinition>
-
getExecutorServiceRef
Description copied from interface:ExecutorServiceAwareDefinition
Gets a reference id to lookup the executor service from the registry- Specified by:
getExecutorServiceRef
in interfaceExecutorServiceAwareDefinition<MulticastDefinition>
-
getParallelProcessing
-
setParallelProcessing
-
getStreaming
-
setStreaming
-
getStopOnException
-
setStopOnException
-
getAggregationStrategy
-
setAggregationStrategy
Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy -
setAggregationStrategy
public void setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast. By default Camel will use the last reply as the outgoing message. 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 -
getExecutorService
-
setExecutorService
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. -
getTimeout
-
setTimeout
-
getParallelAggregate
-
setParallelAggregate
-
getOnPrepare
-
setOnPrepare
-