You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2014/03/27 17:22:12 UTC
svn commit: r903934 [2/2] - in /websites/production/camel/content:
cache/main.pageCache jms.html
Modified: websites/production/camel/content/jms.html
==============================================================================
--- websites/production/camel/content/jms.html (original)
+++ websites/production/camel/content/jms.html Thu Mar 27 16:22:12 2014
@@ -86,145 +86,55 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="JMS-JMSComponent">JMS Component</h2>
-
- <div class="aui-message hint shadowed information-macro">
+<div class="wiki-content maincontent"><h2 id="JMS-JMSComponent">JMS Component</h2> <div class="aui-message hint shadowed information-macro">
<p class="title">Using ActiveMQ</p>
<span class="aui-icon icon-hint">Icon</span>
<div class="message-content">
-
-<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>
+ <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="aui-message success shadowed information-macro">
<p class="title">Transacted and caching</p>
<span class="aui-icon icon-success">Icon</span>
<div class="message-content">
-
-<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>
+ <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="aui-message success shadowed information-macro">
<p class="title">Request/Reply over JMS</p>
<span class="aui-icon icon-success">Icon</span>
<div class="message-content">
-
-<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>
+ <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>The JMS 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. The implementation of the JMS Component uses Spring's JMS support for declarative transactions, using Spring's <code>JmsTemplate</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">
-<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
-<dependency>
+<p>The JMS 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. The implementation of the JMS Component uses Spring's JMS support for declarative transactions, using Spring's <code>JmsTemplate</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">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-jms</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
]]></script>
-</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="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-jms:[queue:|topic:]destinationName[?options]
+</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="theme: Default; brush: java; gutter: false" 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">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-jms:FOO.BAR
+</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">
+<script class="theme: Default; brush: java; gutter: false" 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">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-jms:queue:FOO.BAR
+</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">
+<script class="theme: Default; brush: java; gutter: false" 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<br clear="none">
-connect to the topic, <code>Stocks.Prices</code>, use:</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-jms:topic:Stocks.Prices
+</div></div><p>To connect to a topic, you <em>must</em> include the <code>topic:</code> prefix. For example, to<br clear="none"> connect to the topic, <code>Stocks.Prices</code>, use:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[jms:topic:Stocks.Prices
]]></script>
-</div></div>
-
-<p>You append query options to the URI using the following format, <code>?option=value&option=value&...</code></p>
-
-<h3 id="JMS-Notes">Notes</h3>
-
-
-<h4 id="JMS-UsingActiveMQ">Using ActiveMQ</h4>
-
-<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://cwiki.apache.org/confluence/s/en_GB-1988229788/4109/76e0dbb30bc8580e459c201f3535d84f9283a9ac.1/_/images/icons/emoticons/smile.png" data-emoticon-name="smile" alt="(smile)"> , then we recommend that you either:</p>
-
-<ul><li>Use the <a shape="rect" href="activemq.html">ActiveMQ</a> component, which is already optimized to use ActiveMQ efficiently</li><li>Use the <code>PoolingConnectionFactory</code> in ActiveMQ.</li></ul>
-
-
-<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 (<code>transacted=true</code>) then the default settings for cache level can impact performance.<br clear="none">
-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 <code>cacheLevelName=CACHE_CONSUMER</code>.</p>
-
-<p>Through Camel 2.7.x, the default setting for <code>cacheLevelName</code> is <code>CACHE_CONSUMER</code>. You will need to explicitly set <code>cacheLevelName=CACHE_NONE</code>.<br clear="none">
-In Camel 2.8 onwards, the default setting for <code>cacheLevelName</code> is <code>CACHE_AUTO</code>. This default auto detects the mode and sets the cache level accordingly to:</p>
-<ul class="alternate"><li>CACHE_CONSUMER = if transacted=false</li><li>CACHE_NONE = if transacted=true</li></ul>
-
-
-<p>So you can say the default setting is conservative. Consider using <code>cacheLevelName=CACHE_CONSUMER</code> 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 specify both <strong>clientId</strong> and <strong>durableSubscriptionName</strong>. The value of the <code>clientId</code> 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 for 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 as follows:</p>
-<ul class="alternate"><li>Dots are replaced by <code>_DOT_</code> and the replacement is reversed when Camel consume the message</li><li>Hyphen is replaced by <code>_HYPHEN_</code> and the replacement is reversed when Camel consumes the message</li></ul>
-
-
-<h3 id="JMS-Options">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="aui-message warning shadowed information-macro">
+</div></div><p>You append query options to the URI using the following format, <code>?option=value&option=value&...</code></p><h3 id="JMS-Notes">Notes</h3><h4 id="JMS-UsingActiveMQ">Using ActiveMQ</h4><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://cwiki.apache.org/confluence/s/en_GB-1988229788/4109/76e0dbb30bc8580e459c201f3535d84f9283a9ac.1/_/images/icons/emoticons/smile.png" data-emoticon-name="smile" alt="(smile)"> , then we recommend that you either:</p><ul><li>Use the <a
shape="rect" href="activemq.html">ActiveMQ</a> component, which is already optimized to use ActiveMQ efficiently</li><li>Use the <code>PoolingConnectionFactory</code> in ActiveMQ.</li></ul><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 (<code>transacted=true</code>) then the default settings for cache level can impact performance.<br clear="none"> 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 <code>cacheLevelName=CACHE_CONSUMER</code>.</p><p>Through Camel 2.7.x, the default setting for <code>cacheLevelName</code> is <code>CACHE_CONSUMER</code>. You will need to explicitly set <code>cacheLevelName=CACHE_NONE</code>.<br cl
ear="none"> In Camel 2.8 onwards, the default setting for <code>cacheLevelName</code> is <code>CACHE_AUTO</code>. This default auto detects the mode and sets the cache level accordingly to:</p><ul class="alternate"><li>CACHE_CONSUMER = if transacted=false</li><li>CACHE_NONE = if transacted=true</li></ul><p>So you can say the default setting is conservative. Consider using <code>cacheLevelName=CACHE_CONSUMER</code> 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 specify both <strong>clientId</strong> and <strong>durableSubscriptionName</strong>. The value of the <code>clientId</code> 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 dur
able 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 for 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 as follows:</p><ul class="alternate"><li>Dots are replaced by <code>_DOT_</code> and the replacement is reversed when Camel consume the message</li><li>Hyphen is replaced by <code>_HYPHEN_</code> and the replacement is reversed when Camel consumes the message</li></ul><h3 id="JMS-Options">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="aui-message warning shadowed information-macro">
<p class="title">Mapping to Spring JMS</p>
<span class="aui-icon icon-warning">Icon</span>
<div class="message-content">
-
-<p>Many of these properties map to properties on Spring JMS, which Camel uses for sending and receiving messages. So you can get more information about these properties by consulting the relevant Spring documentation.</p>
+ <p>Many of these properties map to properties on Spring JMS, which Camel uses for sending and receiving messages. So you can get more information about these properties by consulting the relevant Spring documentation.</p>
</div>
</div>
-
-
-<p>The options are divided into two tables, the first one with the most common options used. The latter contains the rest.</p>
-
-<h4 id="JMS-Mostcommonlyusedoptions">Most commonly used options</h4>
-<div class="confluenceTableSmall">
+<p>The options are divided into two tables, the first one with the most common options used. The latter contains the rest.</p><h4 id="JMS-Mostcommonlyusedoptions">Most commonly used options</h4><div class="confluenceTableSmall">
<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="confluenceT
d"><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> onwards this option can also be used 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>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 InOnly 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 t
hat a route on the other queue will send it´s response directly back 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> onwards this option can also be used when doing request/reply over JMS. See also the <code>maxMessagesPerTask</code> option to control dynamic scal
ing up/down of threads. </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. -1 is unlimited. If you use a range for concurrent consumers (eg min < max), then this option can be used to set a value to eg <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>JMS
DeliveryMode</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" title="Request Reply">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>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>Shared</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 InOut <a shape="rect" href="exchange-pattern.html" title="Exchange Pattern">Exchange Pattern</a> (in milliseconds). The default is 20 seconds. From <strong>Camel 2.13/2.12.3</strong> onwards 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 <em>requestTimeoutCheckerInterval</em> 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 CamelConsumerTemplate </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 InOnly
<a shape="rect" href="exchange-pattern.html" title="Exchange Pattern">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> onwards also the JMS producers is tested as well. </p></td></tr></tbody></table>
@@ -233,176 +143,51 @@ In Camel 2.8 onwards, the default settin
<div class="confluenceTableSmall"></div>
<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" title="JMS">JMS</a> routes at runtime, while there are still messages enqued on the queue. If this option is <code>false</code>, and you stop the <a shape="rect" href="jms.html" title="JMS">JMS</a> route, then messages may be rejected, and the JMS broker would have to attempt redeliveries, which yet again may be rejected, and
eventually the message may be moved at a dead letter queue on the JMS broker. To avoid this its recommended to enable this option. </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>, <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 preferable to use the <code>a
cknowledgementModeName</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>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" class="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" title="Exchange">Exchange</a> <a shape="rect" href="asynchronous-routing-engine.html" title="Asynchronous Routing Engine">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" title="Asynchronous Routing Engine">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" title="Exchange">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 support async 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>tru
e</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>cacheLevelName</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> CACHE_AUTO (Camel >= 2.8.0)<br clear="none" class="atl-forced-newline">
CACHE_CONSUMER (Camel <= 2.7.1) </p></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>. See the <a shape="rect" class="external-link" href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jms/listener/DefaultMessageListenerContainer.html" rel="nofollow">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>cacheLevel</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td>
<td colspan="1" rowspan="1" class="confluenceTd"><p> Sets the cache level by ID for the underlying JMS resources. See <code>cacheLevelName</code> option for more details. </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 consumer type to use, which can be one of: <code>Simple</code>, <code>Default</code>, or <code>Custom</code>. The consumer type determines which Spring JMS listener to use. <code>Default</code> will use <code>org.springframework.jms.listener.DefaultMessageListenerContainer</code>, <code>Simple</code> will use <code>org.springframework.jms.listener.SimpleMessageListenerContainer</code>. When <code>Custom</code> is specified, the <code>MessageListenerContainerFactory</code> defined by the <code>messageListenerContainerFactoryRef</code> option will determine what <code>org.spr
ingframework.jms.listener.AbstractMessageListenerContainer</code> to use (<strong>new option in Camel 2.10.2 onwards</strong>). This option was temporary removed in Camel 2.7 and 2.8. But has been added back from Camel 2.9 onwards. </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>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 TaskExecutor type to use in the DefaultMessageListenerConta
iner, for both consumer endpoints and the ReplyTo 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 shape="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 behaviour, 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> null </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 <code>javax.jms.DeliveryMode</code>. </p></td></tr><tr><td colspan="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 <code>org.springframework.jms.support.destination.DestinationResolver</code> 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 d
isabling 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>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>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 <code>org.springframework.util.ErrorHandler</code> 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 WARN level, if no <code>errorHandler</code> has been configured. From <strong>Camel 2.9.1:</strong> onwards 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> Allows to configure the default <code>errorHandler</code> logging level for logging 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> Allows to control whether stacktraces should be logged or not, by the default <code>errorHandler</code>. </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</code>, <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 colspan="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>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 executions 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="http://static.springsource.org/spring/docs/3.0.5.RELEASE/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>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, 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" rows
pan="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 InOnly (eg fire and forget). Enabling this option will enrich the Camel <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> with the actual JMSMessageID 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 JMSXxxx properties when mapping from JMS to Camel Message. Setting this to <code>true</code> will include properties such as <code>JMSXApp
ID</code>, and <code>JMSXUserID</code> etc. <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>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 <code>javax.jms.Message</code> implementation for sending JMS messages. Possible values are: <code>Bytes</code>, <code>Map</code>, <code>Object</code>, <code>Stream</code>, <code>Text</code>. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. </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 <code>org.apache.camel.component.jms.JmsKeyFormatStrategy</code> and refer to it using the <code>#</code> notation. </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 <code>org.springframework.jms.core.JmsOperations</code> i
nterface. 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 cols
pan="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 appropiate payload type, such as <code>javax.jms.TextMessage</code> to a <code>String</code> etc. See section about how mapping works below for more details. </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" title="Browse">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 <code>org.springframework.jms.support.converter.MessageConverter</code> so you can be 100% in control how to map to/from a <code>javax.jms.Message</code>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>messageIdEnabled</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><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 <code>org.springframework.jms.listener.AbstractMessageListenerContainer</code> to use to consume messages. 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 timestamps 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 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the hig
hest). 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" class="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> <em>None</em> </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> Sp
ecifies the interval between recovery attempts, i.e. when a connection is being refreshed, in milliseconds. The default is 5000 ms, that is, 5 seconds. </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> CACHE_CONSUMER </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 to set the <code>replyToCacheLevelName=CACHE_NONE</code> to work. <strong>Note:</strong> If using temporary queues then <code>CACHE_NONE</code> is not allowed,
and you must use a higher value such as <code>CACHE_CONSUMER</code> or <code>CACHE_SESSION</code>. </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 colspan="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 c
olspan="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" title="Exchange">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 <em>requestTimeout</em>. </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>durableSubscriberName</code> and a <code>clientId</code>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>taskExecut
or</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>transacte
dInOut</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 InOut <a shape="rect" href="exchange-pattern.html" title="Exchange Pattern">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" title="Request Reply">Request Reply</a> messaging (InOut) and an <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> failed on the consumer side, then the caused <code>Exception</code> will be send back in response as a <code>javax.jms.ObjectMe
ssage</code>. If the client is Camel, the returned <code>Exception</code> is rethrown. This allows you to use Camel <a shape="rect" href="jms.html" title="JMS">JMS</a> as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have <strong>transferExchange</strong> 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 <code>org.apache.camel.RuntimeCamelException</code> 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, I
n 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 <code>WARN</code> level. You <strong>must</strong> 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>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</cod
e> for <strong>InOut</strong> 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 onwards):</strong> Specifies whether the old JMS API should be used. </p></td></tr></tbody></table>
-</div>
-
-<h3 id="JMS-MessageMappingbetweenJMSandCamel">Message Mapping between JMS and Camel</h3>
-
-<p>Camel automatically maps messages between <code>javax.jms.Message</code> and <code>org.apache.camel.Message</code>.</p>
-
-<p>When sending a JMS message, Camel converts the message body to the following JMS message types:</p>
-
-<div class="confluenceTableSmall">
+</div><h3 id="JMS-MessageMappingbetweenJMSandCamel">Message Mapping between JMS and Camel</h3><p>Camel automatically maps messages between <code>javax.jms.Message</code> and <code>org.apache.camel.Message</code>.</p><p>When sending a JMS message, Camel converts the message body to the following JMS message types:</p><div class="confluenceTableSmall">
<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 Message </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" clas
s="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>
-
-<p>When receiving a JMS message, Camel converts the JMS message to the following body type:</p>
-<div class="confluenceTableSmall">
+</div><p>When receiving a JMS message, Camel converts the JMS message to the following body type:</p><div class="confluenceTableSmall">
<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</code> </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>
-
-<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 <code>javax.jms.ObjectMessage</code> 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">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- from("file://inbox/order").to("jms:queue:order?messageConverter=#myMessageConverter");
+</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 <code>javax.jms.ObjectMessage</code> 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="code
Content panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ from("file://inbox/order").to("jms:queue:order?messageConverter=#myMessageConverter");
]]></script>
-</div></div>
-
-<p>You can also use a custom message converter when consuming from a JMS destination.</p>
-
-<h4 id="JMS-Controllingthemappingstrategyselected">Controlling the mapping strategy selected</h4>
-
-<p>You can use the <strong>jmsMessageType</strong> option on the endpoint URL to force a specific message type for all messages.<br clear="none">
-In the route below, we poll files from a folder and send them as <code>javax.jms.TextMessage</code> as we have forced the JMS producer endpoint to use text messages:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- from("file://inbox/order").to("jms:queue:order?jmsMessageType=Text");
+</div></div><p>You can also use a custom message converter when consuming from a JMS destination.</p><h4 id="JMS-Controllingthemappingstrategyselected">Controlling the mapping strategy selected</h4><p>You can use the <strong>jmsMessageType</strong> option on the endpoint URL to force a specific message type for all messages.<br clear="none"> In the route below, we poll files from a folder and send them as <code>javax.jms.TextMessage</code> as we have forced the JMS producer endpoint to use text messages:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ from("file://inbox/order").to("jms:queue:order?jmsMessageType=Text");
]]></script>
-</div></div>
-
-<p>You can also specify the message type to use for each messabe by setting the header with the key <code>CamelJmsMessageType</code>. For example:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- from("file://inbox/order").setHeader("CamelJmsMessageType", JmsMessageType.Text).to("jms:queue:order");
+</div></div><p>You can also specify the message type to use for each messabe by setting the header with the key <code>CamelJmsMessageType</code>. For example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ from("file://inbox/order").setHeader("CamelJmsMessageType", JmsMessageType.Text).to("jms:queue:order");
]]></script>
-</div></div>
-
-<p>The possible values are defined in the <code>enum</code> class, <code>org.apache.camel.jms.JmsMessageType</code>.</p>
-
-<h3 id="JMS-Messageformatwhensending">Message format when sending</h3>
-
-<p>The exchange that is sent over the JMS wire must conform to the <a shape="rect" class="external-link" href="http://java.sun.com/j2ee/1.4/docs/api/javax/jms/Message.html" rel="nofollow">JMS Message spec</a>.</p>
-
-<p>For the <code>exchange.in.header</code> the following rules apply for the header <strong>keys</strong>:</p>
-<ul class="alternate"><li>Keys starting with <code>JMS</code> or <code>JMSX</code> are reserved.</li><li><code>exchange.in.headers</code> keys must be literals and all be valid Java identifiers (do not use dots in the key name).</li><li>Camel replaces dots & hyphens and the reverse when when consuming JMS messages:<br clear="none">
-<code>.</code> is replaced by <code>_DOT_</code> and the reverse replacement when Camel consumes the message.<br clear="none">
-<code>-</code> is replaced by <code>_HYPHEN_</code> and the reverse replacement when Camel consumes the message.</li><li>See also the option <code>jmsKeyFormatStrategy</code>, which allows use of your own custom strategy for formatting keys.</li></ul>
-
-
-<p>For the <code>exchange.in.header</code>, the following rules apply for the header <strong>values</strong>:</p>
-<ul class="alternate"><li>The values must be primitives or their counter objects (such as <code>Integer</code>, <code>Long</code>, <code>Character</code>). The types, <code>String</code>, <code>CharSequence</code>, <code>Date</code>, <code>BigDecimal</code> and <code>BigInteger</code> are all converted to their <code>toString()</code> representation. All other types are dropped.</li></ul>
-
-
-<p>Camel will log with category <code>org.apache.camel.component.jms.JmsBinding</code> at <strong>DEBUG</strong> level if it drops a given header value. For example:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-2008-07-09 06:43:04,046 [main ] DEBUG JmsBinding
+</div></div><p>The possible values are defined in the <code>enum</code> class, <code>org.apache.camel.jms.JmsMessageType</code>.</p><h3 id="JMS-Messageformatwhensending">Message format when sending</h3><p>The exchange that is sent over the JMS wire must conform to the <a shape="rect" class="external-link" href="http://java.sun.com/j2ee/1.4/docs/api/javax/jms/Message.html" rel="nofollow">JMS Message spec</a>.</p><p>For the <code>exchange.in.header</code> the following rules apply for the header <strong>keys</strong>:</p><ul class="alternate"><li>Keys starting with <code>JMS</code> or <code>JMSX</code> are reserved.</li><li><code>exchange.in.headers</code> keys must be literals and all be valid Java identifiers (do not use dots in the key name).</li><li>Camel replaces dots & hyphens and the reverse when when consuming JMS messages:<br clear="none"> <code>.</code> is replaced by <code>_DOT_</code> and the reverse replacement when Camel consumes the message.<br clear="none"> <code>-
</code> is replaced by <code>_HYPHEN_</code> and the reverse replacement when Camel consumes the message.</li><li>See also the option <code>jmsKeyFormatStrategy</code>, which allows use of your own custom strategy for formatting keys.</li></ul><p>For the <code>exchange.in.header</code>, the following rules apply for the header <strong>values</strong>:</p><ul class="alternate"><li>The values must be primitives or their counter objects (such as <code>Integer</code>, <code>Long</code>, <code>Character</code>). The types, <code>String</code>, <code>CharSequence</code>, <code>Date</code>, <code>BigDecimal</code> and <code>BigInteger</code> are all converted to their <code>toString()</code> representation. All other types are dropped.</li></ul><p>Camel will log with category <code>org.apache.camel.component.jms.JmsBinding</code> at <strong>DEBUG</strong> level if it drops a given header value. For example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent p
anelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[2008-07-09 06:43:04,046 [main ] DEBUG JmsBinding
- Ignoring non primitive header: order of class: org.apache.camel.component.jms.issues.DummyOrder with value: DummyOrder{orderId=333, itemId=4444, quantity=2}
]]></script>
-</div></div>
-
-
-<h3 id="JMS-Messageformatwhenreceiving">Message format when receiving</h3>
-
-<p>Camel adds the following properties to the <code>Exchange</code> when it receives a message:</p>
-<div class="confluenceTableSmall">
+</div></div><h3 id="JMS-Messageformatwhenreceiving">Message format when receiving</h3><p>Camel adds the following properties to the <code>Exchange</code> when it receives a message:</p><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Property </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Type </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>org.apache.camel.jms.replyDestination</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>javax.jms.Destination</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The reply destination. </p></td></tr></tbody></table>
-</div>
-
-<p>Camel adds the following JMS properties to the In message headers when it receives a JMS message:</p>
-<div class="confluenceTableSmall">
+</div><p>Camel adds the following JMS properties to the In message headers when it receives a JMS message:</p><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Header </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Type </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSCorrelationID</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>String</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS correlation ID. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSDeliveryMode</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>int</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS delivery mode. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSDestination</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>javax.jms.Destination</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> The JMS destination. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSExpiration</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>long</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS expiration. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSMessageID</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>String</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS unique message ID. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSPriority</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>int</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS priority (with 0 as the lowest priority and 9 as the highest). </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSRedelivered</code> </p>
</td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>boolean</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Is the JMS message redelivered. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSReplyTo</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>javax.jms.Destination</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS reply-to destination. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSTimestamp</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>long</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS timestamp. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSType</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>String</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS type. </p></td></tr><tr><td colspan="1
" rowspan="1" class="confluenceTd"><p> <code>JMSXGroupID</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>String</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The JMS group ID. </p></td></tr></tbody></table>
-</div>
-<p>As all the above information is standard JMS you can check the <a shape="rect" class="external-link" href="http://java.sun.com/javaee/5/docs/api/javax/jms/Message.html" rel="nofollow">JMS documentation</a> for further details.</p>
-
-
-<h3 id="JMS-AboutusingCameltosendandreceivemessagesandJMSReplyTo">About using Camel to send and receive messages and JMSReplyTo</h3>
-
-<p>The JMS component is complex and you have to pay close attention to how it works in some cases. So this is a short summary of some of the areas/pitfalls to look for.</p>
-
-<p>When Camel sends a message using its <code>JMSProducer</code>, it checks the following conditions:</p>
-<ul class="alternate"><li>The message exchange pattern,</li><li>Whether a <code>JMSReplyTo</code> was set in the endpoint or in the message headers,</li><li>Whether any of the following options have been set on the JMS endpoint: <code>disableReplyTo</code>, <code>preserveMessageQos</code>, <code>explicitQosEnabled</code>.</li></ul>
-
-
-<p>All this can be a tad complex to understand and configure to support your use case.</p>
-
-<h4 id="JMS-JmsProducer">JmsProducer</h4>
-
-<p>The <code>JmsProducer</code> behaves as follows, depending on configuration:</p>
-<div class="confluenceTableSmall">
+</div><p>As all the above information is standard JMS you can check the <a shape="rect" class="external-link" href="http://java.sun.com/javaee/5/docs/api/javax/jms/Message.html" rel="nofollow">JMS documentation</a> for further details.</p><h3 id="JMS-AboutusingCameltosendandreceivemessagesandJMSReplyTo">About using Camel to send and receive messages and JMSReplyTo</h3><p>The JMS component is complex and you have to pay close attention to how it works in some cases. So this is a short summary of some of the areas/pitfalls to look for.</p><p>When Camel sends a message using its <code>JMSProducer</code>, it checks the following conditions:</p><ul class="alternate"><li>The message exchange pattern,</li><li>Whether a <code>JMSReplyTo</code> was set in the endpoint or in the message headers,</li><li>Whether any of the following options have been set on the JMS endpoint: <code>disableReplyTo</code>, <code>preserveMessageQos</code>, <code>explicitQosEnabled</code>.</li></ul><p>All this can
be a tad complex to understand and configure to support your use case.</p><h4 id="JMS-JmsProducer">JmsProducer</h4><p>The <code>JmsProducer</code> behaves as follows, depending on configuration:</p><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Exchange Pattern </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Other options </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>InOut</em> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> - </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Camel will expect a reply, set a temporary <code>JMSReplyTo</code>, and after sending the message, it will start to listen for the reply message on the temporary queue. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>InOut</em> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSReplyTo</code> is set </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Camel will expect a reply and, after sending the message, it will start to listen for the reply message on the sp
ecified <code>JMSReplyTo</code> queue. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>InOnly</em> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> - </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Camel will send the message and <strong>not</strong> expect a reply. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>InOnly</em> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>JMSReplyTo</code> is set </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> By default, Camel discards the <code>JMSReplyTo</code> destination and clears the <code>JMSReplyTo</code> header before sending the message. Camel then sends the message and does <strong>not</strong> expect a reply. Camel logs this in the log at <code>WARN</code> level (changed to <code>DEBUG</code> level from <strong>Camel 2.6</strong> onwards. You can use <code>preserveMessageQuo=true</code> to instruct Camel to keep the <code>J
MSReplyTo</code>. In all situations the <code>JmsProducer</code> does <strong>not</strong> expect any reply and thus continue after sending the message. </p></td></tr></tbody></table>
-</div>
-
-<h4 id="JMS-JmsConsumer">JmsConsumer</h4>
-
-<p>The <code>JmsConsumer</code> behaves as follows, depending on configuration:</p>
-<div class="confluenceTableSmall">
+</div><h4 id="JMS-JmsConsumer">JmsConsumer</h4><p>The <code>JmsConsumer</code> behaves as follows, depending on configuration:</p><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Exchange Pattern </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Other options </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>InOut</em> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> - </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Camel will send the reply back to the <code>JMSReplyTo</code> queue. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>InOnly</em> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> - </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Camel will not send a reply back, as the pattern is <em>InOnly</em>. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> - </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>disableReplyTo=true</code> </p>
</td><td colspan="1" rowspan="1" class="confluenceTd"><p> This option suppresses replies. </p></td></tr></tbody></table>
-</div>
-
-<p>So pay attention to the message exchange pattern set on your exchanges.</p>
-
-<p>If you send a message to a JMS destination in the middle of your route you can specify the exchange pattern to use, see more at <a shape="rect" href="request-reply.html">Request Reply</a>.<br clear="none">
-This is useful if you want to send an <code>InOnly</code> message to a JMS topic:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-from("activemq:queue:in")
+</div><p>So pay attention to the message exchange pattern set on your exchanges.</p><p>If you send a message to a JMS destination in the middle of your route you can specify the exchange pattern to use, see more at <a shape="rect" href="request-reply.html">Request Reply</a>.<br clear="none"> This is useful if you want to send an <code>InOnly</code> message to a JMS topic:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[from("activemq:queue:in")
.to("bean:validateOrder")
.to(ExchangePattern.InOnly, "activemq:topic:order")
.to("bean:handleOrder");
]]></script>
-</div></div>
-
-<h3 id="JMS-Reuseendpointandsendtodifferentdestinationscomputedatruntime">Reuse endpoint and send to different destinations computed at runtime</h3>
-
-<p>If you need to send messages to a lot of different JMS destinations, it makes sense to reuse a JMS endpoint and specify the real destination in a message header. This allows Camel to reuse the same endpoint, but send to different destinations. This greatly reduces the number of endpoints created and economizes on memory and thread resources.</p>
-
-<p>You can specify the destination in the following headers:</p>
-<div class="confluenceTableSmall">
+</div></div><h3 id="JMS-Reuseendpointandsendtodifferentdestinationscomputedatruntime">Reuse endpoint and send to different destinations computed at runtime</h3><p>If you need to send messages to a lot of different JMS destinations, it makes sense to reuse a JMS endpoint and specify the real destination in a message header. This allows Camel to reuse the same endpoint, but send to different destinations. This greatly reduces the number of endpoints created and economizes on memory and thread resources.</p><p>You can specify the destination in the following headers:</p><div class="confluenceTableSmall">
[... 533 lines stripped ...]