Name

Recipient List — Routes messages to a number of dynamically specified recipients

Usage

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.

Properties

Table 23 describes the properties you can specify using the properties editor.

Table 23. Recipient List Properties

NameDescription
ExpressionSpecifies the expression used to generate the list of recipients.
languageSpecifies the expression language used to process the expression.
Parallel ProcessingSpecifies whether the recipient list can send messages to multiple recipients concurrently. The default is Disabled.
TimeoutSpecifies the amount of time, in milliseconds, the node will attempt to deliver a message before timing out.
Executor Service RefSpecifies a reference for looking up the executorService to use for thread pool management.
Strategy RefSpecifies a reference for looking up the AggregationStrategy in the registry.
Share Unit of WorkSpecifies whether all of the resulting exchanges are considered a single shared unit of work. The default is Disabled.
Stop On ExceptionSpecifies whether the node will stop all processing if one of the endpoints receiving a message throws an exception. The default is Disabled.
DelimiterSpecifies a delimiter to separate the list of endpoint URIs in the generated recipient list.
Inherit Error HandlerSpecifies whether the node should use the error handler configured for the route. The default is Disabled.
Ignore Invalid EndpointsSpecifies 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 onPrepare processor that processes the original message before it is passed to the list of specified destinations.

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.

StreamingSpecifies whether the recipient list works in streaming mode. The default is Disabled.
IdSpecifies a unique identifier for the endpoint. The Id can be used to refer to the endpoint in the Camel XML file.
DescriptionSpecifies 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.

Related topics

Expression and Predicates Languages
Configuring the route editor