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.ExecutorServiceAware, 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

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
MulticastDefinition()

Method Summary

Modifier and Type	Method and Description
AggregationStrategyClause<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.
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.
MulticastDefinition	aggregationStrategy(Supplier<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.
MulticastDefinition	aggregationStrategyMethodAllowNull() If this option is false then the aggregate method is not used if there was no data to enrich.
MulticastDefinition	aggregationStrategyMethodName(String methodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
MulticastDefinition	aggregationStrategyRef(String aggregationStrategyRef) Sets a reference to the AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast.
MulticastDefinition	executorService(ExecutorService executorService) To use a custom Thread Pool to be used for parallel processing.
MulticastDefinition	executorServiceRef(String executorServiceRef) Refers to a custom Thread Pool to be used for parallel processing.
org.apache.camel.AggregationStrategy	getAggregationStrategy()
ExecutorService	getExecutorService()
String	getExecutorServiceRef()
String	getLabel() Returns a label to describe this node such as the expression if some kind of expression node
org.apache.camel.Processor	getOnPrepare()
String	getOnPrepareRef()
List<ProcessorDefinition<?>>	getOutputs()
String	getParallelAggregate()
String	getParallelProcessing()
String	getShareUnitOfWork()
String	getShortName()
String	getStopOnAggregateException()
String	getStopOnException()
String	getStrategyMethodAllowNull()
String	getStrategyMethodName()
String	getStrategyRef()
String	getStreaming()
String	getTimeout()
ProcessClause<MulticastDefinition>	onPrepare() Set the Processor to use when preparing the Exchange to be send using a fluent builder.
MulticastDefinition	onPrepare(org.apache.camel.Processor onPrepare) Uses the Processor when preparing the Exchange to be send.
MulticastDefinition	onPrepareRef(String onPrepareRef) Uses the Processor when preparing the Exchange to be send.
MulticastDefinition	parallelAggregate() If enabled then the aggregate method on AggregationStrategy can be called concurrently.
MulticastDefinition	parallelProcessing() If enabled then sending messages to the multicasts occurs concurrently.
MulticastDefinition	parallelProcessing(boolean parallelProcessing) If enabled then sending messages to the multicasts occurs concurrently.
MulticastDefinition	setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)
void	setExecutorService(ExecutorService executorService)
void	setExecutorServiceRef(String executorServiceRef) Refers to a custom Thread Pool to be used for parallel processing.
void	setOnPrepare(org.apache.camel.Processor onPrepare)
void	setOnPrepareRef(String onPrepareRef)
void	setOutputs(List<ProcessorDefinition<?>> outputs)
void	setParallelAggregate(String parallelAggregate)
void	setParallelProcessing(String parallelProcessing)
void	setShareUnitOfWork(String shareUnitOfWork)
void	setStopOnAggregateException(String stopOnAggregateException)
void	setStopOnException(String stopOnException)
void	setStrategyMethodAllowNull(String 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) Refers to an AggregationStrategy to be used to assemble the replies from the multicasts, into a single outgoing message from the Multicast.
void	setStreaming(String streaming)
void	setTimeout(String timeout)
MulticastDefinition	shareUnitOfWork() Shares the UnitOfWork with the parent and each of the sub messages.
MulticastDefinition	stopOnAggregateException() If enabled, unwind exceptions occurring at aggregation time to the error handler when parallelProcessing is used.
MulticastDefinition	stopOnException() Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown.
MulticastDefinition	stopOnException(String stopOnException) Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown.
MulticastDefinition	streaming() If enabled then Camel will process replies out-of-order, eg in the order they come back.
MulticastDefinition	timeout(long timeout) Sets a total timeout specified in millis, when using parallel processing.
MulticastDefinition	timeout(String timeout) Sets a total timeout specified in millis, when using parallel processing.
String	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, doTry, dynamicRouter, dynamicRouter, end, endChoice, endCircuitBreaker, endDoTry, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getParent, 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, onCompletion, onException, onException, 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, rollback, rollback, routeDescription, routeGroup, routeId, routingSlip, routingSlip, routingSlip, saga, sample, sample, sample, sample, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setParent, setProperty, setProperty, setProperty, 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, validate, validate, validate, wireTap, wireTap, wireTap

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.model.ExecutorServiceAwareDefinition

executorService

Constructor Detail

MulticastDefinition

public MulticastDefinition()

Method Detail

getOutputs

public List<ProcessorDefinition<?>> getOutputs()

Overrides:

getOutputs in class OutputDefinition<MulticastDefinition>

setOutputs

public void setOutputs(List<ProcessorDefinition<?>> outputs)

Overrides:

setOutputs in class OutputDefinition<MulticastDefinition>

toString

public String toString()

Overrides:

toString in class OutputDefinition<MulticastDefinition>

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

Overrides:

getShortName in class OutputDefinition<MulticastDefinition>

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 org.apache.camel.NamedNode

Overrides:

getLabel in class ProcessorDefinition<MulticastDefinition>

aggregationStrategy

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

public MulticastDefinition aggregationStrategy(Supplier<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.

aggregationStrategyRef

public MulticastDefinition aggregationStrategyRef(String aggregationStrategyRef)

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.

The value can either refer to a bean to lookup, or to lookup a singleton bean by its type, or to create a new bean:

• Lookup bean - This is the default behavior to lookup an existing bean by the bean id (value)
• reference by type - Values can refer to singleton beans by their type in the registry by prefixing with #type: syntax, eg #type:com.foo.MyClassType
• reference new class - Values can refer to creating new beans by their class name by prefixing with #class, eg #class:com.foo.MyClassType. The class is created using a default no-arg constructor, however if you need to create the instance via a factory method then you specify the method as shown: #class:com.foo.MyClassType#myFactoryMethod. And if the factory method requires parameters they can be specified as follows: #class:com.foo.MyClassType#myFactoryMethod('Hello World', 5, true). Or if you need to create the instance via constructor parameters then you can specify the parameters as shown: #class:com.foo.MyClass('Hello World', 5, true)
.

aggregationStrategyMethodName

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

public MulticastDefinition parallelProcessing(boolean 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

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

stopOnAggregateException

public MulticastDefinition stopOnAggregateException()

If enabled, unwind exceptions occurring at aggregation time to the error handler when parallelProcessing is used. Currently, aggregation time exceptions do not stop the route processing when parallelProcessing is used. Enabling this option allows to work around this behavior. The default value is false for the sake of backward compatibility.

Returns:

the builder

streaming

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

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

public MulticastDefinition stopOnException(String 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 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

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

Parameters:

executorService - the executor service

Returns:

the builder

executorServiceRef

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

Parameters:

executorServiceRef - reference for a ExecutorService to lookup in the Registry

Returns:

the builder

onPrepare

public ProcessClause<MulticastDefinition> onPrepare()

Set the Processor to use when preparing the Exchange to be send using a fluent builder.

onPrepare

public MulticastDefinition onPrepare(org.apache.camel.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 MulticastDefinition 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 MulticastDefinition timeout(long 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

public MulticastDefinition timeout(String 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

shareUnitOfWork

public MulticastDefinition shareUnitOfWork()

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

Returns:

the builder.

getAggregationStrategy

public org.apache.camel.AggregationStrategy getAggregationStrategy()

setAggregationStrategy

public MulticastDefinition setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)

getParallelProcessing

public String getParallelProcessing()

setParallelProcessing

public void setParallelProcessing(String parallelProcessing)

getStreaming

public String getStreaming()

setStreaming

public void setStreaming(String streaming)

getStopOnException

public String getStopOnException()

setStopOnException

public void setStopOnException(String stopOnException)

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface org.apache.camel.ExecutorServiceAware

setExecutorService

public void setExecutorService(ExecutorService executorService)

Specified by:

setExecutorService in interface org.apache.camel.ExecutorServiceAware

getStrategyRef

public String getStrategyRef()

setStrategyRef

public void setStrategyRef(String strategyRef)

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

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 String getStrategyMethodAllowNull()

setStrategyMethodAllowNull

public void setStrategyMethodAllowNull(String 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()

Specified by:

getExecutorServiceRef in interface org.apache.camel.ExecutorServiceAware

setExecutorServiceRef

public void setExecutorServiceRef(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:

setExecutorServiceRef in interface org.apache.camel.ExecutorServiceAware

getTimeout

public String getTimeout()

setTimeout

public void setTimeout(String timeout)

getOnPrepareRef

public String getOnPrepareRef()

setOnPrepareRef

public void setOnPrepareRef(String onPrepareRef)

getOnPrepare

public org.apache.camel.Processor getOnPrepare()

setOnPrepare

public void setOnPrepare(org.apache.camel.Processor onPrepare)

getShareUnitOfWork

public String getShareUnitOfWork()

setShareUnitOfWork

public void setShareUnitOfWork(String shareUnitOfWork)

getParallelAggregate

public String getParallelAggregate()

setParallelAggregate

public void setParallelAggregate(String parallelAggregate)

getStopOnAggregateException

public String getStopOnAggregateException()

setStopOnAggregateException

public void setStopOnAggregateException(String stopOnAggregateException)