camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r985598 [2/2] - in /websites/production/camel/content: book-in-one-page.html book-pattern-appendix.html cache/main.pageCache recipient-list.html
Date Wed, 13 Apr 2016 19:19:00 GMT
Modified: websites/production/camel/content/recipient-list.html
==============================================================================
--- websites/production/camel/content/recipient-list.html (original)
+++ websites/production/camel/content/recipient-list.html Wed Apr 13 19:19:00 2016
@@ -86,7 +86,7 @@
 	<tbody>
         <tr>
         <td valign="top" width="100%">
-<div class="wiki-content maincontent"><h3 id="RecipientList-RecipientList">Recipient
List</h3><p>The <a shape="rect" class="external-link" href="http://www.enterpriseintegrationpatterns.com/RecipientList.html"
rel="nofollow">Recipient List</a> from the <a shape="rect" href="enterprise-integration-patterns.html">EIP
patterns</a> allows you to route messages to a number of dynamically specified recipients.</p><p><span
class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource"
src="http://www.enterpriseintegrationpatterns.com/img/RecipientList.gif" data-image-src="http://www.enterpriseintegrationpatterns.com/img/RecipientList.gif"></span></p><p>The
recipients will receive a copy of the <strong>same</strong> <a shape="rect"
href="exchange.html">Exchange</a>, and Camel will execute them sequentially.</p><h3
id="RecipientList-Options">Options</h3><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbod
 y><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>delimiter</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Delimiter used if the <a shape="rect"
href="expression.html">Expression</a> returned multiple endpoints. <strong>Camel
2.13</strong> can be disabled using "false"</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>strategyRef</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>An <a shape="rect" class="external-link"
href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html">Aggregatio
 nStrategy</a> that will assemble the replies from recipients into a single outgoing
message from the <a shape="rect" href="recipient-list.html">Recipient List</a>.
By default Camel will use the last reply as the outgoing message. From <strong>Camel
2.12</strong> onwards you can also use a POJO as the <code>AggregationStrategy</code>,
see the <a shape="rect" href="aggregator2.html">Aggregate</a> page for more details.
If an exception is thrown from the aggregate method in the AggregationStrategy, then by default,
that exception&#160;is not handled by the error handler. The error handler can be enabled
to react if enabling the shareUnitOfWork option.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>strategyMethodName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
This option can be used to explicitly declare the method name to use, when using PO
 JOs as the <code>AggregationStrategy</code>. See the <a shape="rect" href="aggregator2.html">Aggregate</a>
page for more details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>strategyMethodAllowNull</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
If this option is <code>false</code> then the aggregate method is not used if
there was no data to enrich. If this option is <code>true</code> then <code>null</code>
is used as the <code>oldExchange</code> (when no data to enrich), when using POJOs
as the <code>AggregationStrategy</code>. See the <a shape="rect" href="aggregator2.html">Aggregate</a>
page for more details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>parallelProcessing</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" cl
 ass="confluenceTd"><p><strong>Camel 2.2:</strong> 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 is the sending and processing
of replies from recipients which happens in parallel.</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>&#160;</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>parallelAggregate</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14:</strong>
If enabled then the <code>aggregate</code> method on <code>AggregationStrategy</code>
can be called concurrently. Notice that this would require the implementation of <code>AggregationStrategy</code>
to be implemented as thread-safe. By default this is <code>false</code> meaning
that Camel synchronizes the call to the <code>aggregate</code> method. T
 hough in some use-cases this can be used to archive higher performance when the <code>AggregationStrategy</code>
is implemented as thread-safe.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>executorServiceRef</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong>
A custom <a shape="rect" href="threading-model.html">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.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>stopOnException</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong>
Whether to immediately stop processing when an exception occurs. If disabled, Camel will send
the message to all recipients reg
 ardless 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.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>ignoreInvalidEndpoints</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.3:</strong>
Whether to ignore an endpoint URI that could not be resolved. If disabled, Camel will throw
an exception identifying the invalid endpoint URI.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>streaming</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong>
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">Expression</a>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong>
Specifies a processing timeout in milliseconds. If the <a shape="rect" href="recipient-list.html">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">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/aggre
 gate/TimeoutAwareAggregationStrategy.html">TimeoutAwareAggregationStrategy</a>,
its <code>timeout</code> method is invoked before breaking out. <strong>Beware:</strong>
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 caution. We may be able to improve this functionality in future Camel releases.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>onPrepareRef</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
A custom <a shape="rect" href="processor.html">Processor</a> to prepare the copy
of the <a shape="rect" href="exchange.html">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).</p></td></tr><
 tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>shareUnitOfWork</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
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.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>cacheSize</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13.1/2.12.4:</strong>
Allows to configure the cache size for the <code>ProducerCache</code> which caches
producers for reuse in the recipient list. Will by default use the default cache size which
is 1000. Setting the value to -1 allows to turn off the cache completely.</p></td></tr></tbody></table></div></div><h4
id="RecipientList-Stati
 cRecipientList">Static Recipient List</h4><p>The following example shows how
to route a request from an input <strong>queue:a</strong> endpoint to a static
list of destinations</p><p><strong>Using Annotations</strong><br
clear="none"> You can use the <a shape="rect" href="recipientlist-annotation.html">RecipientList
Annotation</a> on a POJO to create a Dynamic Recipient List. For more details see the
<a shape="rect" href="bean-integration.html">Bean Integration</a>.</p><p><strong>Using
the <a shape="rect" href="fluent-builders.html">Fluent Builders</a></strong></p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent
pdl">
+<div class="wiki-content maincontent"><h3 id="RecipientList-RecipientList">Recipient
List</h3><p>The <a shape="rect" class="external-link" href="http://www.enterpriseintegrationpatterns.com/RecipientList.html"
rel="nofollow">Recipient List</a> from the <a shape="rect" href="enterprise-integration-patterns.html">EIP
patterns</a> allows you to route messages to a number of dynamically specified recipients.</p><p><span
class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource"
src="http://www.enterpriseintegrationpatterns.com/img/RecipientList.gif" data-image-src="http://www.enterpriseintegrationpatterns.com/img/RecipientList.gif"></span></p><p>The
recipients will receive a copy of the <strong>same</strong> <a shape="rect"
href="exchange.html">Exchange</a>, and Camel will execute them sequentially.</p><h3
id="RecipientList-Options">Options</h3><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbod
 y><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>delimiter</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Delimiter used if the <a shape="rect"
href="expression.html">Expression</a> returned multiple endpoints. <strong>Camel
2.13</strong> can be disabled using "false"</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>strategyRef</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>An <a shape="rect" class="external-link"
href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/processor/aggregate/AggregationStrategy.html">Aggregatio
 nStrategy</a> that will assemble the replies from recipients into a single outgoing
message from the <a shape="rect" href="recipient-list.html">Recipient List</a>.
By default Camel will use the last reply as the outgoing message. From <strong>Camel
2.12</strong> onwards you can also use a POJO as the <code>AggregationStrategy</code>,
see the <a shape="rect" href="aggregator2.html">Aggregator</a> page for more details.
If an exception is thrown from the aggregate method in the AggregationStrategy, then by default,
that exception&#160;is not handled by the error handler. The error handler can be enabled
to react if enabling the shareUnitOfWork option.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>strategyMethodName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
This option can be used to explicitly declare the method name to use, when using P
 OJOs as the <code>AggregationStrategy</code>. See the <a shape="rect" href="aggregator2.html">Aggregator</a><span>&#160;</span>page
for more details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>strategyMethodAllowNull</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
If this option is <code>false</code> then the aggregate method is not used if
there was no data to enrich. If this option is <code>true</code> then <code>null</code>
is used as the <code>oldExchange</code> (when no data to enrich), when using POJOs
as the <code>AggregationStrategy</code>. See the <a shape="rect" href="aggregator2.html">Aggregator</a>
page for more details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>parallelProcessing</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colsp
 an="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong>
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 is the
sending and processing of replies from recipients which happens in parallel.</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>parallelAggregate</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14:</strong>
If enabled then the <code>aggregate</code> method on <code>AggregationStrategy</code>
can be called concurrently. Notice that this would require the implementation of <code>AggregationStrategy</code>
to be implemented as thread-safe. By default this is <code>false</code> meaning
that Camel synchronizes the call to the <code>aggre
 gate</code> method. Though in some use-cases this can be used to archive higher performance
when the <code>AggregationStrategy</code> is implemented as thread-safe.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>executorServiceRef</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong>
A custom <a shape="rect" href="threading-model.html">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.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>stopOnException</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong>
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.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>ignoreInvalidEndpoints</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.3:</strong>
Whether to ignore an endpoint URI that could not be resolved. If disabled, Camel will throw
an exception identifying the invalid endpoint URI.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>streaming</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Ca
 mel 2.5:</strong> 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">Expression</a>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong>
Specifies a processing timeout in milliseconds. If the <a shape="rect" href="recipient-list.html">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">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 <code>timeout</code> method is invoked before breaking out. <strong>Beware:</strong>
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 caution. We may be able to improve this functionality in future Camel releases.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>onPrepareRef</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
A custom <a shape="rect" href="processor.html">Processor</a> to prepare the copy
of the <a shape="rect" href="exchange.html">Exchange</a> each recipient will receive.
This allows you to perform arbitrary transformations, such as deep-cloning the message payload
(or any other custom l
 ogic).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>shareUnitOfWork</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong>
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.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>cacheSize</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13.1/2.12.4:</strong>
Allows to configure the cache size for the <code>ProducerCache</code> which caches
producers for reuse in the recipient list. Will by default use the default cache size which
is 1000. Setting the value to -1 allows to turn off the cache completely.</p></td></tr></tbody></table></div></div><h4
id
 ="RecipientList-StaticRecipientList">Static Recipient List</h4><p>The following
example shows how to route a request from an input <strong>queue:a</strong> endpoint
to a static list of destinations</p><p><strong>Using Annotations</strong><br
clear="none"> You can use the <a shape="rect" href="recipientlist-annotation.html">RecipientList
Annotation</a> on a POJO to create a Dynamic Recipient List. For more details see the
<a shape="rect" href="bean-integration.html">Bean Integration</a>.</p><p><strong>Using
the <a shape="rect" href="fluent-builders.html">Fluent Builders</a></strong></p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent
pdl">
 <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
 RouteBuilder builder = new RouteBuilder() {
     public void configure() {
@@ -137,7 +137,7 @@ from(&quot;direct:a&quot;).recipientList
     &lt;/route&gt;
 &lt;/camelContext&gt;
 ]]></script>
-</div></div>For further examples of this pattern in action you could take a look
at one of the <a shape="rect" class="external-link" href="http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RecipientListTest.java?view=markup">junit
test case</a><h5 id="RecipientList-UsingdelimiterinSpringXML">Using delimiter
in Spring XML</h5><p>In Spring DSL you can set the <code>delimiter</code>
attribute for setting a delimiter to be used if the header value is a single String with multiple
separated endpoints. By default Camel uses comma as delimiter, but this option lets you specify
a custom delimiter to use instead.</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div>For further examples of this pattern in action you could take a look
at one of the <a shape="rect" class="external-link" href="http://svn.apache.org/viewvc/camel/trunk/camel-core/src/test/java/org/apache/camel/processor/RecipientListTest.java?view=markup">junit
test cases</a>.<h5 id="RecipientList-UsingdelimiterinSpringXML">Using delimiter
in Spring XML</h5><p>In Spring DSL you can set the <code>delimiter</code>
attribute for setting a delimiter to be used if the header value is a single String with multiple
separated endpoints. By default Camel uses comma as delimiter, but this option lets you specify
a custom delimiter to use instead.</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
 <script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
 &lt;route&gt;
   &lt;from uri=&quot;direct:a&quot; /&gt;
@@ -186,7 +186,7 @@ from(&quot;direct:a&quot;).recipientList
        &lt;/recipientList&gt;
    &lt;/route&gt;
 ]]></script>
-</div></div><p>Then let us say the <code>myHeader</code> contains
the following two endpoints <code>direct:foo,xxx:bar</code>. The first endpoint
is valid and works. However the second one is invalid and will just be ignored. Camel logs
at INFO level about it, so you can see why the endpoint was invalid.</p><h3 id="RecipientList-UsingcustomAggregationStrategy">Using
custom <code>AggregationStrategy</code></h3><p><strong>Available
as of Camel 2.2</strong></p><p>You can now use your own <code>AggregationStrategy</code>
with the <a shape="rect" href="recipient-list.html">Recipient List</a>. However
this is rarely needed. What it is good for is that in case you are using <a shape="rect"
href="request-reply.html">Request Reply</a> messaging then the replies from the recipients
can be aggregated. By default Camel uses <code>UseLatestAggregationStrategy</code>
which just keeps that last received reply. If you must remember all the bodies that all the
recipients send back, then you can use 
 your own custom aggregator that keeps those. It is the same principle as with the <a shape="rect"
href="aggregator.html">Aggregator</a> EIP so check it out for details.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent
pdl">
+</div></div><p>Then let us say the <code>myHeader</code> contains
the following two endpoints <code>direct:foo,xxx:bar</code>. The first endpoint
is valid and works. However the second one is invalid and will just be ignored. Camel logs
at INFO level about it, so you can see why the endpoint was invalid.</p><h3 id="RecipientList-UsingcustomAggregationStrategy">Using
custom <code>AggregationStrategy</code></h3><p><strong>Available
as of Camel 2.2</strong></p><p>You can now use your own <code>AggregationStrategy</code>
with the <a shape="rect" href="recipient-list.html">Recipient List</a>. However
this is rarely needed. What it is good for is that in case you are using <a shape="rect"
href="request-reply.html">Request Reply</a> messaging then the replies from the recipients
can be aggregated. By default Camel uses <code>UseLatestAggregationStrategy</code>
which just keeps that last received reply. If you must remember all the bodies that all the
recipients sent back, then you can use 
 your own custom aggregator that keeps those. It is the same principle as with the <a shape="rect"
href="aggregator.html">Aggregator</a> EIP so check it out for details.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent
pdl">
 <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
   from(&quot;direct:a&quot;)
         .recipientList(header(&quot;myHeader&quot;)).aggregationStrategy(new MyOwnAggregationStrategy())
         .to(&quot;direct:b&quot;);
@@ -231,7 +231,7 @@ from(&quot;direct:a&quot;).recipientList
     }
 }
 ]]></script>
-</div></div><p>Well you should only do like that above (using <code>@RecipientList</code>)
if you route just route to a <a shape="rect" href="bean.html">Bean</a> which you
then want to act as a recipient list.<br clear="none"> So the original route can be
changed to:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>You should only use the snippet above (using <code>@RecipientList</code>)
if you just route to a <a shape="rect" href="bean.html">Bean</a> which you then
want to act as a recipient list.<br clear="none"> So the original route can be changed
to:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
 <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from(&quot;activemq:queue:test&quot;).bean(MessageRouter.class,
&quot;routeTo&quot;);
 ]]></script>
 </div></div><p>Which then would invoke the routeTo method and detect that
it is annotated with <code>@RecipientList</code> and then act accordingly as if
it was a recipient list EIP.</p><h3 id="RecipientList-Usingtimeout">Using timeout</h3><p><strong>Available
as of Camel 2.5</strong></p><p>If you use <code>parallelProcessing</code>
then you can configure a total <code>timeout</code> 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 consumer is slow. For example you can set a timeout value of 20
sec.</p><div class="confluence-information-macro confluence-information-macro-warning"><p
class="title">Tasks may keep running</p><span class="aui-icon aui-icon-small aui-iconfont-error
confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>If
the timeout is reached with running tasks still remaining, certain tasks for which it is difficult
for Camel to shut do
 wn in a graceful manner may continue to run. So use this option with a bit of care. We may
be able to improve this functionality in future Camel releases.</p></div></div><p>For
example in the unit test below you can see that 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 <code>"BC"</code>.</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">



Mime
View raw message