Class RecipientListDefinition<Type extends ProcessorDefinition<Type>>
- All Implemented Interfaces:
org.apache.camel.CamelContextAware
,org.apache.camel.LineNumberAware
,Block
,ExecutorServiceAwareDefinition<RecipientListDefinition<Type>>
,HasExpressionType
,org.apache.camel.NamedNode
,org.apache.camel.spi.HasId
,org.apache.camel.spi.IdAware
-
Field Summary
Fields inherited from class org.apache.camel.model.ProcessorDefinition
disabled, inheritErrorHandler
-
Constructor Summary
ConstructorsConstructorDescriptionRecipientListDefinition
(org.apache.camel.Expression expression) RecipientListDefinition
(ExpressionDefinition expression) -
Method Summary
Modifier and TypeMethodDescriptionaggregationStrategy
(String aggregationStrategy) Sets a reference to the AggregationStrategy to be used to assemble the replies from the recipients, into a single outgoing message from the RecipientList.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.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.cacheSize
(int cacheSize) Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this recipient list, when uris are reused.Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this recipient list, when uris are reused.Delimiter used if the Expression returned multiple endpoints.end()
Ends the current blockexecutorService
(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
Ignore the invalidate endpoint exception when try to create a producer with that endpointSets theProcessor
when preparing theExchange
to be used send using a fluent buidler.Uses theProcessor
when preparing theExchange
to be send.onPrepare
(org.apache.camel.Processor onPrepare) Uses theProcessor
when preparing theExchange
to be used send.If enabled then the aggregate method on AggregationStrategy can be called concurrently.If enabled then sending messages to the recipients occurs concurrently.parallelProcessing
(boolean parallelProcessing) If enabled then sending messages to the recipients occurs concurrently.void
setAggregationStrategy
(String aggregationStrategy) void
setAggregationStrategy
(org.apache.camel.AggregationStrategy aggregationStrategy) void
setAggregationStrategyMethodAllowNull
(String aggregationStrategyMethodAllowNull) void
setAggregationStrategyMethodName
(String aggregationStrategyMethodName) void
setCacheSize
(String cacheSize) void
setDelimiter
(String delimiter) void
setExecutorService
(String executorService) void
setExpression
(ExpressionDefinition expression) Expression that returns which endpoints (url) to send the message to (the recipients).void
setIgnoreInvalidEndpoints
(String ignoreInvalidEndpoints) void
setOnPrepare
(String onPrepare) void
setOnPrepareProcessor
(org.apache.camel.Processor onPrepareProcessor) 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.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.toString()
Methods inherited from class org.apache.camel.model.ExpressionNode
configureChild, getExpression, getExpressionType, getOutputs, 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, 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
-
RecipientListDefinition
public RecipientListDefinition() -
RecipientListDefinition
-
RecipientListDefinition
public RecipientListDefinition(org.apache.camel.Expression expression)
-
-
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
-
end
Description copied from class:ProcessorDefinition
Ends the current block- Overrides:
end
in classProcessorDefinition<ExpressionNode>
- Returns:
- the builder
-
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
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
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
-
ignoreInvalidEndpoints
Ignore the invalidate endpoint exception when try to create a producer with that endpoint- Returns:
- the builder
-
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
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
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 recipient list.- 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 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
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 interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
- 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 automatic implied, and you do not have to enable that option as well.- Specified by:
executorService
in interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
- Parameters:
executorService
- reference for aExecutorService
to lookup in theRegistry
- Returns:
- the builder
-
onPrepare
Uses theProcessor
when preparing theExchange
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
Sets theProcessor
when preparing theExchange
to be used send using a fluent buidler. -
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:
ref
- 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 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
-
cacheSize
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this recipient list, when uris are reused.Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn of caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches.
However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000).
If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.
- Parameters:
cacheSize
- the cache size, use 0 for default cache size, or -1 to turn cache off.- Returns:
- the builder
-
cacheSize
Sets the maximum size used by theProducerCache
which is used to cache and reuse producers when using this recipient list, when uris are reused.Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then its best to turn of caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches.
However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000).
If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non frequent used producers.
- Parameters:
cacheSize
- the cache size, use 0 for default cache size, or -1 to turn cache off.- Returns:
- the builder
-
getAggregationStrategyBean
public org.apache.camel.AggregationStrategy getAggregationStrategyBean() -
getExecutorServiceBean
Description copied from interface:ExecutorServiceAwareDefinition
Gets the executor service for executing- Specified by:
getExecutorServiceBean
in interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
-
getExecutorServiceRef
Description copied from interface:ExecutorServiceAwareDefinition
Gets a reference id to lookup the executor service from the registry- Specified by:
getExecutorServiceRef
in interfaceExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
-
setExpression
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 classExpressionNode
-
getDelimiter
-
setDelimiter
-
getParallelProcessing
-
setParallelProcessing
-
getIgnoreInvalidEndpoints
-
setIgnoreInvalidEndpoints
-
getStopOnException
-
setStopOnException
-
getAggregationStrategy
-
setAggregationStrategy
-
setAggregationStrategy
public void setAggregationStrategy(org.apache.camel.AggregationStrategy aggregationStrategy) -
getAggregationStrategyMethodName
-
setAggregationStrategyMethodName
-
getAggregationStrategyMethodAllowNull
-
setAggregationStrategyMethodAllowNull
-
getStreaming
-
setStreaming
-
getTimeout
-
setTimeout
-
getOnPrepare
-
setOnPrepare
-
getOnPrepareProcessor
public org.apache.camel.Processor getOnPrepareProcessor() -
setOnPrepareProcessor
public void setOnPrepareProcessor(org.apache.camel.Processor onPrepareProcessor) -
getCacheSize
-
setCacheSize
-
getParallelAggregate
-
setParallelAggregate
-
getExecutorService
-
setExecutorService
-