Package org.apache.camel.component.jms

Class JmsConfiguration

java.lang.Object
org.apache.camel.component.jms.JmsConfiguration
All Implemented Interfaces:
Cloneable
@UriParams public class JmsConfiguration extends Object implements Cloneable

  • Field Details

  • Constructor Details

    • JmsConfiguration

      public JmsConfiguration()

    • JmsConfiguration

      public JmsConfiguration(jakarta.jms.ConnectionFactory connectionFactory)

  • Method Details

    • copy

      public JmsConfiguration copy()
      Returns a copy of this configuration

    • createInOutTemplate

      public org.springframework.jms.core.JmsOperations createInOutTemplate(JmsEndpoint endpoint, boolean pubSubDomain, String destination, long requestTimeout)
      Creates a JmsOperations object used for request/response using a request timeout value

    • createInOnlyTemplate

      public org.springframework.jms.core.JmsOperations createInOnlyTemplate(JmsEndpoint endpoint, boolean pubSubDomain, String destination)
      Creates a JmsOperations object used for one way messaging

    • createMessageListenerContainer

      public org.springframework.jms.listener.AbstractMessageListenerContainer createMessageListenerContainer(JmsEndpoint endpoint)

    • chooseMessageListenerContainerImplementation

      @Deprecated public org.springframework.jms.listener.AbstractMessageListenerContainer chooseMessageListenerContainerImplementation(JmsEndpoint endpoint)
      Deprecated.

    • chooseMessageListenerContainerImplementation

      public org.springframework.jms.listener.AbstractMessageListenerContainer chooseMessageListenerContainerImplementation(JmsEndpoint endpoint, ConsumerType type)

    • getConsumerType

      public ConsumerType getConsumerType()

    • setConsumerType

      public void setConsumerType(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.

    • getReplyToConsumerType

      public ConsumerType getReplyToConsumerType()

    • setReplyToConsumerType

      public void setReplyToConsumerType(ConsumerType replyToConsumerType)
      The consumer type of the reply consumer (when doing request/reply), 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.

    • getConnectionFactory

      public jakarta.jms.ConnectionFactory getConnectionFactory()

    • getOrCreateConnectionFactory

      public jakarta.jms.ConnectionFactory getOrCreateConnectionFactory()

    • setConnectionFactory

      public void setConnectionFactory(jakarta.jms.ConnectionFactory connectionFactory)
      Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or setListenerConnectionFactory(ConnectionFactory)

    • getUsername

      public String getUsername()

    • setUsername

      public void setUsername(String username)
      Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.

    • getPassword

      public String getPassword()

    • setPassword

      public void setPassword(String password)
      Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory.

    • getListenerConnectionFactory

      public jakarta.jms.ConnectionFactory getListenerConnectionFactory()

    • getOrCreateListenerConnectionFactory

      public jakarta.jms.ConnectionFactory getOrCreateListenerConnectionFactory()

    • setListenerConnectionFactory

      public void setListenerConnectionFactory(jakarta.jms.ConnectionFactory listenerConnectionFactory)
      Sets the connection factory to be used for consuming messages

    • getTemplateConnectionFactory

      public jakarta.jms.ConnectionFactory getTemplateConnectionFactory()

    • getOrCreateTemplateConnectionFactory

      public jakarta.jms.ConnectionFactory getOrCreateTemplateConnectionFactory()

    • setTemplateConnectionFactory

      public void setTemplateConnectionFactory(jakarta.jms.ConnectionFactory templateConnectionFactory)
      Sets the connection factory to be used for sending messages via the JmsTemplate via createInOnlyTemplate(JmsEndpoint, boolean, String)

    • isAutoStartup

      public boolean isAutoStartup()

    • setAutoStartup

      public void setAutoStartup(boolean autoStartup)
      Specifies whether the consumer container should auto-startup.

    • isAcceptMessagesWhileStopping

      public boolean isAcceptMessagesWhileStopping()

    • setAcceptMessagesWhileStopping

      public void setAcceptMessagesWhileStopping(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.

    • isAllowReplyManagerQuickStop

      public boolean isAllowReplyManagerQuickStop()
      Whether the DefaultMessageListenerContainer used in the reply managers for request-reply messaging allow the AbstractJmsListeningContainer.runningAllowed() flag to quick stop in case isAcceptMessagesWhileStopping() is enabled, and CamelContext is currently being stopped. This quick stop ability is enabled by default in the regular JMS consumers but to enable for reply managers you must enable this flag.

    • setAllowReplyManagerQuickStop

      public void setAllowReplyManagerQuickStop(boolean allowReplyManagerQuickStop)

    • getClientId

      public String getClientId()

    • setClientId

      public void setClientId(String consumerClientId)
      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.

    • getDurableSubscriptionName

      public String getDurableSubscriptionName()

    • setDurableSubscriptionName

      public void setDurableSubscriptionName(String durableSubscriptionName)
      The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well.

    • getExceptionListener

      public jakarta.jms.ExceptionListener getExceptionListener()

    • setExceptionListener

      public void setExceptionListener(jakarta.jms.ExceptionListener exceptionListener)
      Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.

    • setErrorHandler

      public void setErrorHandler(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.

    • getErrorHandler

      public org.springframework.util.ErrorHandler getErrorHandler()

    • getErrorHandlerLoggingLevel

      public org.apache.camel.LoggingLevel getErrorHandlerLoggingLevel()

    • setErrorHandlerLoggingLevel

      public void setErrorHandlerLoggingLevel(org.apache.camel.LoggingLevel errorHandlerLoggingLevel)
      Allows to configure the default errorHandler logging level for logging uncaught exceptions.

    • isErrorHandlerLogStackTrace

      public boolean isErrorHandlerLogStackTrace()

    • setErrorHandlerLogStackTrace

      public void setErrorHandlerLogStackTrace(boolean errorHandlerLogStackTrace)
      Allows to control whether stacktraces should be logged or not, by the default errorHandler.

    • getAcknowledgementModeName

      public String getAcknowledgementModeName()

    • setAcknowledgementModeName

      public void setAcknowledgementModeName(String consumerAcknowledgementMode)
      The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE

    • isExposeListenerSession

      public boolean isExposeListenerSession()

    • setExposeListenerSession

      public void setExposeListenerSession(boolean exposeListenerSession)
      Specifies whether the listener session should be exposed when consuming messages.

    • getTaskExecutor

      public org.springframework.core.task.TaskExecutor getTaskExecutor()

    • setTaskExecutor

      public void setTaskExecutor(org.springframework.core.task.TaskExecutor taskExecutor)
      Allows you to specify a custom task executor for consuming messages.

    • isPubSubNoLocal

      public boolean isPubSubNoLocal()

    • setPubSubNoLocal

      public void setPubSubNoLocal(boolean pubSubNoLocal)
      Specifies whether to inhibit the delivery of messages published by its own connection.

    • getConcurrentConsumers

      public int getConcurrentConsumers()

    • setConcurrentConsumers

      public void setConcurrentConsumers(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.

    • getReplyToConcurrentConsumers

      public int getReplyToConcurrentConsumers()

    • setReplyToConcurrentConsumers

      public void setReplyToConcurrentConsumers(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.

    • getMaxMessagesPerTask

      public int getMaxMessagesPerTask()

    • setMaxMessagesPerTask

      public void setMaxMessagesPerTask(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.

    • getCacheLevel

      public int getCacheLevel()

    • setCacheLevel

      public void setCacheLevel(int cacheLevel)
      Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details.

    • getCacheLevelName

      public String getCacheLevelName()

    • setCacheLevelName

      public void setCacheLevelName(String cacheName)
      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.

    • getRecoveryInterval

      public long getRecoveryInterval()

    • setRecoveryInterval

      public void setRecoveryInterval(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.

    • getReceiveTimeout

      public long getReceiveTimeout()

    • setReceiveTimeout

      public void setReceiveTimeout(long receiveTimeout)
      The timeout for receiving messages (in milliseconds).

    • getTransactionManager

      public org.springframework.transaction.PlatformTransactionManager getTransactionManager()

    • getOrCreateTransactionManager

      public org.springframework.transaction.PlatformTransactionManager getOrCreateTransactionManager()

    • setTransactionManager

      public void setTransactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
      The Spring transaction manager to use.

    • getTransactionName

      public String getTransactionName()

    • setTransactionName

      public void setTransactionName(String transactionName)
      The name of the transaction to use.

    • getTransactionTimeout

      public int getTransactionTimeout()

    • setTransactionTimeout

      public void setTransactionTimeout(int transactionTimeout)
      The timeout value of the transaction (in seconds), if using transacted mode.

    • getIdleTaskExecutionLimit

      public int getIdleTaskExecutionLimit()

    • setIdleTaskExecutionLimit

      public void setIdleTaskExecutionLimit(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.

    • getIdleConsumerLimit

      public int getIdleConsumerLimit()

    • setIdleConsumerLimit

      public void setIdleConsumerLimit(int idleConsumerLimit)
      Specify the limit for the number of consumers that are allowed to be idle at any given time.

    • getWaitForProvisionCorrelationToBeUpdatedCounter

      public int getWaitForProvisionCorrelationToBeUpdatedCounter()

    • setWaitForProvisionCorrelationToBeUpdatedCounter

      public void setWaitForProvisionCorrelationToBeUpdatedCounter(int counter)
      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.

    • getWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime

      public long getWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime()

    • setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime

      public void setWaitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long sleepingTime)
      Interval in millis to sleep each time while waiting for provisional correlation id to be updated.

    • getMaxConcurrentConsumers

      public int getMaxConcurrentConsumers()

    • setMaxConcurrentConsumers

      public void setMaxConcurrentConsumers(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.

    • getReplyToMaxConcurrentConsumers

      public int getReplyToMaxConcurrentConsumers()

    • setReplyToMaxConcurrentConsumers

      public void setReplyToMaxConcurrentConsumers(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.

    • getReplyToOnTimeoutMaxConcurrentConsumers

      public int getReplyToOnTimeoutMaxConcurrentConsumers()

    • setReplyToOnTimeoutMaxConcurrentConsumers

      public void setReplyToOnTimeoutMaxConcurrentConsumers(int replyToOnTimeoutMaxConcurrentConsumers)
      Specifies the maximum number of concurrent consumers for continue routing when timeout occurred when using request/reply over JMS.

    • isExplicitQosEnabled

      public boolean isExplicitQosEnabled()

    • getExplicitQosEnabled

      public Boolean getExplicitQosEnabled()

    • setExplicitQosEnabled

      public void setExplicitQosEnabled(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.

    • isDeliveryPersistent

      public boolean isDeliveryPersistent()

    • setDeliveryPersistent

      public void setDeliveryPersistent(boolean deliveryPersistent)
      Specifies whether persistent delivery is used by default.

    • getDeliveryMode

      public Integer getDeliveryMode()

    • setDeliveryMode

      public void setDeliveryMode(Integer deliveryMode)
      Specifies the delivery mode to be used. Possible values are those defined by jakarta.jms.DeliveryMode. NON_PERSISTENT = 1 and PERSISTENT = 2.

    • isReplyToDeliveryPersistent

      public boolean isReplyToDeliveryPersistent()

    • setReplyToDeliveryPersistent

      public void setReplyToDeliveryPersistent(boolean replyToDeliveryPersistent)
      Specifies whether to use persistent delivery by default for replies.

    • getTimeToLive

      public long getTimeToLive()

    • setTimeToLive

      public void setTimeToLive(long timeToLive)
      When sending messages, specifies the time-to-live of the message (in milliseconds).

    • getMessageConverter

      public org.springframework.jms.support.converter.MessageConverter getMessageConverter()

    • setMessageConverter

      public void setMessageConverter(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 jakarta.jms.Message.

    • isMapJmsMessage

      public boolean isMapJmsMessage()

    • setMapJmsMessage

      public void setMapJmsMessage(boolean mapJmsMessage)
      Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc.

    • isMessageIdEnabled

      public boolean isMessageIdEnabled()

    • setMessageIdEnabled

      public void setMessageIdEnabled(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

    • isMessageTimestampEnabled

      public boolean isMessageTimestampEnabled()

    • setMessageTimestampEnabled

      public void setMessageTimestampEnabled(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.

    • getPriority

      public int getPriority()

    • setPriority

      public void setPriority(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.

    • getAcknowledgementMode

      public int getAcknowledgementMode()

    • setAcknowledgementMode

      public void setAcknowledgementMode(int consumerAcknowledgementMode)
      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.

    • isTransacted

      public boolean isTransacted()

    • setTransacted

      public void setTransacted(boolean transacted)
      Specifies whether to use transacted mode

    • isTransactedInOut

      public boolean isTransactedInOut()

    • setTransactedInOut

      public void setTransactedInOut(boolean transactedInOut)
      Specifies whether InOut operations (request reply) default to using transacted mode. If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case.

      Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction.

    • isLazyCreateTransactionManager

      public boolean isLazyCreateTransactionManager()

    • setLazyCreateTransactionManager

      public void setLazyCreateTransactionManager(boolean lazyCreating)
      If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.

    • getEagerPoisonBody

      public String getEagerPoisonBody()

    • setEagerPoisonBody

      public void setEagerPoisonBody(String eagerPoisonBody)
      If eagerLoadingOfProperties is enabled and the JMS message payload (JMS body or JMS properties) 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.

    • isEagerLoadingOfProperties

      public boolean isEagerLoadingOfProperties()

    • setEagerLoadingOfProperties

      public void setEagerLoadingOfProperties(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.

    • isDisableReplyTo

      public boolean isDisableReplyTo()

    • setDisableReplyTo

      public void setDisableReplyTo(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.

    • setPreserveMessageQos

      public void setPreserveMessageQos(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.

    • getJmsOperations

      public org.springframework.jms.core.JmsOperations getJmsOperations()

    • setJmsOperations

      public void setJmsOperations(org.springframework.jms.core.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.

    • getDestinationResolver

      public org.springframework.jms.support.destination.DestinationResolver getDestinationResolver()

    • setDestinationResolver

      public void setDestinationResolver(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).

    • createDestinationResolver

      public static org.springframework.jms.support.destination.DestinationResolver createDestinationResolver(DestinationEndpoint destinationEndpoint)

    • configureMessageListenerContainer

      protected void configureMessageListenerContainer(org.springframework.jms.listener.AbstractMessageListenerContainer container, JmsEndpoint endpoint)

    • configureMessageListener

      public void configureMessageListener(EndpointMessageListener listener)

    • defaultCacheLevel

      protected int defaultCacheLevel(JmsEndpoint endpoint)
      Defaults the JMS cache level if none is explicitly specified.

      Will return CACHE_AUTO which will pickup and use CACHE_NONE if transacted has been enabled, otherwise it will use CACHE_CONSUMER which is the most efficient.

      Parameters:
      endpoint - the endpoint
      Returns:
      the cache level

    • createConnectionFactory

      protected jakarta.jms.ConnectionFactory createConnectionFactory()
      Factory method which allows derived classes to customize the lazy creation

    • createListenerConnectionFactory

      protected jakarta.jms.ConnectionFactory createListenerConnectionFactory()
      Factory method which allows derived classes to customize the lazy creation

    • createTemplateConnectionFactory

      protected jakarta.jms.ConnectionFactory createTemplateConnectionFactory()
      Factory method which allows derived classes to customize the lazy creation

    • createTransactionManager

      protected org.springframework.transaction.PlatformTransactionManager createTransactionManager()
      Factory method which which allows derived classes to customize the lazy transaction manager creation

    • isPreserveMessageQos

      public boolean isPreserveMessageQos()

    • configuredQoS

      protected void configuredQoS()
      When one of the QoS properties are configured such as setDeliveryPersistent(boolean), setPriority(int) or setTimeToLive(long) then we should auto default the setting of setExplicitQosEnabled(boolean) if its not been configured yet

    • isAlwaysCopyMessage

      public boolean isAlwaysCopyMessage()

    • setAlwaysCopyMessage

      public void setAlwaysCopyMessage(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)

    • isUseMessageIDAsCorrelationID

      public boolean isUseMessageIDAsCorrelationID()

    • setUseMessageIDAsCorrelationID

      public void setUseMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)
      Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.

    • getRequestTimeout

      public long getRequestTimeout()

    • setRequestTimeout

      public void setRequestTimeout(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.

    • getRequestTimeoutCheckerInterval

      public long getRequestTimeoutCheckerInterval()

    • setRequestTimeoutCheckerInterval

      public void setRequestTimeoutCheckerInterval(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.

    • getReplyTo

      public String getReplyTo()

    • setReplyTo

      public void setReplyTo(String replyToDestination)
      Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo().

    • getReplyToDestinationSelectorName

      public String getReplyToDestinationSelectorName()

    • setReplyToDestinationSelectorName

      public void setReplyToDestinationSelectorName(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).

    • getReplyToOverride

      public String getReplyToOverride()

    • setReplyToOverride

      public void setReplyToOverride(String replyToDestination)
      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.

    • isReplyToSameDestinationAllowed

      public boolean isReplyToSameDestinationAllowed()

    • setReplyToSameDestinationAllowed

      public void setReplyToSameDestinationAllowed(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.

    • getJmsMessageType

      public JmsMessageType getJmsMessageType()

    • setJmsMessageType

      public void setJmsMessageType(JmsMessageType jmsMessageType)
      Allows you to force the use of a specific jakarta.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.

    • supportBlobMessage

      protected boolean supportBlobMessage()
      Should get overridden by implementations which support BlobMessages
      Returns:
      false

    • getJmsKeyFormatStrategy

      public JmsKeyFormatStrategy getJmsKeyFormatStrategy()

    • setJmsKeyFormatStrategy

      public void setJmsKeyFormatStrategy(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.

    • isTransferExchange

      public boolean isTransferExchange()

    • setTransferExchange

      public void setTransferExchange(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 receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!

    • isAllowSerializedHeaders

      public boolean isAllowSerializedHeaders()

    • setAllowSerializedHeaders

      public void setAllowSerializedHeaders(boolean allowSerializedHeaders)
      Controls whether or not to include serialized headers. Applies only when isTransferExchange() is true. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.

    • isTransferException

      public boolean isTransferException()

    • setTransferException

      public void setTransferException(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 jakarta.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!

    • isAsyncStartListener

      public boolean isAsyncStartListener()

    • setAsyncStartListener

      public void setAsyncStartListener(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.

    • isAsyncStopListener

      public boolean isAsyncStopListener()

    • setAsyncStopListener

      public void setAsyncStopListener(boolean asyncStopListener)
      Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.

    • isTestConnectionOnStartup

      public boolean isTestConnectionOnStartup()

    • setTestConnectionOnStartup

      public void setTestConnectionOnStartup(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.

    • setForceSendOriginalMessage

      public void setForceSendOriginalMessage(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.

    • isForceSendOriginalMessage

      public boolean isForceSendOriginalMessage()

    • isDisableTimeToLive

      public boolean isDisableTimeToLive()

    • setDisableTimeToLive

      public void setDisableTimeToLive(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.

    • getReplyToType

      public ReplyToType getReplyToType()

    • setReplyToType

      public void setReplyToType(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.

    • isAsyncConsumer

      public boolean isAsyncConsumer()

    • setAsyncConsumer

      public void setAsyncConsumer(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).

    • setReplyToCacheLevelName

      public void setReplyToCacheLevelName(String name)
      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.

    • getReplyToCacheLevelName

      public String getReplyToCacheLevelName()

    • isAllowNullBody

      public boolean isAllowNullBody()

    • setAllowNullBody

      public void setAllowNullBody(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.

    • getMessageListenerContainerFactory

      public MessageListenerContainerFactory getMessageListenerContainerFactory()

    • setMessageListenerContainerFactory

      public void setMessageListenerContainerFactory(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.

    • isIncludeSentJMSMessageID

      public boolean isIncludeSentJMSMessageID()

    • setIncludeSentJMSMessageID

      public void setIncludeSentJMSMessageID(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.

    • getDefaultTaskExecutorType

      public DefaultTaskExecutorType getDefaultTaskExecutorType()

    • setDefaultTaskExecutorType

      public void setDefaultTaskExecutorType(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.

    • isIncludeAllJMSXProperties

      public boolean isIncludeAllJMSXProperties()

    • setIncludeAllJMSXProperties

      public void setIncludeAllJMSXProperties(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.

    • getMessageCreatedStrategy

      public MessageCreatedStrategy getMessageCreatedStrategy()

    • setMessageCreatedStrategy

      public void setMessageCreatedStrategy(MessageCreatedStrategy messageCreatedStrategy)
      To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message.

    • getSelector

      public String getSelector()

    • setSelector

      public void setSelector(String selector)
      Sets the JMS selector to use

    • setCorrelationProperty

      public void setCorrelationProperty(String correlationProperty)
      Use this JMS property to correlate messages in InOut exchange pattern (request-reply) instead of JMSCorrelationID property. This allows you to exchange messages with systems that do not correlate messages using JMSCorrelationID JMS property. If used JMSCorrelationID will not be used or set by Camel. The value of here named property will be generated if not supplied in the header of the message under the same name.

    • getCorrelationProperty

      public String getCorrelationProperty()

    • getAllowAdditionalHeaders

      public String getAllowAdditionalHeaders()

    • setAllowAdditionalHeaders

      public void setAllowAdditionalHeaders(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.

    • isSubscriptionDurable

      public boolean isSubscriptionDurable()

    • setSubscriptionDurable

      public void setSubscriptionDurable(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.

    • isSubscriptionShared

      public boolean isSubscriptionShared()

    • setSubscriptionShared

      public void setSubscriptionShared(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.

    • getSubscriptionName

      public String getSubscriptionName()

    • setSubscriptionName

      public void setSubscriptionName(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).

    • isStreamMessageTypeEnabled

      public boolean isStreamMessageTypeEnabled()

    • setStreamMessageTypeEnabled

      public void setStreamMessageTypeEnabled(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.

    • isFormatDateHeadersToIso8601

      public boolean isFormatDateHeadersToIso8601()
      Gets whether date headers should be formatted according to the ISO 8601 standard.

    • setFormatDateHeadersToIso8601

      public void setFormatDateHeadersToIso8601(boolean formatDateHeadersToIso8601)
      Sets whether date headers should be formatted according to the ISO 8601 standard.

    • getDeliveryDelay

      public long getDeliveryDelay()

    • setDeliveryDelay

      public void setDeliveryDelay(long deliveryDelay)
      Sets delivery delay to use for send calls for JMS. This option requires JMS 2.0 compliant broker.

    • isArtemisStreamingEnabled

      public boolean isArtemisStreamingEnabled()

    • setArtemisStreamingEnabled

      public void setArtemisStreamingEnabled(boolean artemisStreamingEnabled)
      Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used.

    • setArtemisConsumerPriority

      public void setArtemisConsumerPriority(int priority)

    • getArtemisConsumerPriority

      public int getArtemisConsumerPriority()

    • isSynchronous

      public boolean isSynchronous()

    • setSynchronous

      public void setSynchronous(boolean synchronous)