Modified: websites/production/camel/content/recipient-list.html ============================================================================== --- websites/production/camel/content/recipient-list.html (original) +++ websites/production/camel/content/recipient-list.html Thu Sep 6 10:20:36 2012 @@ -86,7 +86,7 @@ <h3><a shape="rect" name="RecipientList-Options"></a>Options</h3> <div class="confluenceTableSmall"><div class="table-wrap"> -<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delimiter</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>,</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Delimiter used if the <a shape="rect" href="expression.html" title="Expression">Expression</a> returned multiple endpoints. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>strategyRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> An <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> that will assemble the replies from r ecipients into a single outgoing message from the <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a>. By default Camel will use the last reply as the outgoing message. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>parallelProcessing</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> If enabled, messages are sent to the recipients concurrently. Note that the calling thread will still wait until all messages have been fully processed before it continues; it's the sending and processing of replies from recipients which happens in parallel. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>executorServiceRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> A custom <a shape="rect" href="threading-model.html" title="Threadin g Model">Thread Pool</a> to use for parallel processing. Note that enabling this option implies parallel processing, so you need not enable that option as well. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>stopOnException</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> Whether to immediately stop processing when an exception occurs. If disabled, Camel will send the message to all recipients regardless of any individual failures. You can process exceptions in an <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> implementation, which supports full control of error handling. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreInvalidEndpoints</tt> </td><td colspan="1" rowspan="1" class="confluenceTd" > <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> > <b>Camel 2.3:</b> Whether to ignore an endpoint URI that could not be > resolved. If disabled, Camel will throw an exception identifying the invalid > endpoint URI. </td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"> <tt>streaming</tt> </td><td colspan="1" rowspan="1" > class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" > class="confluenceTd"> <b>Camel 2.5:</b> If enabled, Camel will process > replies out-of-order - that is, in the order received in reply from each > recipient. If disabled, Camel will process replies in the same order as > specified by the <a shape="rect" href="expression.html" > title="Expression">Expression</a>. </td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"> <tt>timeout</tt> </td><td colspan="1" rowspan="1" > class="confluenceTd"> </td><td colspan="1" rowspan="1" > class="confluenceTd"> <b>Camel 2.5:</b> Specifies a processing timeout > milliseconds. If t he <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a> hasn't been able to send and process all replies within this timeframe, then the timeout triggers and the <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a> breaks out, with message flow continuing to the next element. Note that if you provide a <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/TimeoutAwareAggregationStrategy.html";>TimeoutAwareAggregationStrategy</a>, its <tt>timeout</tt> method is invoked before breaking out. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>onPrepareRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> A custom <a shape="rect" href="processor.html" title="Processor">Processor</a> to prepare the copy of the <a shape="rect" href="e xchange.html" title="Exchange">Exchange</a> each recipient will receive. This allows you to perform arbitrary transformations, such as deep-cloning the message payload (or any other custom logic). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>shareUnitOfWork</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Whether the unit of work should be shared. See <a shape="rect" href="splitter.html#Splitter-Sharingunitofwork">the same option on Splitter</a> for more details. </td></tr></tbody></table> +<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delimiter</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>,</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Delimiter used if the <a shape="rect" href="expression.html" title="Expression">Expression</a> returned multiple endpoints. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>strategyRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> An <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> that will assemble the replies from r ecipients into a single outgoing message from the <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a>. By default Camel will use the last reply as the outgoing message. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>parallelProcessing</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> If enabled, messages are sent to the recipients concurrently. Note that the calling thread will still wait until all messages have been fully processed before it continues; it's the sending and processing of replies from recipients which happens in parallel. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>executorServiceRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> A custom <a shape="rect" href="threading-model.html" title="Threadin g Model">Thread Pool</a> to use for parallel processing. Note that enabling this option implies parallel processing, so you need not enable that option as well. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>stopOnException</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> Whether to immediately stop processing when an exception occurs. If disabled, Camel will send the message to all recipients regardless of any individual failures. You can process exceptions in an <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> implementation, which supports full control of error handling. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreInvalidEndpoints</tt> </td><td colspan="1" rowspan="1" class="confluenceTd" > <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> > <b>Camel 2.3:</b> Whether to ignore an endpoint URI that could not be > resolved. If disabled, Camel will throw an exception identifying the invalid > endpoint URI. </td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"> <tt>streaming</tt> </td><td colspan="1" rowspan="1" > class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" > class="confluenceTd"> <b>Camel 2.5:</b> If enabled, Camel will process > replies out-of-order - that is, in the order received in reply from each > recipient. If disabled, Camel will process replies in the same order as > specified by the <a shape="rect" href="expression.html" > title="Expression">Expression</a>. </td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"> <tt>timeout</tt> </td><td colspan="1" rowspan="1" > class="confluenceTd"> </td><td colspan="1" rowspan="1" > class="confluenceTd"> <b>Camel 2.5:</b> Specifies a processing timeout > milliseconds. If t he <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a> hasn't been able to send and process all replies within this timeframe, then the timeout triggers and the <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a> breaks out, with message flow continuing to the next element. Note that if you provide a <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/TimeoutAwareAggregationStrategy.html";>TimeoutAwareAggregationStrategy</a>, its <tt>timeout</tt> method is invoked before breaking out. <b>Beware:</b> When a timeout is hit, and there is already running tasks, then these tasks may run for a while, as its hard to cancel/interrupt these tasks in a graceful manner. So use this option with a bit of care. In a future Camel release we may have improved this. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>onPrepareR ef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> A custom <a shape="rect" href="processor.html" title="Processor">Processor</a> to prepare the copy of the <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> each recipient will receive. This allows you to perform arbitrary transformations, such as deep-cloning the message payload (or any other custom logic). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>shareUnitOfWork</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Whether the unit of work should be shared. See <a shape="rect" href="splitter.html#Splitter-Sharingunitofwork">the same option on Splitter</a> for more details. </td></tr></tbody></table> </div> </div> @@ -363,6 +363,8 @@ from(<span class="code-quote">"activemq: <p>If you use <tt>parallelProcessing</tt> then you can configure a total <tt>timeout</tt> value in millis. Camel will then process the messages in parallel until the timeout is hit. This allows you to continue processing if one message is slow. For example you can set a timeout value of 20 sec.</p> +<div class="panelMacro"><table class="warningMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/forbidden.gif"; width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1"><b>Tasks may keep running</b><br clear="none">When a timeout is hit, and there is already running tasks, then these tasks may run for a while, as its hard to cancel/interrupt these tasks in a graceful manner. So use this option with a bit of care. In a future Camel release we may have improved this.</td></tr></table></div> + <p>For example in the unit test below you can see we multicast the message to 3 destinations. We have a timeout of 2 seconds, which means only the last two messages can be completed within the timeframe. This means we will only aggregate the last two which yields a result aggregation which outputs <tt>"BC"</tt>.</p> <div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent"> <pre class="code-java">from(<span class="code-quote">"direct:start"</span>)
Modified: websites/production/camel/content/splitter.html ============================================================================== --- websites/production/camel/content/splitter.html (original) +++ websites/production/camel/content/splitter.html Thu Sep 6 10:20:36 2012 @@ -87,7 +87,7 @@ <h3><a shape="rect" name="Splitter-Options"></a>Options</h3> <div class="confluenceTableSmall"><div class="table-wrap"> -<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>strategyRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> Refers to an <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> to be used to assemble the replies from the sub-messages, into a single outgoing message from the <a shape="rect" href="splitter.html" title="Splitter">Splitter</a>. See the defaults described below in <em><a shape="rect" href="#Splitter-WhattheSplitterreturns">What the Splitter returns</a></em>. </td></tr><tr><td colspan="1" rowspan="1" class="confluen ceTd"> <tt>parallelProcessing</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If enables then processing the sub-messages occurs concurrently. Note the caller thread will still wait until all sub-messages has been fully processed, before it continues. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>executorServiceRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> Refers to a custom <a shape="rect" href="threading-model.html" title="Threading Model">Thread Pool</a> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>stopOnException</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> Whether or not to stop continue processing immediately when an exception occurred. If disable, then Camel continue splitting and process the sub-messages regardless if one of them failed. You can deal with exceptions in the <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> class where you have full control how to handle that. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>streaming</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If enabled then Camel will split in a streaming fashion, which means it will split the input message in chunks. This reduces the memory overhead. For example if you split big messages its recommended to enable streaming. If streaming is enabled then the sub-messa ge replies will be aggregated out-of-order, eg in the order they come back. If disabled, Camel will process sub-message replies in the same order as they where splitted. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>timeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.5:</b> Sets a total timeout specified in millis. If the <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a> hasn't been able to split and process all replies within the given timeframe, then the timeout triggers and the <a shape="rect" href="splitter.html" title="Splitter">Splitter</a> breaks out and continues. Notice if you provide a <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/TimeoutAwareAggregationStrategy.html";>TimeoutAwareAggregationStrategy</a> then the <tt>timeout</tt> meth od is invoked before breaking out. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>onPrepareRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Refers to a custom <a shape="rect" href="processor.html" title="Processor">Processor</a> to prepare the sub-message of the <a shape="rect" href="exchange.html" title="Exchange">Exchange</a>, before its processed. This allows you to do any custom logic, such as deep-cloning the message payload if that's needed etc. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>shareUnitOfWork</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Whether the unit of work should be shared. See further below for more details. </td></tr></tbody></table> +<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>strategyRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> Refers to an <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> to be used to assemble the replies from the sub-messages, into a single outgoing message from the <a shape="rect" href="splitter.html" title="Splitter">Splitter</a>. See the defaults described below in <em><a shape="rect" href="#Splitter-WhattheSplitterreturns">What the Splitter returns</a></em>. </td></tr><tr><td colspan="1" rowspan="1" class="confluen ceTd"> <tt>parallelProcessing</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If enables then processing the sub-messages occurs concurrently. Note the caller thread will still wait until all sub-messages has been fully processed, before it continues. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>executorServiceRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> Refers to a custom <a shape="rect" href="threading-model.html" title="Threading Model">Thread Pool</a> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>stopOnException</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.2:</b> Whether or not to stop continue processing immediately when an exception occurred. If disable, then Camel continue splitting and process the sub-messages regardless if one of them failed. You can deal with exceptions in the <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html";>AggregationStrategy</a> class where you have full control how to handle that. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>streaming</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If enabled then Camel will split in a streaming fashion, which means it will split the input message in chunks. This reduces the memory overhead. For example if you split big messages its recommended to enable streaming. If streaming is enabled then the sub-messa ge replies will be aggregated out-of-order, eg in the order they come back. If disabled, Camel will process sub-message replies in the same order as they where splitted. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>timeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.5:</b> Sets a total timeout specified in millis. If the <a shape="rect" href="recipient-list.html" title="Recipient List">Recipient List</a> hasn't been able to split and process all replies within the given timeframe, then the timeout triggers and the <a shape="rect" href="splitter.html" title="Splitter">Splitter</a> breaks out and continues. Notice if you provide a <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/TimeoutAwareAggregationStrategy.html";>TimeoutAwareAggregationStrategy</a> then the <tt>timeout</tt> meth od is invoked before breaking out. When a timeout is hit, and there is already running tasks, then these tasks may run for a while, as its hard to cancel/interrupt these tasks in a graceful manner. So use this option with a bit of care. In a future Camel release we may have improved this. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>onPrepareRef</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Refers to a custom <a shape="rect" href="processor.html" title="Processor">Processor</a> to prepare the sub-message of the <a shape="rect" href="exchange.html" title="Exchange">Exchange</a>, before its processed. This allows you to do any custom logic, such as deep-cloning the message payload if that's needed etc. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>shareUnitOfWork</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td> <td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> Whether the unit of work should be shared. See further below for more details. </td></tr></tbody></table> </div> </div>
![https://cwiki.apache.org/confluence/images/icons/emoticons/forbidden.gif"](https://cwiki.apache.org/confluence/images/icons/emoticons/forbidden.gif"){kind=link}