Recipient List — Routes messages to a number of dynamically specified recipients
The Recipient List pattern sends a copy of the incoming message to a list of endpoints. The list of endpoints is dynamically generated at runtime.
The Recipient List pattern can appear anywhere in the body of a route. It must be followed by two or more destinations.
Table 24 describes the properties you can specify using the properties editor.
Table 24. Recipient List Properties
Name | Description |
---|---|
Expression | Specifies the expression used to generate the list of recipients. |
language | Specifies the expression language used to process the expression. |
Timeout | Specifies the amount of time, in milliseconds, the node will attempt to deliver a message before timing out. |
Parallel Processing | Specifies whether the recipient list can send messages to multiple recipients
concurrently. The default is Disabled . |
Executor Service Ref | Specifies a reference for looking up the
executorService to use for
thread pool management. |
Strategy Ref | Specifies a reference for looking up the
AggregationStrategy in the registry. |
Share Unit of Work | Specifies whether all of the resulting exchanges are considered a single shared
unit of work. The default is Disabled . |
Stop On Exception | Specifies whether the node will stop all processing if one of the endpoints
receiving a message throws an exception. The default is
Disabled . |
Delimiter | Specifies a delimiter to separate the list of endpoint URIs in the generated recipient list. |
Strategy Method Allow Null | Specifies whether the aggregate method is not used when there was no data to
enrich. When disabled, the aggregate method is not used. When enabled,
null values are used as the oldExchange
when POJOs are used as the
AggregationStrategy . The default is
Disabled . |
Inherit Error Handler | Specifies whether the node should use the error handler configured for the route.
The default is Disabled . |
Ignore Invalid Endpoints | Specifies whether router will skip steps that are invalid without throwing an
exception. The default is Disabled . |
On Prepare Ref | Specifies a reference to a bean implementing a custom This property enables you to deep clone mutable message bodies, so each destination receives a separate copy of the entire exchange. You can use this property to execute any kind of logic on a message exchange. |
Streaming | Specifies whether the recipient list works in streaming mode. The default is
Disabled . |
Id | Specifies a unique identifier for the endpoint. The Id can be used to refer to the endpoint in the Camel XML file. |
Description | Specifies a text description for the node. This description is included in the generated XML file, but it is informational only. It is not used by Apache Camel. |