Repository: camel Updated Branches: refs/heads/master ea647a95c -> f3f4ff9c3
Generated component and endpoint options in Camel JMS component and polish Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/f3f4ff9c Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/f3f4ff9c Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/f3f4ff9c Branch: refs/heads/master Commit: f3f4ff9c3fdc7801aa21ff822aa84506793257fa Parents: 8551825 Author: Antonin Stefanutti <anto...@stefanutti.fr> Authored: Mon Mar 21 15:22:40 2016 +0100 Committer: Antonin Stefanutti <anto...@stefanutti.fr> Committed: Mon Mar 21 15:23:51 2016 +0100 ---------------------------------------------------------------------- components/camel-jms/src/main/docs/jms.adoc | 729 +++++++---------------- 1 file changed, 208 insertions(+), 521 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/f3f4ff9c/components/camel-jms/src/main/docs/jms.adoc ---------------------------------------------------------------------- diff --git a/components/camel-jms/src/main/docs/jms.adoc b/components/camel-jms/src/main/docs/jms.adoc index 071316c..a930518 100644 --- a/components/camel-jms/src/main/docs/jms.adoc +++ b/components/camel-jms/src/main/docs/jms.adoc @@ -1,4 +1,5 @@ ifdef::env-github[] +:icon-smile: :smiley: :caution-caption: :boom: :important-caption: :exclamation: :note-caption: :information_source: @@ -6,6 +7,12 @@ ifdef::env-github[] :warning-caption: :warning: endif::[] +ifndef::env-github[] +:icons: font +:icon-smile: icon:smile-o[fw,role=yellow] +endif::[] + + [[JMS-JMSComponent]] JMS Component ~~~~~~~~~~~~~ @@ -105,9 +112,8 @@ some caching in the JMS provider to avoid http://activemq.apache.org/jmstemplate-gotchas.html[poor performance]. If you intend to use http://activemq.apache.org/[Apache ActiveMQ] as -your Message Broker - which is a good choice as ActiveMQ rocks -image:https://cwiki.apache.org/confluence/s/en_GB/5982/f2b47fb3d636c8bc9fd0b11c0ec6d0ae18646be7.1/_/images/icons/emoticons/smile.png[(smile)] -, then we recommend that you either: +your Message Broker - which is a good choice as ActiveMQ rocks {icon-smile}, +then we recommend that you either: * Use the link:activemq.html[ActiveMQ] component, which is already optimized to use ActiveMQ efficiently @@ -119,8 +125,9 @@ Transactions and Cache Levels If you are consuming messages and using transactions (`transacted=true`) then the default settings for cache level can impact -performance. + - If you are using XA transactions then you cannot cache as it can cause +performance. + +If you are using XA transactions then you cannot cache as it can cause the XA transaction to not work properly. If you are *not* using XA, then you should consider caching as it speeds @@ -128,13 +135,14 @@ up performance, such as setting `cacheLevelName=CACHE_CONSUMER`. Through Camel 2.7.x, the default setting for `cacheLevelName` is `CACHE_CONSUMER`. You will need to explicitly set -`cacheLevelName=CACHE_NONE`. + - In Camel 2.8 onwards, the default setting for `cacheLevelName` is +`cacheLevelName=CACHE_NONE`. + +In Camel 2.8 onwards, the default setting for `cacheLevelName` is `CACHE_AUTO`. This default auto detects the mode and sets the cache level accordingly to: -* CACHE_CONSUMER = if transacted=false -* CACHE_NONE = if transacted=true +* `CACHE_CONSUMER` if `transacted=false` +* `CACHE_NONE` if `transacted=true` So you can say the default setting is conservative. Consider using `cacheLevelName=CACHE_CONSUMER` if you are using non-XA transactions. @@ -144,7 +152,7 @@ Durable Subscriptions +++++++++++++++++++++ If you wish to use durable topic subscriptions, you need to specify both -*clientId* and **durableSubscriptionName**. The value of the `clientId` +`clientId` and `durableSubscriptionName`. The value of the `clientId` must be unique and can only be used by a single JMS connection instance in your entire network. You may prefer to use http://activemq.apache.org/virtual-destinations.html[Virtual Topics] @@ -194,503 +202,180 @@ uses for sending and receiving messages. So you can get more information about these properties by consulting the relevant Spring documentation. ==== -The options are divided into two tables, the first one with the most -common options used. The latter contains the rest. +[[JMS-Componentoptions]] +Component options ++++++++++++++++++ -[[JMS-Mostcommonlyusedoptions]] -Most commonly used options -++++++++++++++++++++++++++ -[width="100%",cols="10%,10%,80%",options="header",] +// component options: START +The JMS component supports 68 options which are listed below. + + + +[width="100%",cols="2s,1m,8",options="header"] |======================================================================= -|Option |Default Value |Description -|`clientId` |`null` |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 -http://activemq.apache.org/virtual-destinations.html[Virtual Topics] -instead. - -|`concurrentConsumers` |`1` |Specifies the default number of concurrent -consumers. From *Camel 2.10.3* onwards this option can also be used when -doing request/reply over JMS. From *Camel 2.16* onwards there is a new -replyToConcurrentConsumers. See also the `maxMessagesPerTask` option to -control dynamic scaling up/down of threads. - -|`replyToConcurrentConsumers` |1 |*Camel 2.16:* Specifies the default -number of concurrent consumers when doing request/reply over JMS. - -|`disableReplyTo` |`false` |If `true`, a producer will behave like a -InOnly exchange with the exception that `JMSReplyTo` header is sent out -and not be suppressed like in the case of `InOnly`. Like `InOnly` the -producer will not wait for a reply. A consumer with this flag will -behave like `InOnly`. This feature can be used to bridge `InOut` -requests to another queue so that a route on the other queue will send -it´s response directly back to the original `JMSReplyTo`. - -|`durableSubscriptionName` |`null` |The durable subscriber name for -specifying durable topic subscriptions. The `clientId` option *must* be -configured as well. - -|`maxConcurrentConsumers` |`1` |Specifies the maximum number of -concurrent consumers. From *Camel 2.10.3* onwards this option can also -be used when doing request/reply over JMS. From **Camel 2.16** onwards -there is a new replyToMaxConcurrentConsumers. See also the -`maxMessagesPerTask` option to control dynamic scaling up/down of -threads. The `maxMessagesPerTask` option MUST be set to an integer -greater than 0 for threads to scale down. Otherwise, the number of -threads will stay at maxConcurrentConsumers until shutdown. - -|`replyToMaxConcurrentConsumers` |1 |*Camel 2.16:* Specifies the maximum -number of concurrent consumers when doing request/reply over JMS. See -also the `maxMessagesPerTask` option to control dynamic scaling up/down -of threads. - -|`maxMessagesPerTask` |`-1` |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 `100` to control how -fast the consumers will shrink when less work is required. - -|`preserveMessageQos` |`false` |Set to `true`, 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 `JMSPriority`, `JMSDeliveryMode`, and `JMSExpiration`. 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 -`explicitQosEnabled` option, by contrast, will only use options set on -the endpoint, and not values from the message header. - -|`replyTo` |`null` |Provides an explicit ReplyTo destination, which -overrides any incoming value of `Message.getJMSReplyTo()`. If you do -link:request-reply.html[Request Reply] over JMS then *make sure* to read -the section _Request-reply over JMS_ further below for more details, and -the `replyToType` option as well. - -|`replyToOverride` |`null` |*Camel 2.15:* Provides an explicit ReplyTo -destination in the JMS message, which overrides the setting of replyTo. -It is useful if you want to forward the message to a remote Queue and -receive the reply message from the ReplyTo destination. - -|`replyToType` |`null` |*Camel 2.9:* Allows for explicitly specifying -which kind of strategy to use for replyTo queues when doing -request/reply over JMS. Possible values are: `Temporary`, `Shared`, or -`Exclusive`. By default Camel will use temporary queues. However if -`replyTo` has been configured, then `Shared` 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 -`Shared` reply queues has lower performance than its alternatives -`Temporary` and `Exclusive`. - -|`requestTimeout` |`20000` |*Producer only:* The timeout for waiting for -a reply when using the InOut link:exchange-pattern.html[Exchange -Pattern] (in milliseconds). The default is 20 seconds. From *Camel -2.13/2.12.3* onwards you can include the header -`"CamelJmsRequestTimeout"` to override this endpoint configured timeout -value, and thus have per message individual timeout values. See below in -section _About time to live_ for more details. See also the -_requestTimeoutCheckerInterval_ option. - -|`selector` |`null` |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 **Before Camel 2.3.0**, we -don't support this option in CamelConsumerTemplate - -|`timeToLive` |`null` |When sending messages, specifies the time-to-live -of the message (in milliseconds). See below in section _About time to -live_ for more details. - -|`transacted` |`false` |Specifies whether to use transacted mode for -sending/receiving messages using the InOnly -link:exchange-pattern.html[Exchange Pattern]. - -|`testConnectionOnStartup` |`false` |*Camel 2.1:* 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 -*Camel 2.8* onwards also the JMS producers is tested as well. +| Name | Java Type | Description +| configuration | JmsConfiguration | To use a shared JMS configuration +| acceptMessagesWhileStopping | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqued on the queue. If this option is false and you stop the JMS 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. +| acknowledgementMode | int | 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 acknowledgementModeName instead. +| eagerLoadingOfProperties | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties +| acknowledgementModeName | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE +| autoStartup | boolean | Specifies whether the consumer container should auto-startup. +| cacheLevel | int | Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. +| cacheLevelName | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. +| replyToCacheLevelName | String | 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: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. +| clientId | String | 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. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. +| concurrentConsumers | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. +| replyToConcurrentConsumers | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. +| connectionFactory | ConnectionFactory | Sets the default connection factory to be use +| deliveryPersistent | boolean | Specifies whether persistent delivery is used by default. +| deliveryMode | Integer | Specifies the delivery mode to be used. Possible values are Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. +| durableSubscriptionName | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. +| exceptionListener | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. +| errorHandler | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler. +| errorHandlerLoggingLevel | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions. +| errorHandlerLogStackTrace | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler. +| explicitQosEnabled | boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers. +| exposeListenerSession | boolean | Specifies whether the listener session should be exposed when consuming messages. +| idleTaskExecutionLimit | int | 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 maxConcurrentConsumers setting). There is additional doc available from Spring. +| idleConsumerLimit | int | Specify the limit for the number of consumers that are allowed to be idle at any given time. +| maxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. +| replyToMaxConcurrentConsumers | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. +| maxMessagesPerTask | int | 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 100 to control how fast the consumers will shrink when less work is required. +| messageConverter | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message. +| mapJmsMessage | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. See section about how mapping works below for more details. +| messageIdEnabled | boolean | When sending specifies whether message IDs should be added. +| messageTimestampEnabled | boolean | Specifies whether timestamps should be enabled by default on sending messages. +| alwaysCopyMessage | boolean | If true 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 replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set) +| useMessageIDAsCorrelationID | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. +| priority | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect. +| pubSubNoLocal | boolean | Specifies whether to inhibit the delivery of messages published by its own connection. +| receiveTimeout | long | The timeout for receiving messages (in milliseconds). +| recoveryInterval | long | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. +| subscriptionDurable | boolean | Deprecated: Enabled by default if you specify a durableSubscriptionName and a clientId. +| taskExecutor | TaskExecutor | Allows you to specify a custom task executor for consuming messages. +| timeToLive | long | When sending messages specifies the time-to-live of the message (in milliseconds). +| transacted | boolean | Specifies whether to use transacted mode +| lazyCreateTransactionManager | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true. +| transactionManager | PlatformTransactionManager | The Spring transaction manager to use. +| transactionName | String | The name of the transaction to use. +| transactionTimeout | int | The timeout value of the transaction (in seconds) if using transacted mode. +| testConnectionOnStartup | boolean | 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. The JMS producers is tested as well. +| asyncStartListener | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer 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 true you will let routes startup while the JmsConsumer 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 WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. +| asyncStopListener | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route. +| forceSendOriginalMessage | boolean | When using mapJmsMessage=false 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 true to force Camel to send the original JMS message that was received. +| requestTimeout | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option. +| requestTimeoutCheckerInterval | long | Configures how often Camel should check for timed out Exchanges 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 requestTimeout. +| transferExchange | boolean | 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. +| transferException | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. +| transferFault | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on link org.apache.camel.MessageisFault() will be send back in the response as a JMS header with the key link JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws. +| jmsOperations | JmsOperations | Allows you to use your own implementation of the org.springframework.jms.core.JmsOperations interface. Camel uses JmsTemplate as default. Can be used for testing purpose but not used much as stated in the spring API docs. +| destinationResolver | DestinationResolver | A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example to lookup the real destination in a JNDI registry). +| replyToType | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive. +| preserveMessageQos | boolean | Set to true 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 JMSPriority JMSDeliveryMode and JMSExpiration. 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 explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header. +| asyncConsumer | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions). +| allowNullBody | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. +| includeSentJMSMessageID | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination. +| includeAllJMSXProperties | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. +| defaultTaskExecutorType | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor 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 ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers. +| jmsKeyFormatStrategy | JmsKeyFormatStrategy | 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: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough 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 org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. +| applicationContext | ApplicationContext | Sets the Spring ApplicationContext to use +| queueBrowseStrategy | QueueBrowseStrategy | To use a custom QueueBrowseStrategy when browsing queues +| headerFilterStrategy | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. +| messageCreatedStrategy | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. |======================================================================= +// component options: END -[[JMS-Alltheotheroptions]] -All the other options -+++++++++++++++++++++ - +[[JMS-Endpointoptions]] +Endpoint options +++++++++++++++++ -[width="100%",cols="10%,10%,80%",options="header",] + +// endpoint options: START +The JMS component supports 75 endpoint options which are listed below: + +[width="100%",cols="2s,1,1m,1m,5",options="header"] |======================================================================= -|Option |Default Value |Description -|`acceptMessagesWhileStopping` |`false` |Specifies whether the consumer -accept messages while it is stopping. You may consider enabling this -option, if you start and stop link:jms.html[JMS] routes at runtime, -while there are still messages enqued on the queue. If this option is -`false`, and you stop the link:jms.html[JMS] 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. - -|`acknowledgementModeName` |`AUTO_ACKNOWLEDGE` |The JMS acknowledgement -name, which is one of: `SESSION_TRANSACTED`, `CLIENT_ACKNOWLEDGE`, -`AUTO_ACKNOWLEDGE`, `DUPS_OK_ACKNOWLEDGE` - -|`acknowledgementMode` |`-1` |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 -`acknowledgementModeName` instead. - -|`allowNullBody` |`true` |*Camel 2.9.3/2.10.1:* Whether to allow sending -messages with no body. If this option is `false` and the message body is -null, then an `JMSException` is thrown. - -|`alwaysCopyMessage` |`false` |If `true`, 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 `replyToDestinationSelectorName` is set (incidentally, Camel will set -the `alwaysCopyMessage` option to `true`, if a -`replyToDestinationSelectorName` is set) - -|`asyncConsumer` |`false` |*Camel 2.9:* Whether the `JmsConsumer` -processes the link:exchange.html[Exchange] -link:asynchronous-routing-engine.html[asynchronously]. If enabled then -the `JmsConsumer` may pickup the next message from the JMS queue, while -the previous message is being processed asynchronously (by the -link:asynchronous-routing-engine.html[Asynchronous Routing Engine]). -This means that messages may be processed not 100% strictly in order. If -disabled (as default) then the link:exchange.html[Exchange] is fully -processed before the `JmsConsumer` will pickup the next message from the -JMS queue. Note if `transacted` has been enabled, then -`asyncConsumer=true` does not run asynchronously, as transactions must -be executed synchronously (Camel 3.0 may support async transactions). - -|`asyncStartListener` |`false` |*Camel 2.10:* Whether to startup the -`JmsConsumer` message listener asynchronously, when starting a route. -For example if a `JmsConsumer` 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 -`true`, you will let routes startup, while the `JmsConsumer` 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 `WARN` level, and the -consumer will not be able to receive messages; You can then restart the -route to retry. - -|`asyncStopListener` |`false` |*Camel 2.10:* Whether to stop the -`JmsConsumer` message listener asynchronously, when stopping a route. - -|`autoStartup` |`true` |Specifies whether the consumer container should -auto-startup. - -|`cacheLevelName` |CACHE_AUTO (Camel >= 2.8.0) + - CACHE_CONSUMER (Camel <= 2.7.1) |Sets the cache level by name for the -underlying JMS resources. Possible values are: `CACHE_AUTO`, -`CACHE_CONNECTION`, `CACHE_CONSUMER`, `CACHE_NONE`, and `CACHE_SESSION`. -The default setting for *Camel 2.8* and newer is `CACHE_AUTO`. For -*Camel 2.7.1* and older the default is `CACHE_CONSUMER`. See the -http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jms/listener/DefaultMessageListenerContainer.html[Spring -documentation] and link:jms.html[Transactions Cache Levels] for more -information. - -|`cacheLevel` | |Sets the cache level by ID for the underlying JMS -resources. See `cacheLevelName` option for more details. - -|`consumerType` |`Default` |The consumer type to use, which can be one -of: `Simple`, `Default`, or `Custom`. The consumer type determines which -Spring JMS listener to use. `Default` will use -`org.springframework.jms.listener.DefaultMessageListenerContainer`, -`Simple` will use -`org.springframework.jms.listener.SimpleMessageListenerContainer`. When -`Custom` is specified, the `MessageListenerContainerFactory` defined by -the `messageListenerContainerFactoryRef` option will determine what -`org.springframework.jms.listener.AbstractMessageListenerContainer` to -use (**new option in Camel 2.10.2 onwards**). This option was temporary -removed in Camel 2.7 and 2.8. But has been added back from Camel 2.9 -onwards. - -|`connectionFactory` |`null` |The default JMS connection factory to use -for the `listenerConnectionFactory` and `templateConnectionFactory`, if -neither is specified. - -|`defaultTaskExecutorType` |(see description) |*Camel 2.10.4:* Specifies -what default TaskExecutor type to use in the -DefaultMessageListenerContainer, for both consumer endpoints and the -ReplyTo consumer of producer endpoints. Possible values: `SimpleAsync` -(uses Spring's -http://static.springsource.org/spring/docs/current/javadoc-api/org/springframework/core/task/SimpleAsyncTaskExecutor.html[SimpleAsyncTaskExecutor]) -or `ThreadPool` (uses Spring's -http://static.springsource.org/spring/docs/current/javadoc-api/org/springframework/scheduling/concurrent/ThreadPoolTaskExecutor.html[ThreadPoolTaskExecutor] -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 `ThreadPool` -is recommended to reduce "thread trash" in elastic configurations with -dynamically increasing and decreasing concurrent consumers. - -|`deliveryMode` |null |*Camel 2.12.2/2.13:* Specifies the delivery mode -to be used. Possibles values are those defined by -`javax.jms.DeliveryMode`. - -|`deliveryPersistent` |`true` |Specifies whether persistent delivery is -used by default. - -|`destination` |`null` |Specifies the JMS Destination object to use on -this endpoint. - -|`destinationName` |`null` |Specifies the JMS destination name to use on -this endpoint. - -|`destinationResolver` |`null` |A pluggable -`org.springframework.jms.support.destination.DestinationResolver` that -allows you to use your own resolver (for example, to lookup the real -destination in a JNDI registry). - -|`disableTimeToLive` |`false` |*Camel 2.8:* 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 `requestTimeout` 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 -`disableTimeToLive=true` to *not* set a time to live value on the sent -message. Then the message will not expire on the receiver system. See -below in section _About time to live_ for more details. - -|`eagerLoadingOfProperties` |`false` |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. - -|`exceptionListener` |`null` |Specifies the JMS Exception Listener that -is to be notified of any underlying JMS exceptions. - -|`errorHandler` |`null` |*Camel 2.8.2, 2.9:* Specifies a -`org.springframework.util.ErrorHandler` to be invoked in case of any -uncaught exceptions thrown while processing a `Message`. By default -these exceptions will be logged at the WARN level, if no `errorHandler` -has been configured. From *Camel 2.9.1:* 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 `errorHandler`. - -|`errorHandlerLoggingLevel` |`WARN` |*Camel 2.9.1:* Allows to configure -the default `errorHandler` logging level for logging uncaught -exceptions. - -|`errorHandlerLogStackTrace` |`true` |*Camel 2.9.1:* Allows to control -whether stacktraces should be logged or not, by the default -`errorHandler`. - -|`explicitQosEnabled` |`false` |Set if the `deliveryMode`, `priority` or -`timeToLive` qualities of service should be used when sending messages. -This option is based on Spring's `JmsTemplate`. The `deliveryMode`, -`priority` and `timeToLive` options are applied to the current endpoint. -This contrasts with the `preserveMessageQos` option, which operates at -message granularity, reading QoS properties exclusively from the Camel -In message headers. - -|`exposeListenerSession` |`true` |Specifies whether the listener session -should be exposed when consuming messages. - -|`forceSendOriginalMessage` |`false` |*Camel 2.7:* When using -`mapJmsMessage=false` 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 `true` to force Camel to send the original JMS -message that was received. - -|`idleTaskExecutionLimit` |`1` |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 -`maxConcurrentConsumers` setting). There is additional doc available -from -http://static.springsource.org/spring/docs/3.0.5.RELEASE/api/org/springframework/jms/listener/DefaultMessageListenerContainer.html#setIdleTaskExecutionLimit(int)[Spring]. - -|`idleConsumerLimit` |`1` |*Camel 2.8.2, 2.9:* Specify the limit for the -number of consumers that are allowed to be idle at any given time. - -|`includeSentJMSMessageID` |`false` |*Camel 2.10.3:* Only applicable -when sending to JMS destination using InOnly (eg fire and forget). -Enabling this option will enrich the Camel link:exchange.html[Exchange] -with the actual JMSMessageID that was used by the JMS client when the -message was sent to the JMS destination. - -|`includeAllJMSXProperties` |`false` |*Camel 2.11.2/2.12:* Whether to -include all JMSXxxx properties when mapping from JMS to Camel Message. -Setting this to `true` will include properties such as `JMSXAppID`, and -`JMSXUserID` etc. *Note:* If you are using a custom -`headerFilterStrategy` then this option does not apply. - -|`jmsMessageType` |`null` |Allows you to force the use of a specific -`javax.jms.Message` implementation for sending JMS messages. Possible -values are: `Bytes`, `Map`, `Object`, `Stream`, `Text`. By default, -Camel would determine which JMS message type to use from the In body -type. This option allows you to specify it. - -|`jmsKeyFormatStrategy` |`default` |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: `default` and -`passthrough`. The `default` strategy will safely marshal dots and -hyphens (`.` and `-`). The `passthrough` 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 `org.apache.camel.component.jms.JmsKeyFormatStrategy` and refer to -it using the `#` notation. - -|`jmsOperations` |`null` |Allows you to use your own implementation of -the `org.springframework.jms.core.JmsOperations` interface. Camel uses -`JmsTemplate` as default. Can be used for testing purpose, but not used -much as stated in the spring API docs. - -|`lazyCreateTransactionManager` |`true` |If `true`, Camel will create a -`JmsTransactionManager`, if there is no `transactionManager` injected -when option `transacted=true`. - -|`listenerConnectionFactory` |`null` |The JMS connection factory used -for consuming messages. - -|`mapJmsMessage` |`true` |Specifies whether Camel should auto map the -received JMS message to an appropiate payload type, such as -`javax.jms.TextMessage` to a `String` etc. See section about how mapping -works below for more details. - -|`maximumBrowseSize` |`-1` |Limits the number of messages fetched at -most, when browsing endpoints using link:browse.html[Browse] or JMX API. - -|`messageConverter` |`null` |To use a custom Spring -`org.springframework.jms.support.converter.MessageConverter` so you can -be 100% in control how to map to/from a `javax.jms.Message`. - -|`messageIdEnabled` |`true` |When sending, specifies whether message IDs -should be added. - -|`messageListenerContainerFactoryRef` |`null` |*Camel 2.10.2:* Registry -ID of the `MessageListenerContainerFactory` used to determine what -`org.springframework.jms.listener.AbstractMessageListenerContainer` to -use to consume messages. Setting this will automatically set -`consumerType` to `Custom`. - -|`messageTimestampEnabled` |`true` |Specifies whether timestamps should -be enabled by default on sending messages. - -|`password` |`null` |The password for the connector factory. - -|`priority` |`4` |Values greater than 1 specify the message priority -when sending (where 0 is the lowest priority and 9 is the highest). The -`explicitQosEnabled` option *must* also be enabled in order for this -option to have any effect. - -|`pubSubNoLocal` |`false` |Specifies whether to inhibit the delivery of -messages published by its own connection. - -|`receiveTimeout` |1000 |The timeout for receiving messages (in -milliseconds). - -|`recoveryInterval` |`5000` |Specifies the interval between recovery -attempts, i.e. when a connection is being refreshed, in milliseconds. -The default is 5000 ms, that is, 5 seconds. - -|`replyToSameDestinationAllowed` |`false` |*Camel 2.16:* **Consumer -only:**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. - -|`replyToCacheLevelName` |CACHE_CONSUMER |*Camel 2.9.1:* 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: `CACHE_CONSUMER` for exclusive or shared w/ -`replyToSelectorName`. And `CACHE_SESSION` for shared without -`replyToSelectorName`. Some JMS brokers such as IBM WebSphere may -require to set the `replyToCacheLevelName=CACHE_NONE` to work. *Note:* -If using temporary queues then `CACHE_NONE` is not allowed, and you must -use a higher value such as `CACHE_CONSUMER` or `CACHE_SESSION`. - -|`replyToDestinationSelectorName` |`null` |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). - -|`replyToDeliveryPersistent` |`true` |Specifies whether to use -persistent delivery by default for replies. - -|`requestTimeoutCheckerInterval` |`1000` |*Camel 2.9.2:* Configures how -often Camel should check for timed out link:exchange.html[Exchange]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 __requestTimeout__. - -|`subscriptionDurable` |`false` |*@deprecated:* Enabled by default, if -you specify a `durableSubscriptionName` and a `clientId`. - -|`taskExecutor` |`null` |Allows you to specify a custom task executor -for consuming messages. - -|`taskExecutorSpring2` |`null` |*Camel 2.6:* To use when using Spring -2.x with Camel. Allows you to specify a custom task executor for -consuming messages. - -|`templateConnectionFactory` |`null` |The JMS connection factory used -for sending messages. - -|`transactedInOut` |`false` |*@deprecated:* Specifies whether to use -transacted mode for sending messages using the InOut -link:exchange-pattern.html[Exchange Pattern]. Applies only to producer -endpoints. See section link:jms.html[Enabling Transacted Consumption] -for more details. - -|`transactionManager` |`null` |The Spring transaction manager to use. - -|`transactionName` |`"JmsConsumer [destinationName]"` |The name of the -transaction to use. - -|`transactionTimeout` |`null` |The timeout value of the transaction (in -seconds), if using transacted mode. - -|`transferException` |`false` |If enabled and you are using -link:request-reply.html[Request Reply] messaging (InOut) and an -link:exchange.html[Exchange] failed on the consumer side, then the -caused `Exception` will be send back in response as a -`javax.jms.ObjectMessage`. If the client is Camel, the returned -`Exception` is rethrown. This allows you to use Camel link:jms.html[JMS] -as a bridge in your routing - for example, using persistent queues to -enable robust routing. Notice that if you also have *transferExchange* -enabled, this option takes precedence. The caught exception is required -to be serializable. The original `Exception` on the consumer side can be -wrapped in an outer exception such as -`org.apache.camel.RuntimeCamelException` when returned to the producer. - -|`transferFault` |`false` |*Camel 2.17:* If enabled and you are using -Request Reply messaging (InOut) and an Exchange failed with a SOAP fault -(not exception) on the consumer side, then the fault flag on -org.apache.camel.Message.isFault() will be send back in the response as -a JMS header with the key JmsConstants.JMS_TRANSFER_FAULT. If the client -is Camel, the returned fault flag will be set on the -org.apache.camel.Message.setFault(boolean). You may want to enable this -when using Camel components that support faults such as SOAP based such -as cxf or spring-ws. - -|`transferExchange` |`false` |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. - -|`username` |`null` |The username for the connector factory. - -|`useMessageIDAsCorrelationID` |`false` |Specifies whether -`JMSMessageID` should always be used as `JMSCorrelationID` for *InOut* -messages. - -|`useVersion102` |`false` |*@deprecated (removed from Camel 2.5 -onwards):* Specifies whether the old JMS API should be used. +| Name | Group | Default | Java Type | Description +| destinationType | common | queue | String | The kind of destination to use +| destinationName | common | | String | *Required* Name of the queue or topic to use as destination +| clientId | common | | String | 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. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. +| disableReplyTo | common | false | boolean | If true a producer will behave like a InOnly exchange with the exception that JMSReplyTo header is sent out and not be suppressed like in the case of InOnly. Like InOnly the producer will not wait for a reply. A consumer with this flag will behave like InOnly. This feature can be used to bridge InOut requests to another queue so that a route on the other queue will send its response directly back to the original JMSReplyTo. +| durableSubscriptionName | common | | String | The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. +| jmsMessageType | common | | JmsMessageType | Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes Map Object Stream Text. By default Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. +| testConnectionOnStartup | common | false | boolean | 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. The JMS producers is tested as well. +| acknowledgementModeName | consumer | AUTO_ACKNOWLEDGE | String | The JMS acknowledgement name which is one of: SESSION_TRANSACTED CLIENT_ACKNOWLEDGE AUTO_ACKNOWLEDGE DUPS_OK_ACKNOWLEDGE +| asyncConsumer | consumer | false | boolean | Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100 strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled then asyncConsumer=true does not run asynchronously as transaction must be executed synchronously (Camel 3.0 may support async transactions). +| autoStartup | consumer | true | boolean | Specifies whether the consumer container should auto-startup. +| bridgeErrorHandler | consumer | false | boolean | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN/ERROR level and ignored. +| cacheLevelName | consumer | CACHE_AUTO | String | Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO CACHE_CONNECTION CACHE_CONSUMER CACHE_NONE and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. +| concurrentConsumers | consumer | 1 | int | Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. +| maxConcurrentConsumers | consumer | | int | Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. +| replyTo | consumer | | String | Provides an explicit ReplyTo destination which overrides any incoming value of Message.getJMSReplyTo(). +| replyToDeliveryPersistent | consumer | true | boolean | Specifies whether to use persistent delivery by default for replies. +| selector | consumer | | String | Sets the JMS selector to use +| acceptMessagesWhileStopping | consumer (advanced) | false | boolean | Specifies whether the consumer accept messages while it is stopping. You may consider enabling this option if you start and stop JMS routes at runtime while there are still messages enqued on the queue. If this option is false and you stop the JMS 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. +| consumerType | consumer (advanced) | Default | ConsumerType | The consumer type to use which can be one of: Simple Default or Custom. The consumer type determines which Spring JMS listener to use. Default will use org.springframework.jms.listener.DefaultMessageListenerContainer Simple will use org.springframework.jms.listener.SimpleMessageListenerContainer. When Custom is specified the MessageListenerContainerFactory defined by the messageListenerContainerFactory option will determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use. +| defaultTaskExecutorType | consumer (advanced) | | DefaultTaskExecutorType | Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer for both consumer endpoints and the ReplyTo consumer of producer endpoints. Possible values: SimpleAsync (uses Spring's SimpleAsyncTaskExecutor) or ThreadPool (uses Spring's ThreadPoolTaskExecutor 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 ThreadPool is recommended to reduce thread trash in elastic configurations with dynamically increasing and decreasing concurrent consumers. +| eagerLoadingOfProperties | consumer (advanced) | false | boolean | Enables eager loading of JMS properties as soon as a message is loaded which generally is inefficient as the JMS properties may not be required but sometimes can catch early any issues with the underlying JMS provider and the use of JMS properties +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exposeListenerSession | consumer (advanced) | false | boolean | Specifies whether the listener session should be exposed when consuming messages. +| replyToSameDestinationAllowed | consumer (advanced) | false | boolean | 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. +| deliveryMode | producer | | Integer | Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. +| deliveryPersistent | producer | true | boolean | Specifies whether persistent delivery is used by default. +| explicitQosEnabled | producer | false | Boolean | Set if the deliveryMode priority or timeToLive qualities of service should be used when sending messages. This option is based on Spring's JmsTemplate. The deliveryMode priority and timeToLive options are applied to the current endpoint. This contrasts with the preserveMessageQos option which operates at message granularity reading QoS properties exclusively from the Camel In message headers. +| preserveMessageQos | producer | false | boolean | Set to true 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 JMSPriority JMSDeliveryMode and JMSExpiration. 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 explicitQosEnabled option by contrast will only use options set on the endpoint and not values from the message header. +| priority | producer | 4 | int | Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest). The explicitQosEnabled option must also be enabled in order for this option to have any effect. +| replyToConcurrentConsumers | producer | 1 | int | Specifies the default number of concurrent consumers when doing request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. +| replyToMaxConcurrentConsumers | producer | | int | Specifies the maximum number of concurrent consumers when using request/reply over JMS. See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. +| replyToOverride | producer | | String | Provides an explicit ReplyTo destination in the JMS message which overrides the setting of replyTo. It is useful if you want to forward the message to a remote Queue and receive the reply message from the ReplyTo destination. +| replyToType | producer | | ReplyToType | Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS. Possible values are: Temporary Shared or Exclusive. By default Camel will use temporary queues. However if replyTo has been configured then Shared is used by default. This option allows you to use exclusive queues instead of shared ones. See Camel JMS documentation for more details and especially the notes about the implications if running in a clustered environment and the fact that Shared reply queues has lower performance than its alternatives Temporary and Exclusive. +| requestTimeout | producer | 20000 | long | The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The default is 20 seconds. You can include the header CamelJmsRequestTimeout to override this endpoint configured timeout value and thus have per message individual timeout values. See also the requestTimeoutCheckerInterval option. +| timeToLive | producer | -1 | long | When sending messages specifies the time-to-live of the message (in milliseconds). +| allowNullBody | producer (advanced) | true | boolean | Whether to allow sending messages with no body. If this option is false and the message body is null then an JMSException is thrown. +| alwaysCopyMessage | producer (advanced) | false | boolean | If true 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 replyToDestinationSelectorName is set (incidentally Camel will set the alwaysCopyMessage option to true if a replyToDestinationSelectorName is set) +| disableTimeToLive | producer (advanced) | false | boolean | 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 requestTimeout 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 disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details. +| forceSendOriginalMessage | producer (advanced) | false | boolean | When using mapJmsMessage=false 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 true to force Camel to send the original JMS message that was received. +| includeSentJMSMessageID | producer (advanced) | false | boolean | Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination. +| replyToCacheLevelName | producer (advanced) | | String | 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: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. +| replyToDestinationSelectorName | producer (advanced) | | String | 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). +| asyncStartListener | advanced | false | boolean | Whether to startup the JmsConsumer message listener asynchronously when starting a route. For example if a JmsConsumer 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 true you will let routes startup while the JmsConsumer 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 WARN level and the consumer will not be able to receive messages; You can then restart the route to retry. +| asyncStopListener | advanced | false | boolean | Whether to stop the JmsConsumer message listener asynchronously when stopping a route. +| errorHandler | advanced | | ErrorHandler | Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure than having to code a custom errorHandler. +| errorHandlerLoggingLevel | advanced | WARN | LoggingLevel | Allows to configure the default errorHandler logging level for logging uncaught exceptions. +| errorHandlerLogStackTrace | advanced | true | boolean | Allows to control whether stacktraces should be logged or not by the default errorHandler. +| exceptionListener | advanced | | ExceptionListener | Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| headerFilterStrategy | advanced | | HeaderFilterStrategy | To use a custom HeaderFilterStrategy to filter header to and from Camel message. +| idleConsumerLimit | advanced | 1 | int | Specify the limit for the number of consumers that are allowed to be idle at any given time. +| idleTaskExecutionLimit | advanced | 1 | int | 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 maxConcurrentConsumers setting). There is additional doc available from Spring. +| includeAllJMSXProperties | advanced | false | boolean | Whether to include all JMSXxxx properties when mapping from JMS to Camel Message. Setting this to true will include properties such as JMSXAppID and JMSXUserID etc. Note: If you are using a custom headerFilterStrategy then this option does not apply. +| jmsKeyFormatStrategy | advanced | | String | 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: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough 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 org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the notation. +| mapJmsMessage | advanced | true | boolean | Specifies whether Camel should auto map the received JMS message to a suited payload type such as javax.jms.TextMessage to a String etc. +| maxMessagesPerTask | advanced | -1 | int | 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 100 to control how fast the consumers will shrink when less work is required. +| messageConverter | advanced | | MessageConverter | To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message. +| messageCreatedStrategy | advanced | | MessageCreatedStrategy | To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. +| messageIdEnabled | advanced | true | boolean | When sending specifies whether message IDs should be added. +| messageListenerContainerFactory | advanced | | MessageListenerContainerFactory | Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom. +| messageTimestampEnabled | advanced | true | boolean | Specifies whether timestamps should be enabled by default on sending messages. +| pubSubNoLocal | advanced | false | boolean | Specifies whether to inhibit the delivery of messages published by its own connection. +| receiveTimeout | advanced | 1000 | long | The timeout for receiving messages (in milliseconds). +| recoveryInterval | advanced | 5000 | long | Specifies the interval between recovery attempts i.e. when a connection is being refreshed in milliseconds. The default is 5000 ms that is 5 seconds. +| requestTimeoutCheckerInterval | advanced | 1000 | long | Configures how often Camel should check for timed out Exchanges 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 requestTimeout. +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +| transferException | advanced | false | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed on the consumer side then the caused Exception will be send back in response as a javax.jms.ObjectMessage. If the client is Camel the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. +| transferExchange | advanced | false | boolean | 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. +| transferFault | advanced | false | boolean | If enabled and you are using Request Reply messaging (InOut) and an Exchange failed with a SOAP fault (not exception) on the consumer side then the fault flag on link org.apache.camel.MessageisFault() will be send back in the response as a JMS header with the key link JmsConstantsJMS_TRANSFER_FAULT. If the client is Camel the returned fault flag will be set on the link org.apache.camel.MessagesetFault(boolean). You may want to enable this when using Camel components that support faults such as SOAP based such as cxf or spring-ws. +| useMessageIDAsCorrelationID | advanced | false | boolean | Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. +| transacted | transaction | false | boolean | Specifies whether to use transacted mode +| lazyCreateTransactionManager | transaction (advanced) | true | boolean | If true Camel will create a JmsTransactionManager if there is no transactionManager injected when option transacted=true. +| transactionManager | transaction (advanced) | | PlatformTransactionManager | The Spring transaction manager to use. +| transactionName | transaction (advanced) | | String | The name of the transaction to use. +| transactionTimeout | transaction (advanced) | -1 | int | The timeout value of the transaction (in seconds) if using transacted mode. |======================================================================= +// endpoint options: END + [[JMS-MessageMappingbetweenJMSandCamel]] Message Mapping between JMS and Camel @@ -761,7 +446,7 @@ sending a message to the JMS order queue: [source,java] ---------------------------------------------------------------------------------------- - from("file://inbox/order").to("jms:queue:order?messageConverter=#myMessageConverter"); +from("file://inbox/order").to("jms:queue:order?messageConverter=#myMessageConverter"); ---------------------------------------------------------------------------------------- You can also use a custom message converter when consuming from a JMS @@ -771,23 +456,24 @@ destination. Controlling the mapping strategy selected +++++++++++++++++++++++++++++++++++++++++ -You can use the *jmsMessageType* option on the endpoint URL to force a -specific message type for all messages. + - In the route below, we poll files from a folder and send them as +You can use the `jmsMessageType` option on the endpoint URL to force a +specific message type for all messages. + +In the route below, we poll files from a folder and send them as `javax.jms.TextMessage` as we have forced the JMS producer endpoint to use text messages: [source,java] ----------------------------------------------------------------------- - from("file://inbox/order").to("jms:queue:order?jmsMessageType=Text"); +from("file://inbox/order").to("jms:queue:order?jmsMessageType=Text"); ----------------------------------------------------------------------- -You can also specify the message type to use for each messabe by setting +You can also specify the message type to use for each message by setting the header with the key `CamelJmsMessageType`. For example: [source,java] --------------------------------------------------------------------------------------------------------- - from("file://inbox/order").setHeader("CamelJmsMessageType", JmsMessageType.Text).to("jms:queue:order"); +from("file://inbox/order").setHeader("CamelJmsMessageType", JmsMessageType.Text).to("jms:queue:order"); --------------------------------------------------------------------------------------------------------- The possible values are defined in the `enum` class, @@ -1516,9 +1202,9 @@ from("jms:topic:OrdersTopic"). to("jms:queue:BigSpendersQueue"); ---------------------------------------------- -[[JMS-SendingtoaJMS]] -Sending to a JMS -++++++++++++++++ +[[JMS-SendingtoJMS]] +Sending to JMS +++++++++++++++ In the sample below we poll a file folder and send the file content to a JMS topic. As we want the content of the file as a `TextMessage` instead @@ -1575,7 +1261,7 @@ transfers the body and headers as the payload. If you want to use link:jms.html[JMS] with a link:dead-letter-channel.html[Dead Letter Channel], using a JMS queue as the Dead Letter Queue, then normally the caused Exception is not stored in the JMS message. You can, however, use -the *transferExchange* option on the JMS dead letter queue to instruct +the `transferExchange` option on the JMS dead letter queue to instruct Camel to store the entire link:exchange.html[Exchange] in the queue as a `javax.jms.ObjectMessage` that holds a `org.apache.camel.impl.DefaultExchangeHolder`. This allows you to @@ -1631,13 +1317,13 @@ Sending an InOnly message and keeping the JMSReplyTo header ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ When sending to a link:jms.html[JMS] destination using *camel-jms* the -producer will use the MEP to detect if its InOnly or InOut messaging. -However there can be times where you want to send an InOnly message but -keeping the JMSReplyTo header. To do so you have to instruct Camel to -keep it, otherwise the JMSReplyTo header will be dropped. +producer will use the MEP to detect if its _InOnly_ or _InOut_ messaging. +However there can be times where you want to send an _InOnly_ message but +keeping the `JMSReplyTo` header. To do so you have to instruct Camel to +keep it, otherwise the `JMSReplyTo` header will be dropped. -For example to send an InOnly message to the foo queue, but with a -JMSReplyTo with bar queue you can do as follows: +For example to send an _InOnly_ message to the foo queue, but with a +`JMSReplyTo` with bar queue you can do as follows: [source,java] ------------------------------------------------------------------------------------- @@ -1650,7 +1336,7 @@ JMSReplyTo with bar queue you can do as follows: ------------------------------------------------------------------------------------- Notice we use `preserveMessageQos=true` to instruct Camel to keep the -JMSReplyTo header. +`JMSReplyTo` header. [[JMS-SettingJMSprovideroptionsonthedestination]] Setting JMS provider options on the destination @@ -1658,13 +1344,13 @@ Setting JMS provider options on the destination Some JMS providers, like IBM's WebSphere MQ need options to be set on the JMS destination. For example, you may need to specify the -targetClient option. Since targetClient is a WebSphere MQ option and not +`targetClient` option. Since `targetClient` is a WebSphere MQ option and not a Camel URI option, you need to set that on the JMS destination name like so: [source,java] ----------------------------------------------------------------------------------- -... +// ... .setHeader("CamelJmsDestinationName", constant("queue:///MY_QUEUE?targetClient=1")) .to("wmq:queue:MY_QUEUE?useMessageIDAsCorrelationID=true"); ----------------------------------------------------------------------------------- @@ -1672,11 +1358,12 @@ like so: Some versions of WMQ won't accept this option on the destination name and you will get an exception like: -________________________________________________________________________________________________________________________________________________ +[source] +---------------------------------------------------------------------------------------------------------------------------------- com.ibm.msg.client.jms.DetailedJMSException: JMSCC0005: The specified value 'MY_QUEUE?targetClient=1' is not allowed for 'XMSC_DESTINATION_NAME' -________________________________________________________________________________________________________________________________________________ +---------------------------------------------------------------------------------------------------------------------------------- A workaround is to use a custom DestinationResolver: @@ -1684,7 +1371,7 @@ A workaround is to use a custom DestinationResolver: ---------------------------------------------------------------------------------------------------------------------------------- JmsComponent wmq = new JmsComponent(connectionFactory); -wmq.setDestinationResolver(new DestinationResolver(){ +wmq.setDestinationResolver(new DestinationResolver() { public Destination resolveDestinationName(Session session, String destinationName, boolean pubSubDomain) throws JMSException { MQQueueSession wmqSession = (MQQueueSession) session; return wmqSession.createQueue("queue:///" + destinationName + "?targetClient=1");
