Author: buildbot
Date: Wed Apr 13 18:22:31 2016
New Revision: 985594
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/book-in-one-page.html
websites/production/camel/content/book-pattern-appendix.html
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/recipient-list.html
Modified: websites/production/camel/content/book-in-one-page.html
==============================================================================
--- websites/production/camel/content/book-in-one-page.html (original)
+++ websites/production/camel/content/book-in-one-page.html Wed Apr 13 18:22:31
2016
@@ -3699,11 +3699,11 @@ The tutorial has been designed in two pa
While not actual tutorials you might find working through the source of the
various <a shape="rect" href="examples.html">Examples</a> useful.</li></ul>
<h2 id="BookInOnePage-TutorialonSpringRemotingwithJMS">Tutorial on Spring
Remoting with JMS</h2><p> </p><div class="confluence-information-macro
confluence-information-macro-information"><p class="title">Thanks</p><span
class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>This tutorial was kindly donated
to Apache Camel by Martin Gilday.</p></div></div><h2
id="BookInOnePage-Preface">Preface</h2><p>This tutorial aims to guide the
reader through the stages of creating a project which uses Camel to facilitate
the routing of messages from a JMS queue to a <a shape="rect"
class="external-link" href="http://www.springramework.org";
rel="nofollow">Spring</a> service. The route works in a synchronous fashion
returning a response to the client.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1460355516104 {padding: 0px;}
-div.rbtoc1460355516104 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1460355516104 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1460571590942 {padding: 0px;}
+div.rbtoc1460571590942 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1460571590942 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1460355516104">
+/*]]>*/</style></p><div class="toc-macro rbtoc1460571590942">
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-TutorialonSpringRemotingwithJMS">Tutorial on Spring
Remoting with JMS</a></li><li><a shape="rect"
href="#BookInOnePage-Preface">Preface</a></li><li><a shape="rect"
href="#BookInOnePage-Prerequisites">Prerequisites</a></li><li><a shape="rect"
href="#BookInOnePage-Distribution">Distribution</a></li><li><a shape="rect"
href="#BookInOnePage-About">About</a></li><li><a shape="rect"
href="#BookInOnePage-CreatetheCamelProject">Create the Camel Project</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-UpdatethePOMwithDependencies">Update the POM with
Dependencies</a></li></ul>
</li><li><a shape="rect" href="#BookInOnePage-WritingtheServer">Writing the
Server</a>
@@ -5818,11 +5818,11 @@ So we completed the last piece in the pi
<p>This example has been removed from <strong>Camel 2.9</strong> onwards.
Apache Axis 1.4 is a very old and unsupported framework. We encourage users to
use <a shape="rect" href="cxf.html">CXF</a> instead of Axis.</p></div></div>
<style type="text/css">/*<![CDATA[*/
-div.rbtoc1460355516494 {padding: 0px;}
-div.rbtoc1460355516494 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1460355516494 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1460571592121 {padding: 0px;}
+div.rbtoc1460571592121 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1460571592121 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style><div class="toc-macro rbtoc1460355516494">
+/*]]>*/</style><div class="toc-macro rbtoc1460571592121">
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-TutorialusingAxis1.4withApacheCamel">Tutorial using Axis
1.4 with Apache Camel</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-Prerequisites">Prerequisites</a></li><li><a shape="rect"
href="#BookInOnePage-Distribution">Distribution</a></li><li><a shape="rect"
href="#BookInOnePage-Introduction">Introduction</a></li><li><a shape="rect"
href="#BookInOnePage-SettinguptheprojecttorunAxis">Setting up the project to
run Axis</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-Maven2">Maven 2</a></li><li><a shape="rect"
href="#BookInOnePage-wsdl">wsdl</a></li><li><a shape="rect"
href="#BookInOnePage-ConfiguringAxis">Configuring Axis</a></li><li><a
shape="rect" href="#BookInOnePage-RunningtheExample">Running the
Example</a></li></ul>
@@ -12728,7 +12728,7 @@ public String slip(String body, @Propert
</div></div><p>In the above we can use the <a shape="rect"
href="parameter-binding-annotations.html">Parameter Binding Annotations</a> to
bind different parts of the <a shape="rect" href="message.html">Message</a> to
method parameters or use an <a shape="rect"
href="expression.html">Expression</a> such as using <a shape="rect"
href="xpath.html">XPath</a> or <a shape="rect"
href="xquery.html">XQuery</a>.</p><p>The method can be invoked in a number of
ways as described in the <a shape="rect" href="bean-integration.html">Bean
Integration</a> such as</p><ul><li><a shape="rect"
href="pojo-producing.html">POJO Producing</a></li><li><a shape="rect"
href="spring-remoting.html">Spring Remoting</a></li><li><a shape="rect"
href="bean.html">Bean</a> component</li></ul><p></p><h4
id="BookInOnePage-UsingThisPattern.16">Using This Pattern</h4>
<p>If you would like to use this EIP Pattern then please read the <a
shape="rect" href="getting-started.html">Getting Started</a>, you may also find
the <a shape="rect" href="architecture.html">Architecture</a> useful
particularly the description of <a shape="rect"
href="endpoint.html">Endpoint</a> and <a shape="rect"
href="uris.html">URIs</a>. Then you could try out some of the <a shape="rect"
href="examples.html">Examples</a> first before trying this pattern out.</p>
-<h3 id="BookInOnePage-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="BookInOnePage-Options.10">Options</h3><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" c
lass="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> </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";>AggregationStrategy</a>
that will assemble th
e 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 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> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12:</strong> This option can be used to
explicit declare the method name to use, 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>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> values 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" 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's the sending and processing
of replies from recipients which happens in parallel.</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </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. Though in
some use-cases this ca
n 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> </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 failu
res. 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 rep
lies 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> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong> Specifies a
processing timeout 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/TimeoutAwareAggregationStrate
gy.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 a bit of care. 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> </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 all together.</p></td></tr></tbody></table></div></div><h4
id="BookInOnePage-StaticRecipientList">Static Recip
ient 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">
+<h3 id="BookInOnePage-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="BookInOnePage-Options.10">Options</h3><div
class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" c
lass="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> </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";>AggregationStrategy</a>
that will assemble th
e 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 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> </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 POJOs as the
<code>AggregationStrateg
y</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" 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> </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. 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> </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>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> </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/TimeoutAwareAggregationStrateg
y.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> </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" clas
s="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="BookInOnePage-StaticRecipientList">Static Recipient Li
st</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() {
@@ -12752,7 +12752,7 @@ RouteBuilder builder = new RouteBuilder(
</route>
</camelContext>
]]></script>
-</div></div><h4 id="BookInOnePage-DynamicRecipientList">Dynamic Recipient
List</h4><p>Usually one of the main reasons for using the <a shape="rect"
class="external-link"
href="http://www.enterpriseintegrationpatterns.com/RecipientList.html";
rel="nofollow">Recipient List</a> pattern is that the list of recipients is
dynamic and calculated at runtime. The following example demonstrates how to
create a dynamic recipient list using an <a shape="rect"
href="expression.html">Expression</a> (which in this case it extracts a named
header value dynamically) to calculate the list of endpoints which are either
of type <a shape="rect" class="external-link"
href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html";>Endpoint</a>
or are converted to a String and then resolved using the endpoint <a
shape="rect" href="uris.html">URIs</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></div><h4 id="BookInOnePage-DynamicRecipientList">Dynamic Recipient
List</h4><p>Usually one of the main reasons for using the <a shape="rect"
class="external-link"
href="http://www.enterpriseintegrationpatterns.com/RecipientList.html";
rel="nofollow">Recipient List</a> pattern is that the list of recipients is
dynamic and calculated at runtime. The following example demonstrates how to
create a dynamic recipient list using an <a shape="rect"
href="expression.html">Expression</a> (which in this case extracts a named
header value dynamically) to calculate the list of endpoints which are either
of type <a shape="rect" class="external-link"
href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/Endpoint.html";>Endpoint</a>
or are converted to a String and then resolved using the endpoint <a
shape="rect" href="uris.html">URIs</a>.</p><p><strong>Using the <a shape="rect"
href="fluent-builders.html">Fluent Builders</a></strong></p><div class="code
panel pdl" st
yle="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() {
@@ -12768,7 +12768,7 @@ RouteBuilder builder = new RouteBuilder(
from("direct:a").recipientList(
header("recipientListHeader").tokenize(","));
]]></script>
-</div></div><h5 id="BookInOnePage-Iteratablevalue">Iteratable value</h5><p>The
dynamic list of recipients that are defined in the header must be iteratable
such as:</p><ul
class="alternate"><li><code>java.util.Collection</code></li><li><code>java.util.Iterator</code></li><li>arrays</li><li><code>org.w3c.dom.NodeList</code></li><li>a
single String with values separated with comma</li><li>any other type will be
regarded as a single value</li></ul><p><strong>Using the <a shape="rect"
href="spring-xml-extensions.html">Spring XML Extensions</a></strong></p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+</div></div><h5 id="BookInOnePage-Iteratablevalue">Iteratable value</h5><p>The
dynamic list of recipients that are defined in the header must be iterable such
as:</p><ul
class="alternate"><li><code>java.util.Collection</code></li><li><code>java.util.Iterator</code></li><li>arrays</li><li><code>org.w3c.dom.NodeList</code></li><li>a
single String with values separated by comma</li><li>any other type will be
regarded as a single value</li></ul><p><strong>Using the <a shape="rect"
href="spring-xml-extensions.html">Spring XML Extensions</a></strong></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[
<camelContext errorHandlerRef="errorHandler"
xmlns="http://camel.apache.org/schema/spring">
<route>
@@ -12779,7 +12779,7 @@ from("direct:a").recipientList
</route>
</camelContext>
]]></script>
-</div></div>For further examples of this pattern in use you could 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="BookInOnePage-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 customer 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 case</a><h5 id="BookInOnePage-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[
<route>
<from uri="direct:a" />
@@ -12789,7 +12789,7 @@ from("direct:a").recipientList
</recipientList>
</route>
]]></script>
-</div></div>So if <strong>myHeader</strong> contains a String with the value
<code>"activemq:queue:foo, activemq:topic:hello , log:bar"</code> then Camel
will split the String using the delimiter given in the XML that was comma,
resulting into 3 endpoints to send to. You can use spaces between the endpoints
as Camel will trim the value when it lookup the endpoint to send to.<p>Note: In
Java DSL you use the <code>tokenizer</code> to archive the same. The route
above in Java DSL:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div>So if <strong>myHeader</strong> contains a String with the value
<code>"activemq:queue:foo, activemq:topic:hello , log:bar"</code> then Camel
will split the String using the delimiter given in the XML that was comma,
resulting into 3 endpoints to send to. You can use spaces between the endpoints
as Camel will trim the value when it lookup the endpoint to send to.<p>Note: In
Java DSL you use the <code>tokenizer</code> to achieve the same. The route
above in Java DSL:</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("direct:a").recipientList(header("myHeader").tokenize(","));
]]></script>
</div></div><p>In <strong>Camel 2.1</strong> its a bit easier as you can pass
in the delimiter as 2nd parameter:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
@@ -12798,7 +12798,7 @@ from("direct:a").recipientList
</div></div><h3
id="BookInOnePage-Sendingtomultiplerecipientsinparallel">Sending to multiple
recipients in parallel</h3><p><strong>Available as of Camel
2.2</strong></p><p>The <a shape="rect" href="recipient-list.html">Recipient
List</a> now supports <code>parallelProcessing</code> that for example <a
shape="rect" href="splitter.html">Splitter</a> also supports. You can use it to
use a thread pool to have concurrent tasks sending the <a shape="rect"
href="exchange.html">Exchange</a> to multiple recipients concurrently.</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("direct:a").recipientList(header("myHeader")).parallelProcessing();
]]></script>
-</div></div><p>And in Spring XML its an attribute on the recipient list
tag.</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>And in Spring XML it is an attribute on the recipient list
tag.</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[ <route>
<from uri="direct:a"/>
<recipientList parallelProcessing="true">
@@ -12817,10 +12817,10 @@ from("direct:a").recipientList
</recipientList>
</route>
]]></script>
-</div></div><p><strong>Note:</strong> You can combine
<code>parallelProcessing</code> and <code>stopOnException</code> and have them
both <code>true</code>.</p><h3 id="BookInOnePage-Ignoreinvalidendpoints">Ignore
invalid endpoints</h3><p><strong>Available as of Camel 2.3</strong></p><p>The
<a shape="rect" href="recipient-list.html">Recipient List</a> now supports
<code>ignoreInvalidEndpoints</code> which the <a shape="rect"
href="routing-slip.html">Routing Slip</a> also supports. You can use it to skip
endpoints which is invalid.</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div><p><strong>Note:</strong> You can combine
<code>parallelProcessing</code> and <code>stopOnException</code> and have them
both <code>true</code>.</p><h3 id="BookInOnePage-Ignoreinvalidendpoints">Ignore
invalid endpoints</h3><p><strong>Available as of Camel 2.3</strong></p><p>The
<a shape="rect" href="recipient-list.html">Recipient List</a> now supports
<code>ignoreInvalidEndpoints</code> which the <a shape="rect"
href="routing-slip.html">Routing Slip</a> also supports. You can use it to skip
endpoints which are invalid.</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("direct:a").recipientList(header("myHeader")).ignoreInvalidEndpoints();
]]></script>
-</div></div><p>And in Spring XML its an attribute on the recipient list
tag.</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>And in Spring XML it is an attribute on the recipient list
tag.</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[ <route>
<from uri="direct:a"/>
<recipientList ignoreInvalidEndpoints="true">
@@ -12828,12 +12828,12 @@ from("direct:a").recipientList
</recipientList>
</route>
]]></script>
-</div></div><p>Then lets 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 2nd is invalid and will just be ignored. Camel logs at INFO
level about, so you can see why the endpoint was invalid.</p><h3
id="BookInOnePage-UsingcustomAggregationStrategy">Using custom
<code>AggregationStrategy</code></h3><p><strong>Available as of Camel
2.2</strong></p><p>You can now use you own <code>AggregationStrategy</code>
with the <a shape="rect" href="recipient-list.html">Recipient List</a>. However
its not that often you need that. What its 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 recipient can be aggregated. By default Camel uses
<code>UseLatestAggregationStrategy</code> which just keeps that last received
reply. What if you must remember all the bodies that all the recipients send
back, then you can use
your own custom aggregator that keeps those. Its 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="BookInOnePage-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">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ from("direct:a")
.recipientList(header("myHeader")).aggregationStrategy(new
MyOwnAggregationStrategy())
.to("direct:b");
]]></script>
-</div></div><p>And in Spring XML its an attribute on the recipient list
tag.</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>And in Spring XML it is again an attribute on the recipient
list tag.</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[ <route>
<from uri="direct:a"/>
<recipientList strategyRef="myStrategy">
@@ -12844,14 +12844,14 @@ from("direct:a").recipientList
<bean id="myStrategy"
class="com.mycompany.MyOwnAggregationStrategy"/>
]]></script>
-</div></div><h4
id="BookInOnePage-KnowingwhichendpointwhenusingcustomAggregationStrategy">Knowing
which endpoint when using custom
<code>AggregationStrategy</code></h4><p><strong>Available as of Camel
2.12</strong></p><p>When using a custom <code>AggregationStrategy</code> then
the <code>aggregate</code> method is always invoked in the sequential order
(also if parallel processing is enabled) of the endpoints the <a shape="rect"
href="recipient-list.html">Recipient List</a> is using. However from Camel 2.12
this is easier to know as the <code>newExchange</code> <a shape="rect"
href="exchange.html">Exchange</a> has a property stored (key is
<code>Exchange.RECIPIENT_LIST_ENDPOINT</code> with the uri of the <a
shape="rect" href="endpoint.html">Endpoint</a>.</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h4
id="BookInOnePage-KnowingwhichendpointwhenusingcustomAggregationStrategy">Knowing
which endpoint when using custom
<code>AggregationStrategy</code></h4><p><strong>Available as of Camel
2.12</strong></p><p>When using a custom <code>AggregationStrategy</code> then
the <code>aggregate</code> method is always invoked in sequential order (also
if parallel processing is enabled) of the endpoints the <a shape="rect"
href="recipient-list.html">Recipient List</a> is using. However from Camel 2.12
onwards this is easier to know as the <code>newExchange</code> <a shape="rect"
href="exchange.html">Exchange</a> has a property stored (key is
<code>Exchange.RECIPIENT_LIST_ENDPOINT</code> with the uri of the <a
shape="rect" href="endpoint.html">Endpoint</a>.</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[ @Override
public Exchange aggregate(Exchange oldExchange, Exchange newExchange) {
String uri = newExchange.getProperty(Exchange.RECIPIENT_LIST_ENDPOINT,
String.class);
...
}
]]></script>
-</div></div><h3 id="BookInOnePage-Usingcustomthreadpool">Using custom thread
pool</h3><p><strong>Available as of Camel 2.2</strong></p><p>A thread pool is
only used for <code>parallelProcessing</code>. You supply your own custom
thread pool via the <code>ExecutorServiceStrategy</code> (see Camel's <a
shape="rect" href="threading-model.html">Threading Model</a>), the same way you
would do it for the <code>aggregationStrategy</code>. By default Camel uses a
thread pool with 10 threads (subject to change in a future version).</p><h3
id="BookInOnePage-Usingmethodcallasrecipientlist">Using method call as
recipient list</h3><p>You can use a <a shape="rect" href="bean.html">Bean</a>
to provide the recipients, for example:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="BookInOnePage-Usingcustomthreadpool">Using custom thread
pool</h3><p><strong>Available as of Camel 2.2</strong></p><p>A thread pool is
only used for <code>parallelProcessing</code>. You supply your own custom
thread pool via the <code>ExecutorServiceStrategy</code> (see Camel's <a
shape="rect" href="threading-model.html">Threading Model</a>), the same way you
would do it for the <code>aggregationStrategy</code>. By default Camel uses a
thread pool with 10 threads (subject to change in future versions).</p><h3
id="BookInOnePage-Usingmethodcallasrecipientlist">Using method call as
recipient list</h3><p>You can use a <a shape="rect" href="bean.html">Bean</a>
to provide the recipients, for example:</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("activemq:queue:test").recipientList().method(MessageRouter.class,
"routeTo");
]]></script>
</div></div><p>And then <code>MessageRouter</code>:</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
@@ -12863,7 +12863,7 @@ from("direct:a").recipientList
}
}
]]></script>
-</div></div><p>When you use a <a shape="rect" href="bean.html">Bean</a> then
do <strong>not</strong> also use the <code>@RecipientList</code> annotation as
this will in fact add yet another recipient list, so you end up having two. Do
<strong>not</strong> do like this.</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>When you use a <a shape="rect" href="bean.html">Bean</a> then
do <strong>not</strong> use the <code>@RecipientList</code> annotation as
this will in fact add yet another recipient list, so you end up having two. Do
<strong>not</strong> do the following.</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[public class MessageRouter {
@RecipientList
@@ -12876,7 +12876,7 @@ from("direct:a").recipientList
</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">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[from("activemq:queue:test").bean(MessageRouter.class,
"routeTo");
]]></script>
-</div></div><p>Which then would invoke the routeTo method and detect its
annotated with <code>@RecipientList</code> and then act accordingly as if it
was a recipient list EIP.</p><h3 id="BookInOnePage-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 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 down 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 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">
+</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="BookInOnePage-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">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
from("direct:start")
.multicast(new AggregationStrategy() {
@@ -12901,7 +12901,7 @@ from("direct:b").to("mock
from("direct:c").to("mock:C").setBody(constant("C"));
]]></script>
-</div></div><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">Timeout in other
EIPs</p><span class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>This <code>timeout</code> feature
is also supported by <a shape="rect" href="splitter.html">Splitter</a> and both
<code>multicast</code> and <code>recipientList</code>.</p></div></div><p>By
default if a timeout occurs the <code>AggregationStrategy</code> is not
invoked. However you can implement a specialized version</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl"
style="border-bottom-width:
1px;"><b>TimeoutAwareAggregationStrategy</b></div><div class="codeContent
panelContent pdl">
+</div></div><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">Timeout in other
EIPs</p><span class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>This <code>timeout</code> feature
is also supported by <a shape="rect" href="splitter.html">Splitter</a> and both
<code>multicast</code> and <code>recipientList</code>.</p></div></div><p>By
default if a timeout occurs the <code>AggregationStrategy</code> is not
invoked. However you can implement a special version</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl"
style="border-bottom-width:
1px;"><b>TimeoutAwareAggregationStrategy</b></div><div class="codeContent
panelContent pdl">
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[public interface
TimeoutAwareAggregationStrategy extends AggregationStrategy {
/**
@@ -12914,7 +12914,7 @@ from("direct:c").to("mock
*/
void timeout(Exchange oldExchange, int index, int total, long timeout);
]]></script>
-</div></div><p>This allows you to deal with the timeout in the
<code>AggregationStrategy</code> if you really need to.</p><div
class="confluence-information-macro
confluence-information-macro-information"><p class="title">Timeout is
total</p><span class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>The timeout is total, which means
that after X time, Camel will aggregate the messages which has completed within
the timeframe. The remainders will be cancelled. Camel will also only invoke
the <code>timeout</code> method in the
<code>TimeoutAwareAggregationStrategy</code> once, for the first index which
caused the timeout.</p></div></div><h3
id="BookInOnePage-UsingonPreparetoexecutecustomlogicwhenpreparingmessages">Using
onPrepare to execute custom logic when preparing
messages</h3><p><strong>Available as of Camel 2.8</strong></p><p>See details at
<a shape="rect" href="multicast.html">Multicast</a><
/p><h3 id="BookInOnePage-UsingExchangePatterninrecipients">Using
ExchangePattern in recipients</h3><p><strong>Available as of Camel
2.15</strong></p><p>The recipient list will by default use the current <a
shape="rect" href="exchange-pattern.html">Exchange Pattern</a>. Though there
can be use-cases where you want to send a message to a recipient using a
different exchange pattern. For example you may have a route that initiates as
a InOnly route, but want to use InOut exchange pattern with a recipient list.
To do this in earlier Camel releases, you would need to change
the exchange pattern before the recipient list, or use onPrepare option to
alter the pattern. Now from Camel 2.15 onwards, you can configure the exchange
pattern directly in the recipient endpoints.</p><p>For example in the route
below we pickup new files (which will started as InOnly) and then route to a
recipient list. As we want to use InOut with the ActiveMQ (JMS) endpoint we can
now specify this using t
he exchangePattern=InOut option. Then the response form the JMS request/reply
will then be continued routed, and thus the response is what will be stored in
as a file in the outbox directory.</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>This allows you to deal with the timeout in the
<code>AggregationStrategy</code> if you really need to.</p><div
class="confluence-information-macro
confluence-information-macro-information"><p class="title">Timeout is
total</p><span class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>The timeout is total, which means
that after X time, Camel will aggregate the messages which have completed
within the timeframe. The remainders will be cancelled. Camel will also only
invoke the <code>timeout</code> method in the
<code>TimeoutAwareAggregationStrategy</code> once, for the first index which
caused the timeout.</p></div></div><h3
id="BookInOnePage-UsingonPreparetoexecutecustomlogicwhenpreparingmessages">Using
onPrepare to execute custom logic when preparing
messages</h3><p><strong>Available as of Camel 2.8</strong></p><p>See details at
<a shape="rect" href="multicast.html">Multicast</a>
</p><h3 id="BookInOnePage-UsingExchangePatterninrecipients">Using
ExchangePattern in recipients</h3><p><strong>Available as of Camel
2.15</strong></p><p>The recipient list will by default use the current <a
shape="rect" href="exchange-pattern.html">Exchange Pattern</a>. Though one can
imagine use-cases where one wants to send a message to a recipient using a
different exchange pattern. For example you may have a route that initiates as
an InOnly route, but want to use InOut exchange pattern with a recipient list.
To do this in earlier Camel releases, you would need to change
the exchange pattern before the recipient list, or use onPrepare option to
alter the pattern. From Camel 2.15 onwards, you can configure the exchange
pattern directly in the recipient endpoints.</p><p>For example in the route
below we pick up new files (which will be started as InOnly) and then route to
a recipient list. As we want to use InOut with the ActiveMQ (JMS) endpoint we
can now specify this u
sing the exchangePattern=InOut option. Then the response from the JMS
request/reply will then be continued routed, and thus the response is what will
be stored in as a file in the outbox directory.</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("file:inbox")
// the exchange pattern is InOnly initially when using a file route
.recipientList().constant("activemq:queue:inbox?exchangePattern=InOut")
@@ -17251,11 +17251,11 @@ template.send("direct:alias-verify&
]]></script>
</div></div><p></p><h3 id="BookInOnePage-SeeAlso.28">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring
Camel</a></li><li><a shape="rect"
href="component.html">Component</a></li><li><a shape="rect"
href="endpoint.html">Endpoint</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li></ul><ul><li><a
shape="rect" href="crypto.html">Crypto</a> Crypto is also available as a <a
shape="rect" href="data-format.html">Data Format</a></li></ul> <h2
id="BookInOnePage-CXFComponent">CXF Component</h2><div
class="confluence-information-macro confluence-information-macro-note"><span
class="aui-icon aui-icon-small aui-iconfont-warning
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When using CXF as a consumer, the
<a shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows
you to factor out how message payloads are received from their processing as a
RESTful or SOAP web service. This has the potential of using a multitude of
transports to consume web
services. The bean component's configuration is also simpler and provides the
fastest method to implement web services using Camel and
CXF.</p></div></div><div class="confluence-information-macro
confluence-information-macro-tip"><span class="aui-icon aui-icon-small
aui-iconfont-approve confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When using CXF in streaming modes
(see DataFormat option), then also read about <a shape="rect"
href="stream-caching.html">Stream caching</a>.</p></div></div><p>The
<strong>cxf:</strong> component provides integration with <a shape="rect"
href="http://cxf.apache.org";>Apache CXF</a> for connecting to JAX-WS services
hosted in CXF.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1460355519442 {padding: 0px;}
-div.rbtoc1460355519442 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1460355519442 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1460571611138 {padding: 0px;}
+div.rbtoc1460571611138 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1460571611138 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1460355519442">
+/*]]>*/</style></p><div class="toc-macro rbtoc1460571611138">
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-CXFComponent">CXF Component</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-URIformat">URI format</a></li><li><a shape="rect"
href="#BookInOnePage-Options">Options</a>
<ul class="toc-indentation"><li><a shape="rect"
href="#BookInOnePage-Thedescriptionsofthedataformats">The descriptions of the
dataformats</a>
![http://www.enterpriseintegrationpatterns.com/img/RecipientList.gif"](http://www.enterpriseintegrationpatterns.com/img/RecipientList.gif"){kind=link}