Split

Split

Table of Contents

Usage
Properties
Related topics

Sorts the contents of the message

Usage

The Split pattern breaks a message into a number of smaller messages based on an expression. When used in routes whose exchange pattern is in-out, the Split pattern can either return a copy of the original message or use an aggregation strategy to recombine the responses into a reply.

Properties

Table 56, “Split Properties” describes the properties you can specify using the properties editor.

Table 56. Split Properties

Name	Description
`Language`	Specifies the expression language used to process the expression.
`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.
`Executor Service Ref`	Specifies a reference for looking up the executorService to use for thread pool management.
`Id`	Specifies a unique identifier for the endpoint. The tooling automatically generates an id for a node when it is created, but you can remove that id or replace it with your own. The Camel debugger requires all nodes with a breakpoint set to have a unique id. You can use the id to refer to endpoints in your Camel XML file.
`On Prepare Ref`	Specifies a reference to a bean implementing a custom `onPrepare` processor that processes the original message before/ it is split up and passed to the next step in the route. This property enables you to deep clone mutable message bodies, so the splitter creates separate, self-contained fragments of the message. You can use this property to execute any kind of logic on a message exchange.
`Parallel Aggregate`	Specifies whether the aggregate method on the AggregationStrategy can be called concurrently. Enable this option only when the AggregationStrategy is thread-safe. The default is Disabled.
`Parallel Processing`	Specifies whether the splitter can send messages to multiple destinations concurrently. The default is Disabled.
`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.
`Strategy Method Allow Null`	Specifies whether the aggregate method is used for first split message. When disabled, it is not used. When enabled, null values are used as the `oldExchange` for the first message split, when POJOs are used as the `AggregationStrategy`. The default is Disabled.
`Strategy Method Name`	This property can be used to explicitly declare the method name to use when using POJOs as the AggregationStrategy.
`Strategy Ref`	Specifies a reference for looking up the AggregationStrategy in the registry.
`Streaming`	Specifies whether the splitter works in streaming mode. The default is Disabled.
`Timeout`	Specifies the amount of time, in milliseconds, the node will attempt to deliver a message before timing out.

Related topics