org.apache.camel.model

Class RecipientListDefinition<Type extends ProcessorDefinition<Type>>

java.lang.Object

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

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

org.apache.camel.model.ExpressionNode

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

All Implemented Interfaces:

org.apache.camel.ExecutorServiceAware, Block, DefinitionPropertyPlaceholderConfigurer, ExecutorServiceAwareDefinition<RecipientListDefinition<Type>>, OtherAttributesAware, org.apache.camel.NamedNode, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

@Metadata(label="eip,endpoint,routing")
public class RecipientListDefinition<Type extends ProcessorDefinition<Type>>
extends ExpressionNode
implements ExecutorServiceAwareDefinition<RecipientListDefinition<Type>>

Routes messages to a number of dynamically specified recipients (dynamic to)

Field Summary

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

inheritErrorHandler, log

Constructor Summary

Constructors

Constructor and Description
RecipientListDefinition()
RecipientListDefinition(org.apache.camel.Expression expression)
RecipientListDefinition(ExpressionDefinition expression)

Method Summary

Modifier and Type	Method and Description
RecipientListDefinition<Type>	aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList.
RecipientListDefinition<Type>	aggregationStrategy(Supplier<org.apache.camel.AggregationStrategy> aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList.
RecipientListDefinition<Type>	aggregationStrategyMethodAllowNull() If this option is false then the aggregate method is not used if there was no data to enrich.
RecipientListDefinition<Type>	aggregationStrategyMethodName(String methodName) This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.
RecipientListDefinition<Type>	aggregationStrategyRef(String aggregationStrategyRef) Sets a reference to the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList.
RecipientListDefinition<Type>	cacheSize(int cacheSize) Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused.
RecipientListDefinition<Type>	delimiter(String delimiter) Delimiter used if the Expression returned multiple endpoints.
Type	end() Ends the current block
RecipientListDefinition<Type>	executorService(ExecutorService executorService) To use a custom Thread Pool to be used for parallel processing.
RecipientListDefinition<Type>	executorServiceRef(String executorServiceRef) Refers to a custom Thread Pool to be used for parallel processing.
org.apache.camel.AggregationStrategy	getAggregationStrategy()
Integer	getCacheSize()
String	getDelimiter()
ExecutorService	getExecutorService()
String	getExecutorServiceRef()
Boolean	getIgnoreInvalidEndpoints()
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()
Boolean	getParallelAggregate()
Boolean	getParallelProcessing()
Boolean	getShareUnitOfWork()
String	getShortName()
Boolean	getStopOnAggregateException()
Boolean	getStopOnException()
Boolean	getStrategyMethodAllowNull()
String	getStrategyMethodName()
String	getStrategyRef()
Boolean	getStreaming()
Long	getTimeout()
RecipientListDefinition<Type>	ignoreInvalidEndpoints() Ignore the invalidate endpoint exception when try to create a producer with that endpoint
ProcessClause<RecipientListDefinition<Type>>	onPrepare() Sets the Processor when preparing the Exchange to be used send using a fluent buidler.
RecipientListDefinition<Type>	onPrepare(org.apache.camel.Processor onPrepare) Uses the Processor when preparing the Exchange to be used send.
RecipientListDefinition<Type>	onPrepare(Supplier<org.apache.camel.Processor> onPrepare) Uses the Processor when preparing the Exchange to be used send.
RecipientListDefinition<Type>	onPrepareRef(String onPrepareRef) Uses the Processor when preparing the Exchange to be send.
RecipientListDefinition<Type>	parallelAggregate() If enabled then the aggregate method on AggregationStrategy can be called concurrently.
RecipientListDefinition<Type>	parallelProcessing() If enabled then sending messages to the recipients occurs concurrently.
RecipientListDefinition<Type>	parallelProcessing(boolean parallelProcessing) If enabled then sending messages to the recipients occurs concurrently.
void	setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList.
void	setCacheSize(Integer cacheSize)
void	setDelimiter(String delimiter)
void	setExecutorService(ExecutorService executorService)
void	setExecutorServiceRef(String executorServiceRef)
void	setExpression(ExpressionDefinition expression) Expression that returns which endpoints (url) to send the message to (the recipients).
void	setIgnoreInvalidEndpoints(Boolean ignoreInvalidEndpoints)
void	setOnPrepare(org.apache.camel.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 recipients, into a single outgoing message from the RecipientList.
void	setStreaming(Boolean streaming)
void	setTimeout(Long timeout)
RecipientListDefinition<Type>	shareUnitOfWork() Shares the UnitOfWork with the parent and each of the sub messages.
RecipientListDefinition<Type>	stopOnAggregateException() If enabled, unwind exceptions occurring at aggregation time to the error handler when parallelProcessing is used.
RecipientListDefinition<Type>	stopOnException() Will now stop further processing if an exception or failure occurred during processing of an Exchange and the caused exception will be thrown.
RecipientListDefinition<Type>	streaming() If enabled then Camel will process replies out-of-order, eg in the order they come back.
RecipientListDefinition<Type>	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, getExpression, getOutputs, id, preCreateProcessor, setExpression

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

addInterceptStrategy, addOutput, aggregate, aggregate, aggregate, aggregate, attribute, bean, bean, bean, bean, bean, bean, bean, bean, bean, choice, claimCheck, claimCheck, claimCheck, claimCheck, clearOutput, convertBodyTo, convertBodyTo, delay, delay, delay, doTry, dynamicRouter, dynamicRouter, endChoice, endDoTry, endHystrix, endParent, endRest, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrich, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, enrichWith, filter, filter, filter, filter, getIndex, getInterceptStrategies, getOtherAttributes, getParent, hystrix, idempotentConsumer, idempotentConsumer, idempotentConsumer, inheritErrorHandler, inOnly, inOnly, inOnly, inOnly, inOnly, inOut, inOut, inOut, inOut, inOut, isAbstract, isInheritErrorHandler, isTopLevelOnly, isWrappingEntireOutput, 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, placeholder, 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, 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, script, script, serviceCall, serviceCall, serviceCall, setBody, setBody, setBody, setBody, setExchangePattern, setHeader, setHeader, setHeader, setInheritErrorHandler, setOtherAttributes, setParent, setProperty, setProperty, sort, sort, sort, 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, 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, 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

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

getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

Constructor Detail

RecipientListDefinition

public RecipientListDefinition()

RecipientListDefinition

public RecipientListDefinition(ExpressionDefinition expression)

RecipientListDefinition

public RecipientListDefinition(org.apache.camel.Expression expression)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getShortName

public String getShortName()

Specified by:

getShortName in interface org.apache.camel.NamedNode

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 ExpressionNode

end

public Type end()

Description copied from class: ProcessorDefinition

Ends the current block

Overrides:

end in class ProcessorDefinition<ExpressionNode>

Returns:

the builder

delimiter

public RecipientListDefinition<Type> delimiter(String delimiter)

Delimiter used if the Expression returned multiple endpoints. Can be turned off using the value false.

The default value is ,

Parameters:

delimiter - the delimiter

Returns:

the builder

aggregationStrategy

public RecipientListDefinition<Type> aggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy)

Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy

aggregationStrategy

public RecipientListDefinition<Type> aggregationStrategy(Supplier<org.apache.camel.AggregationStrategy> aggregationStrategy)

Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy

aggregationStrategyRef

public RecipientListDefinition<Type> aggregationStrategyRef(String aggregationStrategyRef)

Sets a reference to the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy

aggregationStrategyMethodName

public RecipientListDefinition<Type> 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 RecipientListDefinition<Type> 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

ignoreInvalidEndpoints

public RecipientListDefinition<Type> ignoreInvalidEndpoints()

Ignore the invalidate endpoint exception when try to create a producer with that endpoint

Returns:

the builder

parallelProcessing

public RecipientListDefinition<Type> parallelProcessing()

If enabled then sending messages to the recipients 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 recipients which happens concurrently.

Returns:

the builder

parallelProcessing

public RecipientListDefinition<Type> parallelProcessing(boolean parallelProcessing)

If enabled then sending messages to the recipients 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 recipients which happens concurrently.

Returns:

the builder

parallelAggregate

public RecipientListDefinition<Type> 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 RecipientListDefinition<Type> 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 RecipientListDefinition<Type> 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 recipient list.

Returns:

the builder

stopOnException

public RecipientListDefinition<Type> 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 recipient list 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 RecipientListDefinition<Type> 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<RecipientListDefinition<Type extends ProcessorDefinition<Type>>>

Parameters:

executorService - the executor service

Returns:

the builder

executorServiceRef

public RecipientListDefinition<Type> 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<RecipientListDefinition<Type extends ProcessorDefinition<Type>>>

Parameters:

executorServiceRef - reference for a ExecutorService to lookup in the Registry

Returns:

the builder

onPrepare

public RecipientListDefinition<Type> onPrepare(org.apache.camel.Processor onPrepare)

Uses the Processor when preparing the Exchange to be used 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

public RecipientListDefinition<Type> onPrepare(Supplier<org.apache.camel.Processor> onPrepare)

Uses the Processor when preparing the Exchange to be used 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

public ProcessClause<RecipientListDefinition<Type>> onPrepare()

Sets the Processor when preparing the Exchange to be used send using a fluent buidler.

onPrepareRef

public RecipientListDefinition<Type> 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 RecipientListDefinition<Type> timeout(long timeout)

Sets a total timeout specified in millis, when using parallel processing. If the Recipient List hasn't been able to send and process all replies within the given timeframe, then the timeout triggers and the Recipient List 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 RecipientListDefinition<Type> shareUnitOfWork()

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

Returns:

the builder.

cacheSize

public RecipientListDefinition<Type> cacheSize(int cacheSize)

Sets the maximum size used by the ProducerCache which is used to cache and reuse producers when using this recipient list, when uris are reused.

Parameters:

cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.

Returns:

the builder

setExpression

public void setExpression(ExpressionDefinition expression)

Expression that returns which endpoints (url) to send the message to (the recipients). If the expression return an empty value then the message is not sent to any recipients.

Overrides:

setExpression in class ExpressionNode

getDelimiter

public String getDelimiter()

setDelimiter

public void setDelimiter(String delimiter)

getParallelProcessing

public Boolean getParallelProcessing()

setParallelProcessing

public void setParallelProcessing(Boolean parallelProcessing)

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 recipients, into a single outgoing message from the RecipientList. 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 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()

Specified by:

getExecutorServiceRef in interface org.apache.camel.ExecutorServiceAware

setExecutorServiceRef

public void setExecutorServiceRef(String executorServiceRef)

Specified by:

setExecutorServiceRef in interface org.apache.camel.ExecutorServiceAware

getIgnoreInvalidEndpoints

public Boolean getIgnoreInvalidEndpoints()

setIgnoreInvalidEndpoints

public void setIgnoreInvalidEndpoints(Boolean ignoreInvalidEndpoints)

getStopOnException

public Boolean getStopOnException()

setStopOnException

public void setStopOnException(Boolean stopOnException)

getAggregationStrategy

public org.apache.camel.AggregationStrategy getAggregationStrategy()

setAggregationStrategy

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

Sets the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList. By default Camel will use the last reply as the outgoing message. You can also use a POJO as the AggregationStrategy

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

getStreaming

public Boolean getStreaming()

setStreaming

public void setStreaming(Boolean streaming)

getTimeout

public Long getTimeout()

setTimeout

public void setTimeout(Long 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 Boolean getShareUnitOfWork()

setShareUnitOfWork

public void setShareUnitOfWork(Boolean shareUnitOfWork)

getCacheSize

public Integer getCacheSize()

setCacheSize

public void setCacheSize(Integer cacheSize)

getParallelAggregate

public Boolean getParallelAggregate()

setParallelAggregate

public void setParallelAggregate(Boolean parallelAggregate)

getStopOnAggregateException

public Boolean getStopOnAggregateException()

setStopOnAggregateException

public void setStopOnAggregateException(Boolean stopOnAggregateException)