Package org.apache.camel.model

Class SplitDefinition

    • Constructor Detail

      • SplitDefinition

        public SplitDefinition()

      • SplitDefinition

        public SplitDefinition​(org.apache.camel.Expression expression)

    • Method Detail

      • getShortName

        public String getShortName()
        Specified by:
        getShortName in interface org.apache.camel.NamedNode

      • getLabel

        public String 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 interface org.apache.camel.NamedNode
        Overrides:
        getLabel in class ExpressionNode

      • delimiter

        public SplitDefinition delimiter​(String delimiter)
        Delimiter used in splitting messages. Can be turned off using the value false.

        The default value is ,

        Parameters:
        delimiter - the delimiter
        Returns:
        the builder

      • aggregationStrategy

        public SplitDefinition aggregationStrategy​(org.apache.camel.AggregationStrategy aggregationStrategy)
        Sets the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

      • aggregationStrategy

        public SplitDefinition aggregationStrategy​(Supplier<org.apache.camel.AggregationStrategy> aggregationStrategy)
        Sets the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

      • aggregationStrategyRef

        public SplitDefinition aggregationStrategyRef​(String aggregationStrategyRef)
        Sets a reference to the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

        The value can either refer to a bean to lookup, or to lookup a singleton bean by its type, or to create a new bean:

        • Lookup bean - This is the default behavior to lookup an existing bean by the bean id (value)
        • reference by type - Values can refer to singleton beans by their type in the registry by prefixing with #type: syntax, eg #type:com.foo.MyClassType
        • reference new class - Values can refer to creating new beans by their class name by prefixing with #class, eg #class:com.foo.MyClassType. The class is created using a default no-arg constructor, however if you need to create the instance via a factory method then you specify the method as shown: #class:com.foo.MyClassType#myFactoryMethod. And if the factory method requires parameters they can be specified as follows: #class:com.foo.MyClassType#myFactoryMethod('Hello World', 5, true). Or if you need to create the instance via constructor parameters then you can specify the parameters as shown: #class:com.foo.MyClass('Hello World', 5, true)
          • .

      • aggregationStrategyMethodName

        public SplitDefinition aggregationStrategyMethodName​(String methodName)
        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

        public SplitDefinition 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

      • aggregationStrategyMethodAllowNull

        public SplitDefinition aggregationStrategyMethodAllowNull​(boolean 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

      • aggregationStrategyMethodAllowNull

        public SplitDefinition aggregationStrategyMethodAllowNull​(String 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

      • parallelProcessing

        public SplitDefinition parallelProcessing()
        If enabled then processing each splitted messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only processing the sub messages from the splitter which happens concurrently.
        Returns:
        the builder

      • parallelProcessing

        public SplitDefinition parallelProcessing​(boolean parallelProcessing)
        If enabled then processing each splitted messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only processing the sub messages from the splitter which happens concurrently.
        Returns:
        the builder

      • parallelProcessing

        public SplitDefinition parallelProcessing​(String parallelProcessing)
        If enabled then processing each splitted messages occurs concurrently. Note the caller thread will still wait until all messages has been fully processed, before it continues. Its only processing the sub messages from the splitter which happens concurrently.
        Returns:
        the builder

      • parallelAggregate

        public SplitDefinition 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

      • parallelAggregate

        public SplitDefinition parallelAggregate​(boolean 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

      • parallelAggregate

        public SplitDefinition parallelAggregate​(String 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

      • stopOnAggregateException

        public SplitDefinition stopOnAggregateException()
        If enabled, unwind exceptions occurring at aggregation time to the error handler when parallelProcessing is used. Currently, aggregation time exceptions do not stop the route processing when parallelProcessing is used. Enabling this option allows to work around this behavior. The default value is false for the sake of backward compatibility.
        Returns:
        the builder

      • stopOnAggregateException

        public SplitDefinition stopOnAggregateException​(boolean stopOnAggregateException)
        If enabled, unwind exceptions occurring at aggregation time to the error handler when parallelProcessing is used. Currently, aggregation time exceptions do not stop the route processing when parallelProcessing is used. Enabling this option allows to work around this behavior. The default value is false for the sake of backward compatibility.
        Returns:
        the builder

      • stopOnAggregateException

        public SplitDefinition stopOnAggregateException​(String stopOnAggregateException)
        If enabled, unwind exceptions occurring at aggregation time to the error handler when parallelProcessing is used. Currently, aggregation time exceptions do not stop the route processing when parallelProcessing is used. Enabling this option allows to work around this behavior. The default value is false for the sake of backward compatibility.
        Returns:
        the builder

      • streaming

        public SplitDefinition streaming()
        When in streaming mode, then the splitter splits the original message on-demand, and each splitted message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the Exchange.SPLIT_SIZE is empty.

        In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the splitted messages in memory and therefore requires more memory. The total size is provided in the Exchange.SPLIT_SIZE header.

        The streaming mode also affects the aggregation behavior. 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 the messages was splitted.

        Returns:
        the builder

      • streaming

        public SplitDefinition streaming​(boolean streaming)
        When in streaming mode, then the splitter splits the original message on-demand, and each splitted message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the Exchange.SPLIT_SIZE is empty.

        In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the splitted messages in memory and therefore requires more memory. The total size is provided in the Exchange.SPLIT_SIZE header.

        The streaming mode also affects the aggregation behavior. 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 the messages was splitted.

        Returns:
        the builder

      • streaming

        public SplitDefinition streaming​(String streaming)
        When in streaming mode, then the splitter splits the original message on-demand, and each splitted message is processed one by one. This reduces memory usage as the splitter do not split all the messages first, but then we do not know the total size, and therefore the Exchange.SPLIT_SIZE is empty.

        In non-streaming mode (default) the splitter will split each message first, to know the total size, and then process each message one by one. This requires to keep all the splitted messages in memory and therefore requires more memory. The total size is provided in the Exchange.SPLIT_SIZE header.

        The streaming mode also affects the aggregation behavior. 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 the messages was splitted.

        Returns:
        the builder

      • stopOnException

        public SplitDefinition stopOnException()
        Will now stop further processing if an exception or failure occurred during processing of an Exchange 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 splitter 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

      • stopOnException

        public SplitDefinition stopOnException​(boolean stopOnException)
        Will now stop further processing if an exception or failure occurred during processing of an Exchange 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 splitter 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

      • stopOnException

        public SplitDefinition stopOnException​(String stopOnException)
        Will now stop further processing if an exception or failure occurred during processing of an Exchange 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 splitter 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

        public SplitDefinition executorService​(ExecutorService 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 interface ExecutorServiceAwareDefinition<SplitDefinition>
        Parameters:
        executorService - the executor service
        Returns:
        the builder

      • executorServiceRef

        public SplitDefinition executorServiceRef​(String executorServiceRef)
        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:
        executorServiceRef in interface ExecutorServiceAwareDefinition<SplitDefinition>
        Parameters:
        executorServiceRef - reference for a ExecutorService to lookup in the Registry
        Returns:
        the builder

      • onPrepare

        public SplitDefinition onPrepare​(org.apache.camel.Processor onPrepare)
        Uses the Processor when preparing the Exchange 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:
        onPrepare - the processor
        Returns:
        the builder

      • onPrepareRef

        public SplitDefinition onPrepareRef​(String onPrepareRef)
        Uses the Processor when preparing the Exchange 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:
        onPrepareRef - reference to the processor to lookup in the Registry
        Returns:
        the builder

      • timeout

        public SplitDefinition timeout​(long timeout)
        Sets a total timeout specified in millis, when using parallel processing. If the Splitter hasn't been able to split and process all the sub messages within the given timeframe, then the timeout triggers and the Splitter 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

      • timeout

        public SplitDefinition timeout​(String timeout)
        Sets a total timeout specified in millis, when using parallel processing. If the Splitter hasn't been able to split and process all the sub messages within the given timeframe, then the timeout triggers and the Splitter 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

      • shareUnitOfWork

        public SplitDefinition shareUnitOfWork()
        Shares the UnitOfWork with the parent and each of the sub messages. Splitter will by default not share unit of work between the parent exchange and each splitted exchange. This means each splitted exchange has its own individual unit of work.
        Returns:
        the builder.

      • shareUnitOfWork

        public SplitDefinition shareUnitOfWork​(boolean shareUnitOfWork)
        Shares the UnitOfWork with the parent and each of the sub messages. Splitter will by default not share unit of work between the parent exchange and each splitted exchange. This means each splitted exchange has its own individual unit of work.
        Returns:
        the builder.

      • shareUnitOfWork

        public SplitDefinition shareUnitOfWork​(String shareUnitOfWork)
        Shares the UnitOfWork with the parent and each of the sub messages. Splitter will by default not share unit of work between the parent exchange and each splitted exchange. This means each splitted exchange has its own individual unit of work.
        Returns:
        the builder.

      • getDelimiter

        public String getDelimiter()

      • setDelimiter

        public void setDelimiter​(String delimiter)

      • getAggregationStrategy

        public org.apache.camel.AggregationStrategy getAggregationStrategy()

      • setAggregationStrategy

        public void setAggregationStrategy​(org.apache.camel.AggregationStrategy aggregationStrategy)
        Sets the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

      • getParallelProcessing

        public String getParallelProcessing()

      • setParallelProcessing

        public void setParallelProcessing​(String parallelProcessing)

      • getStreaming

        public String getStreaming()

      • setStreaming

        public void setStreaming​(String streaming)

      • getParallelAggregate

        public String getParallelAggregate()

      • setParallelAggregate

        public void setParallelAggregate​(String parallelAggregate)

      • getStopOnAggregateException

        public String getStopOnAggregateException()

      • setStopOnAggregateException

        public void setStopOnAggregateException​(String stopOnAggregateException)

      • getStopOnException

        public String getStopOnException()

      • setStopOnException

        public void setStopOnException​(String stopOnException)

      • getExecutorService

        public ExecutorService getExecutorService()
        Specified by:
        getExecutorService in interface org.apache.camel.ExecutorServiceAware

      • setExecutorService

        public void setExecutorService​(ExecutorService executorService)
        Specified by:
        setExecutorService in interface org.apache.camel.ExecutorServiceAware

      • getStrategyRef

        public String getStrategyRef()

      • setStrategyRef

        public void setStrategyRef​(String strategyRef)
        Sets a reference to the AggregationStrategy to be used to assemble the replies from the splitted messages, into a single outgoing message from the Splitter. By default Camel will use the original incoming message to the splitter (leave it unchanged). You can also use a POJO as the AggregationStrategy

      • getStrategyMethodName

        public String getStrategyMethodName()

      • setStrategyMethodName

        public void setStrategyMethodName​(String strategyMethodName)
        This option can be used to explicit declare the method name to use, when using POJOs as the AggregationStrategy.

      • getStrategyMethodAllowNull

        public String getStrategyMethodAllowNull()

      • setStrategyMethodAllowNull

        public void setStrategyMethodAllowNull​(String strategyMethodAllowNull)
        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

      • getExecutorServiceRef

        public String getExecutorServiceRef()
        Specified by:
        getExecutorServiceRef in interface org.apache.camel.ExecutorServiceAware

      • setExecutorServiceRef

        public void setExecutorServiceRef​(String executorServiceRef)
        Specified by:
        setExecutorServiceRef in interface org.apache.camel.ExecutorServiceAware

      • getTimeout

        public String getTimeout()

      • setTimeout

        public void setTimeout​(String timeout)

      • getOnPrepareRef

        public String getOnPrepareRef()

      • setOnPrepareRef

        public void setOnPrepareRef​(String onPrepareRef)

      • getOnPrepare

        public org.apache.camel.Processor getOnPrepare()

      • setOnPrepare

        public void setOnPrepare​(org.apache.camel.Processor onPrepare)

      • getShareUnitOfWork

        public String getShareUnitOfWork()

      • setShareUnitOfWork

        public void setShareUnitOfWork​(String shareUnitOfWork)