JmsComponentBuilderFactory.JmsComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.jms.JmsComponent>

All Known Implementing Classes:

JmsComponentBuilderFactory.JmsComponentBuilderImpl

Enclosing interface:

JmsComponentBuilderFactory
```
public static interface JmsComponentBuilderFactory.JmsComponentBuilder
extends ComponentBuilder<org.apache.camel.component.jms.JmsComponent>
```
Builder for the JMS component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`acceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)` Specifies whether the consumer accept messages while it is stopping.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`acknowledgementModeName(String acknowledgementModeName)` The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`allowAdditionalHeaders(String allowAdditionalHeaders)` This option is used to allow additional headers which may have values that are invalid according to JMS specification.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`allowAutoWiredConnectionFactory(boolean allowAutoWiredConnectionFactory)` Whether to auto-discover ConnectionFactory from the registry, if no connection factory has been configured.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`allowAutoWiredDestinationResolver(boolean allowAutoWiredDestinationResolver)` Whether to auto-discover DestinationResolver from the registry, if no destination resolver has been configured.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`allowNullBody(boolean allowNullBody)` Whether to allow sending messages with no body.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`allowReplyManagerQuickStop(boolean allowReplyManagerQuickStop)` Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`allowSerializedHeaders(boolean allowSerializedHeaders)` Controls whether or not to include serialized headers.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`alwaysCopyMessage(boolean alwaysCopyMessage)` If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`artemisStreamingEnabled(boolean artemisStreamingEnabled)` Whether optimizing for Apache Artemis streaming mode.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`asyncConsumer(boolean asyncConsumer)` Whether the JmsConsumer processes the Exchange asynchronously.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`asyncStartListener(boolean asyncStartListener)` Whether to startup the JmsConsumer message listener asynchronously, when starting a route.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`asyncStopListener(boolean asyncStopListener)` Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`autoStartup(boolean autoStartup)` Specifies whether the consumer container should auto-startup.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`cacheLevel(int cacheLevel)` Sets the cache level by ID for the underlying JMS resources.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`cacheLevelName(String cacheLevelName)` Sets the cache level by name for the underlying JMS resources.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`clientId(String clientId)` Sets the JMS client ID to use.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`concurrentConsumers(int concurrentConsumers)` Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`configuration(org.apache.camel.component.jms.JmsConfiguration configuration)` To use a shared JMS configuration.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`connectionFactory(javax.jms.ConnectionFactory connectionFactory)` The connection factory to be use.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`consumerType(org.apache.camel.component.jms.ConsumerType consumerType)` The consumer type to use, which can be one of: Simple, Default, or Custom.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`correlationProperty(String correlationProperty)` When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`defaultTaskExecutorType(org.apache.camel.component.jms.DefaultTaskExecutorType defaultTaskExecutorType)` Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`deliveryDelay(long deliveryDelay)` Sets delivery delay to use for send calls for JMS.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`deliveryMode(Integer deliveryMode)` Specifies the delivery mode to be used.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`deliveryPersistent(boolean deliveryPersistent)` Specifies whether persistent delivery is used by default.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`destinationResolver(org.springframework.jms.support.destination.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).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`disableReplyTo(boolean disableReplyTo)` Specifies whether Camel ignores the JMSReplyTo header in messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`disableTimeToLive(boolean disableTimeToLive)` Use this option to force disabling time to live.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`durableSubscriptionName(String durableSubscriptionName)` The durable subscriber name for specifying durable topic subscriptions.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`eagerLoadingOfProperties(boolean eagerLoadingOfProperties)` Enables eager loading of JMS properties and payload 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.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`eagerPoisonBody(String eagerPoisonBody)` If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`errorHandler(org.springframework.util.ErrorHandler errorHandler)` Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`errorHandlerLoggingLevel(org.apache.camel.LoggingLevel errorHandlerLoggingLevel)` Allows to configure the default errorHandler logging level for logging uncaught exceptions.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`errorHandlerLogStackTrace(boolean errorHandlerLogStackTrace)` Allows to control whether stacktraces should be logged or not, by the default errorHandler.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`exceptionListener(javax.jms.ExceptionListener exceptionListener)` Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`explicitQosEnabled(Boolean explicitQosEnabled)` Set if the deliveryMode, priority or timeToLive qualities of service should be used when sending messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`exposeListenerSession(boolean exposeListenerSession)` Specifies whether the listener session should be exposed when consuming messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`forceSendOriginalMessage(boolean forceSendOriginalMessage)` 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.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`formatDateHeadersToIso8601(boolean formatDateHeadersToIso8601)` Sets whether JMS date properties should be formatted according to the ISO 8601 standard.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)` To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`idleConsumerLimit(int idleConsumerLimit)` Specify the limit for the number of consumers that are allowed to be idle at any given time.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`idleTaskExecutionLimit(int idleTaskExecutionLimit)` Specifies the limit for idle executions of a receive task, not having received any message within its execution.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`includeAllJMSXProperties(boolean includeAllJMSXProperties)` Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`includeSentJMSMessageID(boolean includeSentJMSMessageID)` Only applicable when sending to JMS destination using InOnly (eg fire and forget).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`jmsKeyFormatStrategy(org.apache.camel.component.jms.JmsKeyFormatStrategy jmsKeyFormatStrategy)` Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`jmsMessageType(org.apache.camel.component.jms.JmsMessageType jmsMessageType)` Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`lazyCreateTransactionManager(boolean lazyCreateTransactionManager)` If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`lazyStartProducer(boolean lazyStartProducer)` Whether the producer should be started lazy (on the first message).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`mapJmsMessage(boolean mapJmsMessage)` Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`maxConcurrentConsumers(int maxConcurrentConsumers)` Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`maxMessagesPerTask(int maxMessagesPerTask)` The number of messages per task.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`messageConverter(org.springframework.jms.support.converter.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.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`messageCreatedStrategy(org.apache.camel.component.jms.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.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`messageIdEnabled(boolean messageIdEnabled)` When sending, specifies whether message IDs should be added.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`messageListenerContainerFactory(org.apache.camel.component.jms.MessageListenerContainerFactory messageListenerContainerFactory)` Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`messageTimestampEnabled(boolean messageTimestampEnabled)` Specifies whether timestamps should be enabled by default on sending messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`password(String password)` Password to use with the ConnectionFactory.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`preserveMessageQos(boolean preserveMessageQos)` 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.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`priority(int priority)` Values greater than 1 specify the message priority when sending (where 0 is the lowest priority and 9 is the highest).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`pubSubNoLocal(boolean pubSubNoLocal)` Specifies whether to inhibit the delivery of messages published by its own connection.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`queueBrowseStrategy(org.apache.camel.component.jms.QueueBrowseStrategy queueBrowseStrategy)` To use a custom QueueBrowseStrategy when browsing queues.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`receiveTimeout(long receiveTimeout)` The timeout for receiving messages (in milliseconds).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`recoveryInterval(long recoveryInterval)` Specifies the interval between recovery attempts, i.e.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyTo(String replyTo)` Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo().
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToCacheLevelName(String replyToCacheLevelName)` Sets the cache level by name for the reply consumer when doing request/reply over JMS.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToConcurrentConsumers(int replyToConcurrentConsumers)` Specifies the default number of concurrent consumers when doing request/reply over JMS.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToDeliveryPersistent(boolean replyToDeliveryPersistent)` Specifies whether to use persistent delivery by default for replies.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToDestinationSelectorName(String replyToDestinationSelectorName)` 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).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToMaxConcurrentConsumers(int replyToMaxConcurrentConsumers)` Specifies the maximum number of concurrent consumers when using request/reply over JMS.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToOnTimeoutMaxConcurrentConsumers(int replyToOnTimeoutMaxConcurrentConsumers)` Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToOverride(String replyToOverride)` Provides an explicit ReplyTo destination in the JMS message, which overrides the setting of replyTo.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToSameDestinationAllowed(boolean replyToSameDestinationAllowed)` Whether a JMS consumer is allowed to send a reply message to the same destination that the consumer is using to consume from.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`replyToType(org.apache.camel.component.jms.ReplyToType replyToType)` Allows for explicitly specifying which kind of strategy to use for replyTo queues when doing request/reply over JMS.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`requestTimeout(long requestTimeout)` The timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval)` Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`selector(String selector)` Sets the JMS selector to use.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`streamMessageTypeEnabled(boolean streamMessageTypeEnabled)` Sets whether StreamMessage type is enabled or not.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`subscriptionDurable(boolean subscriptionDurable)` Set whether to make the subscription durable.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`subscriptionName(String subscriptionName)` Set the name of a subscription to create.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`subscriptionShared(boolean subscriptionShared)` Set whether to make the subscription shared.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`taskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)` Allows you to specify a custom task executor for consuming messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`testConnectionOnStartup(boolean testConnectionOnStartup)` Specifies whether to test the connection on startup.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`timeToLive(long timeToLive)` When sending messages, specifies the time-to-live of the message (in milliseconds).
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`transacted(boolean transacted)` Specifies whether to use transacted mode.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)` The Spring transaction manager to use.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`transactionName(String transactionName)` The name of the transaction to use.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`transactionTimeout(int transactionTimeout)` The timeout value of the transaction (in seconds), if using transacted mode.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`transferException(boolean transferException)` 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.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`transferExchange(boolean transferExchange)` You can transfer the exchange over the wire instead of just the body and headers.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`useMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)` Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`username(String username)` Username to use with the ConnectionFactory.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`waitForProvisionCorrelationToBeUpdatedCounter(int waitForProvisionCorrelationToBeUpdatedCounter)` Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled.
`default JmsComponentBuilderFactory.JmsComponentBuilder`	`waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)` Interval in millis to sleep each time while waiting for provisional correlation id to be updated.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - clientId
```
default JmsComponentBuilderFactory.JmsComponentBuilder clientId(String clientId)
```
    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. The option is a: java.lang.String type. Group: common
  - connectionFactory
```
default JmsComponentBuilderFactory.JmsComponentBuilder connectionFactory(javax.jms.ConnectionFactory connectionFactory)
```
    The connection factory to be use. A connection factory must be configured either on the component or endpoint. The option is a: javax.jms.ConnectionFactory type. Group: common
  - disableReplyTo
```
default JmsComponentBuilderFactory.JmsComponentBuilder disableReplyTo(boolean disableReplyTo)
```
    Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. The option is a: boolean type. Default: false Group: common
  - durableSubscriptionName
```
default JmsComponentBuilderFactory.JmsComponentBuilder durableSubscriptionName(String durableSubscriptionName)
```
    The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. The option is a: java.lang.String type. Group: common
  - jmsMessageType
```
default JmsComponentBuilderFactory.JmsComponentBuilder jmsMessageType(org.apache.camel.component.jms.JmsMessageType 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. The option is a: org.apache.camel.component.jms.JmsMessageType type. Group: common
  - testConnectionOnStartup
```
default JmsComponentBuilderFactory.JmsComponentBuilder testConnectionOnStartup(boolean testConnectionOnStartup)
```
    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. The option is a: boolean type. Default: false Group: common
  - acknowledgementModeName
```
default JmsComponentBuilderFactory.JmsComponentBuilder acknowledgementModeName(String acknowledgementModeName)
```
    The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE. The option is a: java.lang.String type. Default: AUTO_ACKNOWLEDGE Group: consumer
  - asyncConsumer
```
default JmsComponentBuilderFactory.JmsComponentBuilder asyncConsumer(boolean asyncConsumer)
```
    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). The option is a: boolean type. Default: false Group: consumer
  - autoStartup
```
default JmsComponentBuilderFactory.JmsComponentBuilder autoStartup(boolean autoStartup)
```
    Specifies whether the consumer container should auto-startup. The option is a: boolean type. Default: true Group: consumer
  - cacheLevel
```
default JmsComponentBuilderFactory.JmsComponentBuilder cacheLevel(int cacheLevel)
```
    Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. The option is a: int type. Group: consumer
  - cacheLevelName
```
default JmsComponentBuilderFactory.JmsComponentBuilder cacheLevelName(String cacheLevelName)
```
    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. The option is a: java.lang.String type. Default: CACHE_AUTO Group: consumer
  - concurrentConsumers
```
default JmsComponentBuilderFactory.JmsComponentBuilder concurrentConsumers(int concurrentConsumers)
```
    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. The option is a: int type. Default: 1 Group: consumer
  - maxConcurrentConsumers
```
default JmsComponentBuilderFactory.JmsComponentBuilder maxConcurrentConsumers(int maxConcurrentConsumers)
```
    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. The option is a: int type. Group: consumer
  - replyTo
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyTo(String replyTo)
```
    Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo(). The option is a: java.lang.String type. Group: consumer
  - replyToDeliveryPersistent
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToDeliveryPersistent(boolean replyToDeliveryPersistent)
```
    Specifies whether to use persistent delivery by default for replies. The option is a: boolean type. Default: true Group: consumer
  - selector
```
default JmsComponentBuilderFactory.JmsComponentBuilder selector(String selector)
```
    Sets the JMS selector to use. The option is a: java.lang.String type. Group: consumer
  - subscriptionDurable
```
default JmsComponentBuilderFactory.JmsComponentBuilder subscriptionDurable(boolean subscriptionDurable)
```
    Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. The option is a: boolean type. Default: false Group: consumer
  - subscriptionName
```
default JmsComponentBuilderFactory.JmsComponentBuilder subscriptionName(String subscriptionName)
```
    Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0). The option is a: java.lang.String type. Group: consumer
  - subscriptionShared
```
default JmsComponentBuilderFactory.JmsComponentBuilder subscriptionShared(boolean subscriptionShared)
```
    Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. The option is a: boolean type. Default: false Group: consumer
  - acceptMessagesWhileStopping
```
default JmsComponentBuilderFactory.JmsComponentBuilder acceptMessagesWhileStopping(boolean acceptMessagesWhileStopping)
```
    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 enqueued 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. The option is a: boolean type. Default: false Group: consumer (advanced)
  - allowReplyManagerQuickStop
```
default JmsComponentBuilderFactory.JmsComponentBuilder allowReplyManagerQuickStop(boolean allowReplyManagerQuickStop)
```
    Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the DefaultMessageListenerContainer.runningAllowed flag to quick stop in case JmsConfiguration#isAcceptMessagesWhileStopping is enabled, and org.apache.camel.CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag. The option is a: boolean type. Default: false Group: consumer (advanced)
  - consumerType
```
default JmsComponentBuilderFactory.JmsComponentBuilder consumerType(org.apache.camel.component.jms.ConsumerType 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. The option is a: org.apache.camel.component.jms.ConsumerType type. Default: Default Group: consumer (advanced)
  - defaultTaskExecutorType
```
default JmsComponentBuilderFactory.JmsComponentBuilder defaultTaskExecutorType(org.apache.camel.component.jms.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. The option is a: org.apache.camel.component.jms.DefaultTaskExecutorType type. Group: consumer (advanced)
  - eagerLoadingOfProperties
```
default JmsComponentBuilderFactory.JmsComponentBuilder eagerLoadingOfProperties(boolean eagerLoadingOfProperties)
```
    Enables eager loading of JMS properties and payload 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. See also the option eagerPoisonBody. The option is a: boolean type. Default: false Group: consumer (advanced)
  - eagerPoisonBody
```
default JmsComponentBuilderFactory.JmsComponentBuilder eagerPoisonBody(String eagerPoisonBody)
```
    If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) is poison (cannot be read/mapped), then set this text as the message body instead so the message can be processed (the cause of the poison are already stored as exception on the Exchange). This can be turned off by setting eagerPoisonBody=false. See also the option eagerLoadingOfProperties. The option is a: java.lang.String type. Default: Poison JMS message due to ${exception.message} Group: consumer (advanced)
  - exposeListenerSession
```
default JmsComponentBuilderFactory.JmsComponentBuilder exposeListenerSession(boolean exposeListenerSession)
```
    Specifies whether the listener session should be exposed when consuming messages. The option is a: boolean type. Default: false Group: consumer (advanced)
  - replyToSameDestinationAllowed
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToSameDestinationAllowed(boolean replyToSameDestinationAllowed)
```
    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. The option is a: boolean type. Default: false Group: consumer (advanced)
  - taskExecutor
```
default JmsComponentBuilderFactory.JmsComponentBuilder taskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)
```
    Allows you to specify a custom task executor for consuming messages. The option is a: org.springframework.core.task.TaskExecutor type. Group: consumer (advanced)
  - deliveryDelay
```
default JmsComponentBuilderFactory.JmsComponentBuilder deliveryDelay(long deliveryDelay)
```
    Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker. The option is a: long type. Default: -1 Group: producer
  - deliveryMode
```
default JmsComponentBuilderFactory.JmsComponentBuilder deliveryMode(Integer deliveryMode)
```
    Specifies the delivery mode to be used. Possibles values are those defined by javax.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2. The option is a: java.lang.Integer type. Group: producer
  - deliveryPersistent
```
default JmsComponentBuilderFactory.JmsComponentBuilder deliveryPersistent(boolean deliveryPersistent)
```
    Specifies whether persistent delivery is used by default. The option is a: boolean type. Default: true Group: producer
  - explicitQosEnabled
```
default JmsComponentBuilderFactory.JmsComponentBuilder explicitQosEnabled(Boolean explicitQosEnabled)
```
    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. The option is a: java.lang.Boolean type. Default: false Group: producer
  - formatDateHeadersToIso8601
```
default JmsComponentBuilderFactory.JmsComponentBuilder formatDateHeadersToIso8601(boolean formatDateHeadersToIso8601)
```
    Sets whether JMS date properties should be formatted according to the ISO 8601 standard. The option is a: boolean type. Default: false Group: producer
  - lazyStartProducer
```
default JmsComponentBuilderFactory.JmsComponentBuilder lazyStartProducer(boolean lazyStartProducer)
```
    Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: boolean type. Default: false Group: producer
  - preserveMessageQos
```
default JmsComponentBuilderFactory.JmsComponentBuilder preserveMessageQos(boolean preserveMessageQos)
```
    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. The option is a: boolean type. Default: false Group: producer
  - priority
```
default JmsComponentBuilderFactory.JmsComponentBuilder priority(int priority)
```
    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. The option is a: int type. Default: 4 Group: producer
  - replyToConcurrentConsumers
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToConcurrentConsumers(int replyToConcurrentConsumers)
```
    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. The option is a: int type. Default: 1 Group: producer
  - replyToMaxConcurrentConsumers
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToMaxConcurrentConsumers(int replyToMaxConcurrentConsumers)
```
    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. The option is a: int type. Group: producer
  - replyToOnTimeoutMaxConcurrentConsumers
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToOnTimeoutMaxConcurrentConsumers(int replyToOnTimeoutMaxConcurrentConsumers)
```
    Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS. The option is a: int type. Default: 1 Group: producer
  - replyToOverride
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToOverride(String replyToOverride)
```
    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. The option is a: java.lang.String type. Group: producer
  - replyToType
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToType(org.apache.camel.component.jms.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. The option is a: org.apache.camel.component.jms.ReplyToType type. Group: producer
  - requestTimeout
```
default JmsComponentBuilderFactory.JmsComponentBuilder requestTimeout(long requestTimeout)
```
    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. The option is a: long type. Default: 20000 Group: producer
  - timeToLive
```
default JmsComponentBuilderFactory.JmsComponentBuilder timeToLive(long timeToLive)
```
    When sending messages, specifies the time-to-live of the message (in milliseconds). The option is a: long type. Default: -1 Group: producer
  - allowAdditionalHeaders
```
default JmsComponentBuilderFactory.JmsComponentBuilder allowAdditionalHeaders(String allowAdditionalHeaders)
```
    This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example some message systems such as WMQ do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching. The option is a: java.lang.String type. Group: producer (advanced)
  - allowNullBody
```
default JmsComponentBuilderFactory.JmsComponentBuilder allowNullBody(boolean allowNullBody)
```
    Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown. The option is a: boolean type. Default: true Group: producer (advanced)
  - alwaysCopyMessage
```
default JmsComponentBuilderFactory.JmsComponentBuilder alwaysCopyMessage(boolean alwaysCopyMessage)
```
    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). The option is a: boolean type. Default: false Group: producer (advanced)
  - correlationProperty
```
default JmsComponentBuilderFactory.JmsComponentBuilder correlationProperty(String correlationProperty)
```
    When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel. The option is a: java.lang.String type. Group: producer (advanced)
  - disableTimeToLive
```
default JmsComponentBuilderFactory.JmsComponentBuilder disableTimeToLive(boolean disableTimeToLive)
```
    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. The option is a: boolean type. Default: false Group: producer (advanced)
  - forceSendOriginalMessage
```
default JmsComponentBuilderFactory.JmsComponentBuilder forceSendOriginalMessage(boolean forceSendOriginalMessage)
```
    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. The option is a: boolean type. Default: false Group: producer (advanced)
  - includeSentJMSMessageID
```
default JmsComponentBuilderFactory.JmsComponentBuilder includeSentJMSMessageID(boolean includeSentJMSMessageID)
```
    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. The option is a: boolean type. Default: false Group: producer (advanced)
  - replyToCacheLevelName
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToCacheLevelName(String replyToCacheLevelName)
```
    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. The option is a: java.lang.String type. Group: producer (advanced)
  - replyToDestinationSelectorName
```
default JmsComponentBuilderFactory.JmsComponentBuilder replyToDestinationSelectorName(String replyToDestinationSelectorName)
```
    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). The option is a: java.lang.String type. Group: producer (advanced)
  - streamMessageTypeEnabled
```
default JmsComponentBuilderFactory.JmsComponentBuilder streamMessageTypeEnabled(boolean streamMessageTypeEnabled)
```
    Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data. The option is a: boolean type. Default: false Group: producer (advanced)
  - allowAutoWiredConnectionFactory
```
default JmsComponentBuilderFactory.JmsComponentBuilder allowAutoWiredConnectionFactory(boolean allowAutoWiredConnectionFactory)
```
    Whether to auto-discover ConnectionFactory from the registry, if no connection factory has been configured. If only one instance of ConnectionFactory is found then it will be used. This is enabled by default. The option is a: boolean type. Default: true Group: advanced
  - allowAutoWiredDestinationResolver
```
default JmsComponentBuilderFactory.JmsComponentBuilder allowAutoWiredDestinationResolver(boolean allowAutoWiredDestinationResolver)
```
    Whether to auto-discover DestinationResolver from the registry, if no destination resolver has been configured. If only one instance of DestinationResolver is found then it will be used. This is enabled by default. The option is a: boolean type. Default: true Group: advanced
  - allowSerializedHeaders
```
default JmsComponentBuilderFactory.JmsComponentBuilder allowSerializedHeaders(boolean allowSerializedHeaders)
```
    Controls whether or not to include serialized headers. Applies only when transferExchange is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. The option is a: boolean type. Default: false Group: advanced
  - artemisStreamingEnabled
```
default JmsComponentBuilderFactory.JmsComponentBuilder artemisStreamingEnabled(boolean artemisStreamingEnabled)
```
    Whether optimizing for Apache Artemis streaming mode. The option is a: boolean type. Default: true Group: advanced
  - asyncStartListener
```
default JmsComponentBuilderFactory.JmsComponentBuilder asyncStartListener(boolean asyncStartListener)
```
    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. The option is a: boolean type. Default: false Group: advanced
  - asyncStopListener
```
default JmsComponentBuilderFactory.JmsComponentBuilder asyncStopListener(boolean asyncStopListener)
```
    Whether to stop the JmsConsumer message listener asynchronously, when stopping a route. The option is a: boolean type. Default: false Group: advanced
  - basicPropertyBinding
```
default JmsComponentBuilderFactory.JmsComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - configuration
```
default JmsComponentBuilderFactory.JmsComponentBuilder configuration(org.apache.camel.component.jms.JmsConfiguration configuration)
```
    To use a shared JMS configuration. The option is a: org.apache.camel.component.jms.JmsConfiguration type. Group: advanced
  - destinationResolver
```
default JmsComponentBuilderFactory.JmsComponentBuilder destinationResolver(org.springframework.jms.support.destination.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). The option is a: org.springframework.jms.support.destination.DestinationResolver type. Group: advanced
  - errorHandler
```
default JmsComponentBuilderFactory.JmsComponentBuilder errorHandler(org.springframework.util.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. The option is a: org.springframework.util.ErrorHandler type. Group: advanced
  - exceptionListener
```
default JmsComponentBuilderFactory.JmsComponentBuilder exceptionListener(javax.jms.ExceptionListener exceptionListener)
```
    Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option is a: javax.jms.ExceptionListener type. Group: advanced
  - idleConsumerLimit
```
default JmsComponentBuilderFactory.JmsComponentBuilder idleConsumerLimit(int idleConsumerLimit)
```
    Specify the limit for the number of consumers that are allowed to be idle at any given time. The option is a: int type. Default: 1 Group: advanced
  - idleTaskExecutionLimit
```
default JmsComponentBuilderFactory.JmsComponentBuilder idleTaskExecutionLimit(int idleTaskExecutionLimit)
```
    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. The option is a: int type. Default: 1 Group: advanced
  - includeAllJMSXProperties
```
default JmsComponentBuilderFactory.JmsComponentBuilder includeAllJMSXProperties(boolean includeAllJMSXProperties)
```
    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. The option is a: boolean type. Default: false Group: advanced
  - jmsKeyFormatStrategy
```
default JmsComponentBuilderFactory.JmsComponentBuilder jmsKeyFormatStrategy(org.apache.camel.component.jms.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. The option is a: org.apache.camel.component.jms.JmsKeyFormatStrategy type. Group: advanced
  - mapJmsMessage
```
default JmsComponentBuilderFactory.JmsComponentBuilder mapJmsMessage(boolean mapJmsMessage)
```
    Specifies whether Camel should auto map the received JMS message to a suited payload type, such as javax.jms.TextMessage to a String etc. The option is a: boolean type. Default: true Group: advanced
  - maxMessagesPerTask
```
default JmsComponentBuilderFactory.JmsComponentBuilder maxMessagesPerTask(int maxMessagesPerTask)
```
    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. The option is a: int type. Default: -1 Group: advanced
  - messageConverter
```
default JmsComponentBuilderFactory.JmsComponentBuilder messageConverter(org.springframework.jms.support.converter.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. The option is a: org.springframework.jms.support.converter.MessageConverter type. Group: advanced
  - messageCreatedStrategy
```
default JmsComponentBuilderFactory.JmsComponentBuilder messageCreatedStrategy(org.apache.camel.component.jms.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. The option is a: org.apache.camel.component.jms.MessageCreatedStrategy type. Group: advanced
  - messageIdEnabled
```
default JmsComponentBuilderFactory.JmsComponentBuilder messageIdEnabled(boolean messageIdEnabled)
```
    When sending, specifies whether message IDs should be added. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value. The option is a: boolean type. Default: true Group: advanced
  - messageListenerContainerFactory
```
default JmsComponentBuilderFactory.JmsComponentBuilder messageListenerContainerFactory(org.apache.camel.component.jms.MessageListenerContainerFactory 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. The option is a: org.apache.camel.component.jms.MessageListenerContainerFactory type. Group: advanced
  - messageTimestampEnabled
```
default JmsComponentBuilderFactory.JmsComponentBuilder messageTimestampEnabled(boolean messageTimestampEnabled)
```
    Specifies whether timestamps should be enabled by default on sending messages. This is just an hint to the JMS broker. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint the timestamp must be set to its normal value. The option is a: boolean type. Default: true Group: advanced
  - pubSubNoLocal
```
default JmsComponentBuilderFactory.JmsComponentBuilder pubSubNoLocal(boolean pubSubNoLocal)
```
    Specifies whether to inhibit the delivery of messages published by its own connection. The option is a: boolean type. Default: false Group: advanced
  - queueBrowseStrategy
```
default JmsComponentBuilderFactory.JmsComponentBuilder queueBrowseStrategy(org.apache.camel.component.jms.QueueBrowseStrategy queueBrowseStrategy)
```
    To use a custom QueueBrowseStrategy when browsing queues. The option is a: org.apache.camel.component.jms.QueueBrowseStrategy type. Group: advanced
  - receiveTimeout
```
default JmsComponentBuilderFactory.JmsComponentBuilder receiveTimeout(long receiveTimeout)
```
    The timeout for receiving messages (in milliseconds). The option is a: long type. Default: 1000 Group: advanced
  - recoveryInterval
```
default JmsComponentBuilderFactory.JmsComponentBuilder recoveryInterval(long recoveryInterval)
```
    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. The option is a: long type. Default: 5000 Group: advanced
  - requestTimeoutCheckerInterval
```
default JmsComponentBuilderFactory.JmsComponentBuilder requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval)
```
    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. The option is a: long type. Default: 1000 Group: advanced
  - transferException
```
default JmsComponentBuilderFactory.JmsComponentBuilder transferException(boolean transferException)
```
    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. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!. The option is a: boolean type. Default: false Group: advanced
  - transferExchange
```
default JmsComponentBuilderFactory.JmsComponentBuilder transferExchange(boolean transferExchange)
```
    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. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer having to use compatible Camel versions!. The option is a: boolean type. Default: false Group: advanced
  - useMessageIDAsCorrelationID
```
default JmsComponentBuilderFactory.JmsComponentBuilder useMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)
```
    Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. The option is a: boolean type. Default: false Group: advanced
  - waitForProvisionCorrelationToBeUpdatedCounter
```
default JmsComponentBuilderFactory.JmsComponentBuilder waitForProvisionCorrelationToBeUpdatedCounter(int waitForProvisionCorrelationToBeUpdatedCounter)
```
    Number of times to wait for provisional correlation id to be updated to the actual correlation id when doing request/reply over JMS and when the option useMessageIDAsCorrelationID is enabled. The option is a: int type. Default: 50 Group: advanced
  - waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
```
default JmsComponentBuilderFactory.JmsComponentBuilder waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)
```
    Interval in millis to sleep each time while waiting for provisional correlation id to be updated. The option is a: long type. Default: 100 Group: advanced
  - headerFilterStrategy
```
default JmsComponentBuilderFactory.JmsComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
```
    To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a: org.apache.camel.spi.HeaderFilterStrategy type. Group: filter
  - errorHandlerLoggingLevel
```
default JmsComponentBuilderFactory.JmsComponentBuilder errorHandlerLoggingLevel(org.apache.camel.LoggingLevel errorHandlerLoggingLevel)
```
    Allows to configure the default errorHandler logging level for logging uncaught exceptions. The option is a: org.apache.camel.LoggingLevel type. Default: WARN Group: logging
  - errorHandlerLogStackTrace
```
default JmsComponentBuilderFactory.JmsComponentBuilder errorHandlerLogStackTrace(boolean errorHandlerLogStackTrace)
```
    Allows to control whether stacktraces should be logged or not, by the default errorHandler. The option is a: boolean type. Default: true Group: logging
  - password
```
default JmsComponentBuilderFactory.JmsComponentBuilder password(String password)
```
    Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. The option is a: java.lang.String type. Group: security
  - username
```
default JmsComponentBuilderFactory.JmsComponentBuilder username(String username)
```
    Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. The option is a: java.lang.String type. Group: security
  - transacted
```
default JmsComponentBuilderFactory.JmsComponentBuilder transacted(boolean transacted)
```
    Specifies whether to use transacted mode. The option is a: boolean type. Default: false Group: transaction
  - lazyCreateTransactionManager
```
default JmsComponentBuilderFactory.JmsComponentBuilder lazyCreateTransactionManager(boolean lazyCreateTransactionManager)
```
    If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true. The option is a: boolean type. Default: true Group: transaction (advanced)
  - transactionManager
```
default JmsComponentBuilderFactory.JmsComponentBuilder transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
```
    The Spring transaction manager to use. The option is a: org.springframework.transaction.PlatformTransactionManager type. Group: transaction (advanced)
  - transactionName
```
default JmsComponentBuilderFactory.JmsComponentBuilder transactionName(String transactionName)
```
    The name of the transaction to use. The option is a: java.lang.String type. Group: transaction (advanced)
  - transactionTimeout
```
default JmsComponentBuilderFactory.JmsComponentBuilder transactionTimeout(int transactionTimeout)
```
    The timeout value of the transaction (in seconds), if using transacted mode. The option is a: int type. Default: -1 Group: transaction (advanced)

Interface JmsComponentBuilderFactory.JmsComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

clientId

connectionFactory

disableReplyTo

durableSubscriptionName

jmsMessageType

testConnectionOnStartup

acknowledgementModeName

asyncConsumer

autoStartup

cacheLevel

cacheLevelName

concurrentConsumers

maxConcurrentConsumers

replyTo

replyToDeliveryPersistent

selector

subscriptionDurable

subscriptionName

subscriptionShared

acceptMessagesWhileStopping

allowReplyManagerQuickStop

consumerType

defaultTaskExecutorType

eagerLoadingOfProperties

eagerPoisonBody

exposeListenerSession

replyToSameDestinationAllowed

taskExecutor

deliveryDelay

deliveryMode

deliveryPersistent

explicitQosEnabled

formatDateHeadersToIso8601

lazyStartProducer

preserveMessageQos

priority

replyToConcurrentConsumers

replyToMaxConcurrentConsumers

replyToOnTimeoutMaxConcurrentConsumers

replyToOverride

replyToType

requestTimeout

timeToLive

allowAdditionalHeaders

allowNullBody

alwaysCopyMessage

correlationProperty

disableTimeToLive

forceSendOriginalMessage

includeSentJMSMessageID

replyToCacheLevelName

replyToDestinationSelectorName

streamMessageTypeEnabled

allowAutoWiredConnectionFactory

allowAutoWiredDestinationResolver

allowSerializedHeaders

artemisStreamingEnabled

asyncStartListener

asyncStopListener

basicPropertyBinding

configuration

destinationResolver

errorHandler

exceptionListener

idleConsumerLimit

idleTaskExecutionLimit

includeAllJMSXProperties

jmsKeyFormatStrategy

mapJmsMessage

maxMessagesPerTask

messageConverter

messageCreatedStrategy

messageIdEnabled

messageListenerContainerFactory

messageTimestampEnabled

pubSubNoLocal