Modified: websites/production/camel/content/jms.html
==============================================================================
--- websites/production/camel/content/jms.html (original)
+++ websites/production/camel/content/jms.html Wed Sep 7 21:20:53 2016
@@ -86,7 +86,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="JMS-JMSComponent">JMS
Component</h2><div class="confluence-information-macro
confluence-information-macro-information"><p class="title">Using
ActiveMQ</p><span class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>If you are using <a shape="rect"
class="external-link" href="http://activemq.apache.org/";>Apache ActiveMQ</a>,
you should prefer the <a shape="rect" href="activemq.html">ActiveMQ</a>
component as it has been optimized for <a shape="rect"
href="activemq.html">ActiveMQ</a>. All of the options and samples on this page
are also valid for the <a shape="rect" href="activemq.html">ActiveMQ</a>
component.</p></div></div><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">Transacted and
caching</p><span class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div class="conf
luence-information-macro-body"><p>See section <em>Transactions and Cache
Levels</em> below if you are using transactions with <a shape="rect"
href="jms.html">JMS</a> as it can impact performance.</p></div></div><div
class="confluence-information-macro confluence-information-macro-tip"><p
class="title">Request/Reply over JMS</p><span class="aui-icon aui-icon-small
aui-iconfont-approve confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>Make sure to read the section
<em>Request-reply over JMS</em> further below on this page for important notes
about request/reply, as Camel offers a number of options to configure for
performance, and clustered environments.</p></div></div><p>This component
allows messages to be sent to (or consumed from) a <a shape="rect"
class="external-link" href="http://java.sun.com/products/jms/";
rel="nofollow">JMS</a> Queue or Topic. It uses Spring's JMS support for
declarative transactions, including Spring's <code>Jms
Template</code> for sending and a <code>MessageListenerContainer</code> for
consuming.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><h2 id="JMS-JMSComponent">JMS
Component</h2><div class="confluence-information-macro
confluence-information-macro-information"><p class="title">Using
ActiveMQ</p><span class="aui-icon aui-icon-small aui-iconfont-info
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>If you are using <a shape="rect"
class="external-link" href="http://activemq.apache.org/";>Apache ActiveMQ</a>,
you should prefer the <a shape="rect" href="activemq.html">ActiveMQ</a>
component as it has been optimized for <a shape="rect"
href="activemq.html">ActiveMQ</a>. All of the options and samples on this page
are also valid for the <a shape="rect" href="activemq.html">ActiveMQ</a>
component.</p></div></div><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">Transacted and
caching</p><span class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div class="conf
luence-information-macro-body"><p>See section <em>Transactions and Cache
Levels</em> below if you are using transactions with <a shape="rect"
href="jms.html">JMS</a> as it can impact performance.</p></div></div><div
class="confluence-information-macro confluence-information-macro-tip"><p
class="title">Request/Reply over JMS</p><span class="aui-icon aui-icon-small
aui-iconfont-approve confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>Make sure to read the section
<em>Request-reply over JMS</em> further below on this page for important notes
about request/reply, as Camel offers a number of options to configure for
performance, and clustered environments.</p></div></div><p>This component
allows messages to be sent to (or consumed from) a <a shape="rect"
class="external-link" href="http://java.sun.com/products/jms/";
rel="nofollow">JMS</a> Queue or Topic. It uses Spring's JMS support for
declarative transactions, including Spring's <strong><
code>JmsTemplate</code></strong> for sending and a
<strong><code>MessageListenerContainer</code></strong> for
consuming.</p><p>Maven users will need to add the following dependency to their
<strong><code>pom.xml</code></strong> for this component:</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[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-jms</artifactId>
@@ -97,33 +97,33 @@
</div></div><h3 id="JMS-URIformat">URI format</h3><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[jms:[queue:|topic:]destinationName[?options]
]]></script>
-</div></div><p>Where <code>destinationName</code> is a JMS queue or topic
name. By default, the <code>destinationName</code> is interpreted as a queue
name. For example, to connect to the queue, <code>FOO.BAR</code> use:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+</div></div><p>Where <strong><code>destinationName</code></strong> is a JMS
queue or topic name. By default, the
<strong><code>destinationName</code></strong> is interpreted as a queue name.
For example, to connect to the queue, <strong><code>FOO.BAR</code></strong>
use:</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[jms:FOO.BAR
]]></script>
-</div></div><p>You can include the optional <code>queue:</code> prefix, if you
prefer:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>You can include the optional
<strong><code>queue:</code></strong> prefix, if you prefer:</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[jms:queue:FOO.BAR
]]></script>
-</div></div><p>To connect to a topic, you <em>must</em> include the
<code>topic:</code> prefix. For example, to connect to the topic,
<code>Stocks.Prices</code>, use:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>To connect to a topic, you <em>must</em> include the
<strong><code>topic:</code></strong> prefix. For example, to connect to the
topic, <strong><code>Stocks.Prices</code></strong>, use:</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[jms:topic:Stocks.Prices
]]></script>
-</div></div><p>You append query options to the URI using the following format:
<strong><code>?option=value&option=value&...</code></strong></p><h3
id="JMS-Notes">Notes</h3><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">Using ActiveMQ</p><span
class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>The JMS component reuses Spring
2's <code>JmsTemplate</code> for sending messages. This is not ideal for use in
a non-J2EE container and typically requires some caching in the JMS provider to
avoid <a shape="rect" class="external-link"
href="http://activemq.apache.org/jmstemplate-gotchas.html";>poor
performance</a>.</p><p>If you intend to use <a shape="rect"
class="external-link" href="http://activemq.apache.org/";>Apache ActiveMQ</a> as
your Message Broker - which is a good choice as ActiveMQ rocks <img
class="emoticon emoticon-smile" src="https://cwik
i.apache.org/confluence/s/en_GB/5982/f2b47fb3d636c8bc9fd0b11c0ec6d0ae18646be7.1/_/images/icons/emoticons/smile.png"
data-emoticon-name="smile" alt="(smile)"> , then we recommend that you
either:</p><ul><li><p>Use the <a shape="rect" href="activemq.html">ActiveMQ</a>
component, which is already optimized to use ActiveMQ
efficiently</p></li><li><p>Use the <code>PoolingConnectionFactory</code> in
ActiveMQ</p></li></ul></div></div><h4
id="JMS-TransactionsandCacheLevels">Transactions and Cache Levels</h4><p><span
class="confluence-anchor-link" id="JMS-transactionCacheLevels"></span><br
clear="none"> If you are consuming messages and using transactions
(<strong><code>transacted=true</code></strong>) then the default cache level
can negatively impact performance. If you are using XA transactions then you
cannot cache as it can cause the XA transaction to not work properly.</p><p>If
you are <strong>not</strong> using XA, then you should consider caching as it
speeds up performance, such as
setting <strong><code>cacheLevelName=CACHE_CONSUMER</code></strong>. Through
Camel 2.7.x, the default setting for
<strong><code>cacheLevelName</code></strong> is
<strong><code>CACHE_CONSUMER</code></strong>. You will need to explicitly set
<strong><code>cacheLevelName=CACHE_NONE</code></strong>. In Camel 2.8 onward,
the default setting for <strong><code>cacheLevelName</code></strong> is
<strong><code>CACHE_AUTO</code></strong>. This default auto detects the mode
and sets the cache level accordingly to:</p><ul
class="alternate"><li><p><code>CACHE_CONSUMER</code>
when <code>transacted=false</code></p></li><li><p><code>CACHE_NONE</code>
when <code>transacted=true</code></p></li></ul><p>So you can say the
default setting is conservative. Consider using
<strong><code>cacheLevelName=CACHE_CONSUMER</code></strong> if you are using
non-XA transactions.</p><h4 id="JMS-DurableSubscriptions">Durable
Subscriptions</h4><p>If you wish to use durable topic subscriptions, you need
to spec
ify both <strong><code>clientId</code></strong>  and
<strong><code>durableSubscriptionName</code>. The value of the
<code>clientId</code></strong> must be unique and can only be used by a single
JMS connection instance in your entire network. You may prefer to use <a
shape="rect" class="external-link"
href="http://activemq.apache.org/virtual-destinations.html";>Virtual Topics</a>
instead to avoid this limitation. More background on durable messaging <a
shape="rect" class="external-link"
href="http://activemq.apache.org/how-do-durable-queues-and-topics-work.html";>here</a>.</p><h4
id="JMS-MessageHeaderMapping">Message Header Mapping</h4><p>When using message
headers, the JMS specification states that header names must be valid Java
identifiers. So try to name your headers to be valid Java identifiers. One
benefit of doing this is that you can then use your headers inside a JMS
Selector (whose SQL92 syntax mandates Java identifier syntax for
headers).</p><p>A simple strategy f
or mapping header names is used by default. The strategy is to replace any
dots and hyphens in the header name as shown below and to reverse the
replacement when the header name is restored from a JMS message sent over the
wire. What does this mean? No more losing method names to invoke on a bean
component, no more losing the filename header for the File Component, and so
on.</p><p>The current header name strategy for accepting header names in Camel
is:</p><ul class="alternate"><li><p>Dots are replaced by <code>_DOT_</code> and
the replacement is reversed when Camel consume the
message</p></li><li><p>Hyphen is replaced by <code>_HYPHEN_</code> and the
replacement is reversed when Camel consumes the message</p></li></ul><h3
id="JMS-ConfigurationOptions">Configuration Options</h3><p>You can configure
many different properties on the JMS endpoint which map to properties on the <a
shape="rect" class="external-link"
href="http://camel.apache.org/maven/current/camel-jms/apidocs/org/apache
/camel/component/jms/JmsConfiguration.html">JMSConfiguration POJO</a>.</p><div
class="confluence-information-macro confluence-information-macro-note"><p
class="title">Mapping to Spring JMS</p><span class="aui-icon aui-icon-small
aui-iconfont-warning confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>Many of these properties map to
properties on Spring JMS, which Camel uses for sending and receiving messages.
Therefore for more information about these properties consult the Spring
documentation.</p></div></div><p>The options are divided into two tables, the
first one contains the most common options. The second table contains the less
common and more advanced options.</p><h4 id="JMS-CommonOptions">Common
Options</h4><p> </p><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Option</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>clientId</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Sets the JMS client ID to
>use. Note that this value, if specified, must be unique and can only be used
>by a single JMS connection instance. It is typically only required for
>durable topic subscriptions. You may prefer to use <a shape="rect"
>class="external-link"
>href="http://activemq.apache.org/virtual-destinations.html";>Virtual
>Topics</a> instead.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>concurrentConsumers</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the default number
>of concurrent consumers. From <strong>Camel 2.10.3</strong> onwa
rd this option can also be used when doing request/reply over JMS. From
<strong>Camel 2.16</strong> onward there is a new
<code>replyToConcurrentConsumers</code>. See also the
<code>maxMessagesPerTask</code> option to control dynamic scaling up/down of
threads.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>disableReplyTo</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>If <code>true</code>, a producer will
behave like a <code>InOnly</code> exchange with the exception that
<code>JMSReplyTo</code> header is sent out and not be suppressed like in the
case of <code>InOnly</code>. Like <code>InOnly</code> the producer will not
wait for a reply. A consumer with this flag will behave like
<code>InOnly</code>. This feature can be used to bridge <code>InOut</code>
requests to another queue so that a route on the other queue will send
it´s response directly b
ack to the original <code>JMSReplyTo</code>.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>durableSubscriptionName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The durable subscriber name for
specifying durable topic subscriptions. The <code>clientId</code> option
<strong>must</strong> be configured as well.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>maxConcurrentConsumers</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the maximum number of
concurrent consumers. From <strong>Camel 2.10.3</strong> onward this option can
also be used when doing request/reply over JMS. <span>From </span><strong>Camel
2.16</strong><span> onward there is a new
<code>replyToMaxConcurrentConsumers</code>. </span>See also the
<code>maxMessagesPer
Task</code> option to control dynamic scaling up/down of threads. The
<code>maxMessagesPerTask</code><span> option MUST be set to an integer greater
than <code>0</code> for threads to scale down. Otherwise, the number of
threads will remain at <span><code>maxConcurrentConsumers</code> until
shutdown.</span></span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxMessagesPerTask</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The number of messages per task. The
default, <code>-1</code>, is unlimited. If you use a range for concurrent
consumers e.g., <code>concurrentConsumers</code> <code><</code>
<code>maxConcurrentConsumers</code>, then this option can be used to set a
value to e.g., <code>100</code> to control how fast the consumers will shrink
when less work is required.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><
code>preserveMessageQos</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Set to <code>true</code>, if you want to send message
using the QoS settings specified on the message, instead of the QoS settings on
the JMS endpoint. The following three headers are considered
<code>JMSPriority</code>, <code>JMSDeliveryMode</code>, and
<code>JMSExpiration</code>. You can provide all or only some of them. If not
provided, Camel will fall back to use the values from the endpoint instead. So,
when using this option, the headers override the values from the endpoint. The
<code>explicitQosEnabled</code> option, by contrast, will only use options set
on the endpoint, and not values from the message header.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>replyTo</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan=
"1" class="confluenceTd"><p>Provides an explicit ReplyTo destination, which
overrides any incoming value of <code>Message.getJMSReplyTo()</code>. If you do
<a shape="rect" href="request-reply.html">Request Reply</a> over JMS then
<strong>make sure</strong> to read the section <em>Request-reply over JMS</em>
further below for more details, and the <code>replyToType</code> option as
well.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>replyToConcurrentConsumers</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.16</strong>:
Specifies the default number of concurrent consumers when doing request/reply
over JMS.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>replyToMaxConcurrentConsumers</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p
><strong>Camel 2.16</strong>: Specifies the maximum number of concurrent
>consumers when doing request/reply over JMS. See also
>the <code>maxMessagesPerTask</code> option to control dynamic scaling
>up/down of threads.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>replyToOnTimeoutMaxConcurrentConsumers</code></p></td><td
> colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel
>2.17.2</strong>: Specifies the maximum number of concurrent consumers for
>continue routing when timeout occurred when using request/reply over
>JMS.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>replyToOverride</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> Provides an
>explicit <code>ReplyTo</code> destination in the JMS message, which
>overrid
es the setting of <code>ReplyTo</code>. It is useful if you want to forward
the message to a remote Queue and receive the reply message from the ReplyTo
destination.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>replyToType</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.9:</strong> Allows for
explicitly specifying which kind of strategy to use for replyTo queues when
doing request/reply over JMS. Possible values are: <code>Temporary</code>,
<code>Shared</code>, or <code>Exclusive</code>. By default Camel will use
temporary queues. However if <code>replyTo</code> has been configured, then
<code>Shared</code> is used by default. This option allows you to use exclusive
queues instead of shared ones. See further below for more details, and
especially the notes about the implications if running in a clustered
environment, and the fact that <code>S
hared</code> reply queues has lower performance than its alternatives
<code>Temporary</code> and <code>Exclusive</code>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>requestTimeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>20000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Producer only:</strong> The timeout
for waiting for a reply when using the <code>InOut</code> <a shape="rect"
href="exchange-pattern.html">Exchange Pattern</a> (in milliseconds). The
default is 20 seconds. From <strong>Camel 2.13/2.12.3</strong> onward you can
include the header <code>CamelJmsRequestTimeout</code> to override this
endpoint configured timeout value, and thus have per message individual timeout
values. See below in section <em>About time to live</em> for more details. See
also the <code>requestTimeoutCheckerInterval</code>
option.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><
code>selector</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Sets the JMS Selector, which is an SQL 92 predicate
that is used to filter messages within the broker. You may have to encode
special characters such as = as %3D <strong>Before Camel 2.3.0</strong>, we
don't support this option
in <code>CamelConsumerTemplate</code>.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>timeToLive</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>When sending messages,
specifies the time-to-live of the message (in milliseconds). See below in
section <em>About time to live</em> for more details.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>transacted</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Specifies whether to use
transacted mode for sending/receiving messages using
the <code>InOnly</code> <a shape="rect"
href="exchange-pattern.html">Exchange Pattern</a>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>testConnectionOnStartup</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.1:</strong>
Specifies whether to test the connection on startup. This ensures that when
Camel starts that all the JMS consumers have a valid connection to the JMS
broker. If a connection cannot be granted then Camel throws an exception on
startup. This ensures that Camel is not started with failed connections. From
<strong>Camel 2.8</strong> onward also the JMS producers is tested as
well.</p></td></tr></tbody></table></div><h4 id="JMS-AdvancedOptions">Advanced
Options</h4><div class="confluenceTableSmall">&#
160;</div><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Option</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>acceptMessagesWhileStopping</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Specifies whether the consumer
accept messages while it is stopping. You may consider enabling this option, if
you start and stop <a shape="rect" href="jms.html">JMS</a> routes at run-time,
while there are still messages enqueued on the queue. If this option is
<code>false</code>, and you stop the <a shape="rect" href="jms.html">JMS</a>
route, then messages may be rejected, and the JMS broker would have to attempt
redeliveries, which yet again may be rejected, an
d eventually the message may be moved at a dead letter queue on the JMS
broker. To avoid this scenario it's recommended this option be set to
<code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>acknowledgementModeName</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>AUTO_ACKNOWLEDGE</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The JMS acknowledgement name, which is one
of: <code>SESSION_TRANSACTED</code>,
<code>CLIENT_ACKNOWLEDGE</code>, <code>AUTO_ACKNOWLEDGE</code> or
<code>DUPS_OK_ACKNOWLEDGE</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>acknowledgementMode</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The JMS acknowledgement mode
defined as an Integer. Allows you to set vendor-specific extensions to the
acknowledgment mode. For the regular modes, it is pre
ferable to use the <code>acknowledgementModeName</code>
instead.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowNullBody</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3/2.10.1:</strong>
Whether to allow sending messages with no body. If this option is
<code>false</code> and the message body is null, then an
<code>JMSException</code> is thrown.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>allowReplyManagerQuickStop</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Whether
the <code>DefaultMessageListenerContainer</code> used in the reply
managers for request-reply messaging allow
the <code>DefaultMessageListenerContainer.runningAllowed</code> flag to
quick stop in case link <code>JmsConfigurationis
AcceptMessagesWhileStopping()</code> is enabled and CamelContext is currently
being stopped. This quick stop ability is enabled by default in the regular JMS
consumers but to enable for reply managers you must enable this
flag.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>alwaysCopyMessage</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>If <code>true</code>, Camel will always
make a JMS message copy of the message when it is passed to the producer for
sending. Copying the message is needed in some situations, such as when a
<code>replyToDestinationSelectorName</code> is set (incidentally, Camel will
set the <code>alwaysCopyMessage</code> option to <code>true</code>, if a
<code>replyToDestinationSelectorName</code> is set).</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>asyncConsumer</code></p></td><td colspan="1"
rowspan="1" clas
s="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.9:</strong> Whether the
<code>JmsConsumer</code> processes the <a shape="rect"
href="exchange.html">Exchange</a> <a shape="rect"
href="asynchronous-routing-engine.html">asynchronously</a>. If enabled then the
<code>JmsConsumer</code> may pickup the next message from the JMS queue, while
the previous message is being processed asynchronously (by the <a shape="rect"
href="asynchronous-routing-engine.html">Asynchronous Routing Engine</a>). This
means that messages may be processed not 100% strictly in order. If disabled
(as default) then the <a shape="rect" href="exchange.html">Exchange</a> is
fully processed before the <code>JmsConsumer</code> will pickup the next
message from the JMS queue. Note if <code>transacted</code> has been enabled,
then <code>asyncConsumer=true</code> does not run asynchronously, as
transactions must be executed synchronously (Camel 3.0 may suppo
rt asynchronous transactions).</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>asyncStartListener</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.10:</strong> Whether to
startup the <code>JmsConsumer</code> message listener asynchronously, when
starting a route. For example if a <code>JmsConsumer</code> cannot get a
connection to a remote JMS broker, then it may block while retrying and/or
failover. This will cause Camel to block while starting routes. By setting this
option to <code>true</code>, you will let routes startup, while the
<code>JmsConsumer</code> connects to the JMS broker using a dedicated thread in
asynchronous mode. If this option is used, then beware that if the connection
could not be established, then an exception is logged at <code>WARN</code>
level, and the consumer will not be able to receive messages. You can then
restart
the route to retry.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>asyncStopListener</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.10:</strong> Whether to
stop the <code>JmsConsumer</code> message listener asynchronously, when
stopping a route.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>autoStartup</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies whether the consumer container
should auto-startup.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cacheLevel</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Sets the cache level by ID for the underlying JMS
resources. See <code>cacheLevelName</code> op
tion for more details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cacheLevelName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><ul><li><p><code>CACHE_AUTO</code> (Camel
>= 2.8.0)<code> <br clear="none"></code></p></li><li><p><code>CACHE_CONSUMER
</code>(Camel <= 2.7.1)</p></li></ul></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Sets the cache level by name for the underlying JMS
resources. Possible values are: <code>CACHE_AUTO</code>,
<code>CACHE_CONNECTION</code>, <code>CACHE_CONSUMER</code>,
<code>CACHE_NONE</code> and <code>CACHE_SESSION</code>. The default setting for
<strong>Camel 2.8</strong> and newer is <code>CACHE_AUTO</code>. For
<strong>Camel 2.7.1</strong> and older the default is
<code>CACHE_CONSUMER</code>.</p><p>See the <a shape="rect"
class="external-link"
href="https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/jms/listener/DefaultMessageListenerContainer.html";
rel="nofoll
ow">Spring documentation</a> and <a shape="rect"
href="#JMS-transactionCacheLevels">Transactions Cache Levels</a> for more
information.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>connectionFactory</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The default JMS connection factory to use
for the <code>listenerConnectionFactory</code> and
<code>templateConnectionFactory</code>, if neither is
specified.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumerType</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Default</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The Spring JMS listener type to
use. Valid values can be one of: <code>Simple</code>, <code>Default</code> or
<code>Custom</code>.</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan=
"1" class="confluenceTh"><p><code>consumerType</code></p></th><th colspan="1"
rowspan="1" class="confluenceTh"><p>Spring JMS Listener
Type</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Default</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><strong><code>org.springframework.jms.listener.DefaultMessageListenerContainer</code></strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Simple</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong><code>org.springframework.jms.listener.SimpleMessageListenerContainer</code></strong></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Custom</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>(<strong>Camel 2.10.2 onward</strong>) The
<code>MessageListenerContainerFactory</code> defined by the
<code>messageListenerContainerFactoryRef</code> option which will determine
what <strong><code>org.springframework.jms
.listener.AbstractMessageListenerContainer </code></strong>to
use.</p></td></tr></tbody></table></div><p>This option was temporarily removed
in Camel 2.7 and 2.8 but was re-added in Camel 2.9.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>defaultTaskExecutorType</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>(see description)</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.4:</strong>
Specifies what default <code>TaskExecutor</code> type to use in the
<code>DefaultMessageListenerContainer</code>, for both consumer endpoints and
the <code>ReplyTo</code> consumer of producer endpoints. Possible values:
<code>SimpleAsync</code> (uses Spring's <a shape="rect" class="external-link"
href="http://static.springsource.org/spring/docs/current/javadoc-api/org/springframework/core/task/SimpleAsyncTaskExecutor.html";
rel="nofollow">SimpleAsyncTaskExecutor</a>) or <code>ThreadPool</code> (uses
Spring's <a sha
pe="rect" class="external-link"
href="http://static.springsource.org/spring/docs/current/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.html";
rel="nofollow">ThreadPoolTaskExecutor</a> with optimal values - cached
threadpool-like). If not set, it defaults to the previous behavior, which uses
a cached thread pool for consumer endpoints and SimpleAsync for reply
consumers. The use of <code>ThreadPool</code> is recommended to reduce "thread
trash" in elastic configurations with dynamically increasing and decreasing
concurrent consumers.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>deliveryMode</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.2/2.13:</strong>
Specifies the delivery mode to be used. Possibles values are those defined by
<strong><code>javax.jms.DeliveryMode</code></strong>.</p></td></tr><tr><td
colspa
n="1" rowspan="1"
class="confluenceTd"><p><code>deliveryPersistent</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies whether persistent delivery is
used by default.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>destination</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies the JMS Destination object to use
on this endpoint.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>destinationName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies the JMS destination name to use
on this endpoint.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>destinationResolver</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>A pluggable
<strong><code>org.springframework.jms.support.destination.DestinationResolver</code></strong>
that allows you to use your own resolver (for example, to lookup the real
destination in a JNDI registry).</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>disableTimeToLive</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> Use this option
to force disabling time to live. For example when you do request/reply over
JMS, then Camel will by default use the <code>requestTimeout</code> value as
time to live on the message being sent. The problem is that the sender and
receiver systems have to have their clocks synchronized, so they are in sync.
This is not always so easy to archive. So you can use
<code>disableTimeToLive=true</code> to
<strong>not</strong> set a time to live value on the sent message. Then the
message will not expire on the receiver system. See below in section <em>About
time to live</em> for more details.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>eagerLoadingOfProperties</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Enables eager loading of JMS
properties as soon as a message is received, which is generally inefficient,
because the JMS properties might not be required. But this feature can
sometimes catch early any issues with the underlying JMS provider and the use
of JMS properties. This feature can also be used for testing purposes, to
ensure JMS properties can be understood and handled
correctly.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>errorHandler</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</
code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8.2, 2.9:</strong> Specifies a
<strong><code>org.springframework.util.ErrorHandler</code></strong> to be
invoked in case of any uncaught exceptions thrown while processing a
<code>Message</code>. By default these exceptions will be logged at
the <code>WARN</code> level, if no <code>errorHandler</code> has been
configured. From <strong>Camel 2.9.1:</strong> onward you can configure logging
level and whether stack traces should be logged using the below two options.
This makes it much easier to configure, than having to code a custom
<code>errorHandler</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>errorHandlerLoggingLevel</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>WARN</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.1:</strong>
Configures the logging level at which the <code>errorHandler</code> wi
ll log uncaught exceptions.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>errorHandlerLogStackTrace</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.1:</strong>
Controls whether a stacktrace should be logged by the default
<code>errorHandler</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>exceptionListener</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies the JMS Exception Listener that
is to be notified of any underlying JMS exceptions.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>explicitQosEnabled</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Set if the <code>deliveryMode</c
ode>, <code>priority</code> or <code>timeToLive</code> qualities of service
should be used when sending messages. This option is based on Spring's
<code>JmsTemplate</code>. The <code>deliveryMode</code>, <code>priority</code>
and <code>timeToLive</code> options are applied to the current endpoint. This
contrasts with the <code>preserveMessageQos</code> option, which operates at
message granularity, reading QoS properties exclusively from the Camel In
message headers.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>exposeListenerSession</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Specifies whether the listener
session should be exposed when consuming messages.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>forceSendOriginalMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
col
span="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7:</strong> When
using <code>mapJmsMessage=false</code> Camel will create a new JMS message to
send to a new JMS destination if you touch the headers (get or set) during the
route. Set this option to <code>true</code> to force Camel to send the original
JMS message that was received.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>idleConsumerLimit</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.8.2</strong>,
<strong>2.9</strong>: Specify the limit for the number of consumers that are
allowed to be idle at any given time.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>idleTaskExecutionLimit</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the limit for idle ex
ecutions of a receive task, not having received any message within its
execution. If this limit is reached, the task will shut down and leave
receiving to other executing tasks (in the case of dynamic scheduling; see the
<code>maxConcurrentConsumers</code> setting). There is additional doc available
from <a shape="rect" class="external-link"
href="https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/jms/listener/DefaultMessageListenerContainer.html#setIdleTaskExecutionLimit-int-";
rel="nofollow">Spring</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>includeSentJMSMessageID</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.10.3:</strong>
Only applicable when sending to JMS destination using <code>InOnly</code>,
e.g., fire and forget. Enabling this option will enrich the Camel <a
shape="rect" href="exchange.html">Exch
ange</a> with the actual <code>JMSMessageID</code> that was used by the
JMS client when the message was sent to the JMS
destination.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>includeAllJMSXProperties</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.11.2/2.12:</strong> Whether to include all <code>JMSXxxx</code>
properties when mapping from JMS to Camel Message. When set to
<code>true</code> properties such as <code>JMSXAppID</code>, and
<code>JMSXUserID</code> etc will be included.</p><p><strong>Note:</strong> If
you are using a custom <code>headerFilterStrategy</code> then this option does
not apply.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>jmsKeyFormatStrategy</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>default</code></p></td><td colspan="1"
rowspan="1" class="confl
uenceTd"><p>Pluggable strategy for encoding and decoding JMS keys so they can
be compliant with the JMS specification. Camel provides two implementations out
of the box: <code>default</code> and <code>passthrough</code>. The
<code>default</code> strategy will safely marshal dots and hyphens
(<code>.</code> and <code>-</code>). The <code>passthrough</code> strategy
leaves the key as is. Can be used for JMS brokers which do not care whether JMS
header keys contain illegal characters. You can provide your own implementation
of the
<strong><code>org.apache.camel.component.jms.JmsKeyFormatStrategy</code></strong>
and refer to it using the <code>#</code> notation.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>jmsMessageType</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows you to force the use of a specific
javax.jms.Message implementation for sending JMS mess
ages. Possible values are: <code>Bytes</code>, <code>Map</code>,
<code>Object</code>, <code>Stream</code>, <code>Text</code>. By default Camel
determines which JMS message type to use for the <code>In</code> body
type. This option will override the default behavior.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>jmsOperations</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows you to use your own implementation
of the <strong><code>org.springframework.jms.core.JmsOperations</code></strong>
interface. Camel uses <code>JmsTemplate</code> as default. Can be used for
testing purpose, but not used much as stated in the spring API
docs.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>lazyCreateTransactionManager</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p>If <code>true</code>, Camel will create a
<code>JmsTransactionManager</code>, if there is no
<code>transactionManager</code> injected when option
<code>transacted=true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>listenerConnectionFactory</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The JMS connection factory used
for consuming messages.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>mapJmsMessage</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies whether Camel should auto map the
received JMS message to an appropriate payload type, such as
<strong><code>javax.jms.TextMessage</code></strong> to
a <strong><code>java.lang.</code><code>String</code></strong> etc. See
below for more details on
how message type mapping works.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maximumBrowseSize</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Limits the number of messages fetched at
most, when browsing endpoints using <a shape="rect"
href="browse.html">Browse</a> or JMX API.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>messageConverter</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom Spring
<strong><code>org.springframework.jms.support.converter.MessageConverter</code></strong>
so you can be 100% in control how to map to/from a
<strong><code>javax.jms.Message</code></strong>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>messageIdEnabled</code></p></td><td colspan="1"
rowspan="1" class="co
nfluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>When sending, specifies whether message IDs should be
added.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>messageListenerContainerFactoryRef</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.2:</strong>
Registry ID of the <code>MessageListenerContainerFactory</code> used to
determine what
<strong><code>org.springframework.jms.listener.AbstractMessageListenerContainer</code></strong>
to use to consume messages.</p><p>Setting this will automatically set
<code>consumerType</code> to <code>Custom</code>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>messageTimestampEnabled</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Specifies
whether time-stamps should be enabled by default on sending
messages.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>password</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The password for the connector
factory.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>priority</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>4</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Values greater than <code>1</code>
specify the message priority when sending (where <code>0</code> is the
lowest priority and <code>9</code> is the highest). The
<code>explicitQosEnabled</code> option <strong>must</strong> also be enabled in
order for this option to have any effect.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>pubSubNoLocal</code></p></td><td
colspan="1" rowspan="1" c
lass="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Specifies whether to inhibit the delivery of messages
published by its own connection.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>receiveTimeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The timeout for receiving messages (in
milliseconds).</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>recoveryInterval</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>5000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Specifies the interval between recovery
attempts, e.g., when a connection is being refreshed, in milliseconds. The
default is <code>5000 ms</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>replyToSameDestinationAllowed</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.16:</strong>
<strong>Consumer only:</strong> Whether a JMS consumer is allowed to send a
reply message to the same destination that the consumer is using to consume
from. This prevents an endless loop by consuming and sending back the same
message to itself.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>replyToCacheLevelName</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>CACHE_CONSUMER</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.1:</strong> Sets the
cache level by name for the reply consumer when doing request/reply over JMS.
This option only applies when using fixed reply queues (not temporary). Camel
will by default use: <code>CACHE_CONSUMER</code> for exclusive or shared
w/<code>replyToSelectorName</code> and <code>CACHE_SESSION</code> for shared
without
<code>replyToSelectorName</code>. Some JMS brokers such as IBM WebSphere may
require this parameter to be set to <code>CACHE_NONE</code> in order to
work.</p><p><strong>Note:</strong> The value <code>CACHE_NONE</code> cannot be
used with temporary queues. A higher value, such as <code>CACHE_CONSUMER</code>
or <code>CACHE_SESSION</code>, must be used.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>replyToDestinationSelectorName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Sets the JMS Selector using the
fixed name to be used so you can filter out your own replies from the others
when using a shared queue (that is, if you are not using a temporary reply
queue).</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>replyToDeliveryPersistent</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
col
span="1" rowspan="1" class="confluenceTd"><p>Specifies whether to use
persistent delivery by default for replies.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>requestTimeoutCheckerInterval</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.9.2:</strong>
Configures how often Camel should check for timed out <a shape="rect"
href="exchange.html">Exchange</a>s when doing request/reply over JMS. By
default Camel checks once per second. But if you must react faster when a
timeout occurs, then you can lower this interval, to check more frequently. The
timeout is determined by the option
<code>requestTimeout</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>subscriptionDurable</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>@deprecated:</strong> Enabled by default, if you specify a
<code>durableSubscriptionName</code> and a
<code>clientId</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>taskExecutor</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows you to specify a custom task
executor for consuming messages.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>taskExecutorSpring2</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> To
use when using Spring 2.x with Camel. Allows you to specify a custom task
executor for consuming messages.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>templateConnectionFactory</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code
></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The JMS
>connection factory used for sending messages.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>transactedInOut</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>@deprecated:</strong>
>Specifies whether to use transacted mode for sending messages using
>the <code>InOut</code> <a shape="rect"
>href="exchange-pattern.html">Exchange Pattern</a>. Applies only to producer
>endpoints. See section <a shape="rect"
>href="#JMS-transactedConsumption">Enabling Transacted Consumption</a> for
>more details.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>transactionManager</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>The Spring transaction
>manager to use.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>transactionName</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>"JmsConsumer[destinationName]"</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The name of the transaction to
use.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>transactionTimeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The timeout value of the transaction (in
seconds), if using transacted mode.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>transferException</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>If enabled and you are using <a
shape="rect" href="request-reply.html">Request Reply</a> messaging
(<code>InOut</code>) and an <a shape="rect" href="exchange.html">E
xchange</a> failed on the consumer side, then the caused
<code>Exception</code> will be send back in response as a
<strong><code>javax.jms.ObjectMessage</code></strong>. If the client is Camel,
the returned <code>Exception</code> is re-thrown. This allows you to use Camel
<a shape="rect" href="jms.html">JMS</a> as a bridge in your routing - for
example, using persistent queues to enable robust routing. Notice that if you
also have <code>transferExchange</code> enabled, this option takes precedence.
The caught exception is required to be serializable. The original
<code>Exception</code> on the consumer side can be wrapped in an outer
exception such as
<strong><code>org.apache.camel.RuntimeCamelException</code></strong> when
returned to the producer.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>transferExchange</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>
You can transfer the exchange over the wire instead of just the body and
headers. The following fields are transferred: In body, Out body, Fault body,
In headers, Out headers, Fault headers, exchange properties, exchange
exception. This requires that the objects are serializable. Camel will exclude
any non-serializable objects and log it at WARN level. You must enable this
option on both the producer and consumer side, so Camel knows the payloads is
an Exchange and not a regular payload.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>transferFault</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.17:</strong> If
enabled and you are using Request Reply messaging (<code>InOut</code>) and an
Exchange failed with a SOAP fault (not exception) on the consumer side, then
the fault flag
on <strong><code>org.apache.camel.Message.isFault()</code></st
rong> will be send back in the response as a JMS header with the key
<code>JmsConstants.JMS_TRANSFER_FAULT</code>. If the client is Camel, the
returned fault flag will be set on the
<strong><code>org.apache.camel.Message.setFault(boolean)</code></strong>. You
may want to enable this when using Camel components that support faults such as
SOAP based such as cxf or spring-ws.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>username</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The username for the connector
factory.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useMessageIDAsCorrelationID</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Specifies whether
<code>JMSMessageID</code> should always be used as
<code>JMSCorrelationID</code> for
 <code>InOut</code> messages.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>useVersion102</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>@deprecated (removed
from Camel 2.5 onward)</strong> Specifies whether the old JMS API should be
used.</p></td></tr></tbody></table></div></div><h3
id="JMS-MessageMappingbetweenJMSandCamel">Message Mapping between JMS and
Camel</h3><p>Camel automatically maps messages between
<strong><code>javax.jms.Message</code></strong> and
<strong><code>org.apache.camel.Message</code></strong>.</p><p>When sending a
JMS message, Camel converts the message body to the following JMS message
types:</p><div class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Body Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>JMS Mes
sage</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Comment</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.TextMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>org.w3c.dom.Node</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>javax.jms.TextMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The DOM will be converted to
<code>String</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Map</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.MapMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>java.io.Serializable</code></p></td><td colspan
="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.ObjectMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>byte[]</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.BytesMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>java.io.File</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>javax.jms.BytesMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>java.io.Reader</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>javax.jms.BytesMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>java.io
.InputStream</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.BytesMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>java.nio.ByteBuffer</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.BytesMessage</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td></tr></tbody></table></div></div><p>When
receiving a JMS message, Camel converts the JMS message to the following body
type:</p><div class="confluenceTableSmall"><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>JMS Message</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Body Type</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.TextMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>String</c
ode></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.BytesMessage</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>byte[]</code></p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>javax.jms.MapMessage</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>Map<String,
Object></code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>javax.jms.ObjectMessage</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Object</code></p></td></tr></tbody></table></div></div><h4
id="JMS-Disablingauto-mappingofJMSmessages">Disabling auto-mapping of JMS
messages</h4><p>You can use the <code>mapJmsMessage</code> option to disable
the auto-mapping above. If disabled, Camel will not try to map the received JMS
message, but instead uses it directly as the payload. This allows you to avoid
the overhead of mapping and let Camel just pass through the JMS
message. For instance, it even allows you to route
<strong><code>javax.jms.ObjectMessage</code></strong> JMS messages with classes
you do <strong>not</strong> have on the classpath.</p><h4
id="JMS-UsingacustomMessageConverter">Using a custom
MessageConverter</h4><p>You can use the <code>messageConverter</code> option to
do the mapping yourself in a Spring
<code>org.springframework.jms.support.converter.MessageConverter</code>
class.</p><p>For example, in the route below we use a custom message converter
when sending a message to the JMS order queue:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
[... 171 lines stripped ...]
