Multicast — Routes a message to a number of endpoints
The Multicast pattern shallow copies the original exchange and routes the copies to multiple endpoints, without modifying the message. Each endpoint gets a copy of the same message. If the route's exchange pattern is in-out, the Multicast pattern aggregates the responses into a single message.
The Multicast pattern can appear at any point in the body of a route. It must be followed by two or more destinations.
Table 21 describes the properties you can specify using the properties editor.
Table 21. Multicast Properties
Name | Description |
---|---|
Timeout | Specifies the amount of time, in milliseconds, the node will attempt to deliver a message before timing out. |
Streaming | Specifies whether multicast operates in streaming mode. 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 gets a separate copy of the entire exchange. You can use this property to execute any kind of logic on a message exchange. |
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 . |
Strategy Ref | Specifies a reference for looking up the
AggregationStrategy in the registry. |
Inherit Error Handler | Specifies whether the node should use the error handler configured for the route.
The default is Disabled . |
Strategy Method Name | Specifies the method name to use when POJOs are used as the
AggregationStrategy . |
Strategy method Allow Null | Specifies whether the aggregate method is used when there is no data to
enrich. When disabled, it is not used. When enabled, null values are
used as the oldExchange when POJOs are used as the
AggregationStrategy . The default is
Disabled . |
Parallel Processing | Specifies whether the multicast messages are forwarded to multiple destinations
concurrently. The default is Disabled . |
Executor Service Ref | Specifies a reference for looking up the
executorService to use for
thread pool management. |
Share Unit of Work | Specifies whether all of the resulting exchanges are considered a single
shared unit of work. 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. |