org.apache.camel.builder.endpoint.dsl

Interface JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver

All Known Subinterfaces:

JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder

Enclosing interface:

JmsEndpointBuilderFactory

public static interface JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder

Advanced builder for endpoint consumers for the JMS component.

Method Summary

Modifier and Type	Method and Description
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	acceptMessagesWhileStopping(boolean acceptMessagesWhileStopping) Specifies whether the consumer accept messages while it is stopping.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	acceptMessagesWhileStopping(String acceptMessagesWhileStopping) Specifies whether the consumer accept messages while it is stopping.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	allowReplyManagerQuickStop(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	allowSerializedHeaders(boolean allowSerializedHeaders) Controls whether or not to include serialized headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	allowSerializedHeaders(String allowSerializedHeaders) Controls whether or not to include serialized headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	artemisStreamingEnabled(boolean artemisStreamingEnabled) Whether optimizing for Apache Artemis streaming mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	artemisStreamingEnabled(String artemisStreamingEnabled) Whether optimizing for Apache Artemis streaming mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	asyncStartListener(boolean asyncStartListener) Whether to startup the JmsConsumer message listener asynchronously, when starting a route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	asyncStartListener(String asyncStartListener) Whether to startup the JmsConsumer message listener asynchronously, when starting a route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	asyncStopListener(boolean asyncStopListener) Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	asyncStopListener(String asyncStopListener) Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	basic()
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	consumerType(JmsEndpointBuilderFactory.ConsumerType consumerType) The consumer type to use, which can be one of: Simple, Default, or Custom.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	consumerType(String consumerType) The consumer type to use, which can be one of: Simple, Default, or Custom.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	defaultTaskExecutorType(JmsEndpointBuilderFactory.DefaultTaskExecutorType defaultTaskExecutorType) Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	defaultTaskExecutorType(String defaultTaskExecutorType) Specifies what default TaskExecutor type to use in the DefaultMessageListenerContainer, for both consumer endpoints and the ReplyTo consumer of producer endpoints.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	destinationResolver(Object 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	destinationResolver(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	eagerLoadingOfProperties(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	errorHandler(Object errorHandler) Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	errorHandler(String errorHandler) Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exceptionHandler(String exceptionHandler) To let the consumer use a custom ExceptionHandler.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exceptionListener(Object exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exceptionListener(String exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exchangePattern(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exchangePattern(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exposeListenerSession(boolean exposeListenerSession) Specifies whether the listener session should be exposed when consuming messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	exposeListenerSession(String exposeListenerSession) Specifies whether the listener session should be exposed when consuming messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	idleConsumerLimit(int idleConsumerLimit) Specify the limit for the number of consumers that are allowed to be idle at any given time.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	idleConsumerLimit(String idleConsumerLimit) Specify the limit for the number of consumers that are allowed to be idle at any given time.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	idleTaskExecutionLimit(int idleTaskExecutionLimit) Specifies the limit for idle executions of a receive task, not having received any message within its execution.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	idleTaskExecutionLimit(String idleTaskExecutionLimit) Specifies the limit for idle executions of a receive task, not having received any message within its execution.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	includeAllJMSXProperties(boolean includeAllJMSXProperties) Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	includeAllJMSXProperties(String includeAllJMSXProperties) Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	jmsKeyFormatStrategy(Object jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	jmsKeyFormatStrategy(String jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	lazyCreateTransactionManager(boolean lazyCreateTransactionManager) If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	lazyCreateTransactionManager(String lazyCreateTransactionManager) If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	mapJmsMessage(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	maxMessagesPerTask(int maxMessagesPerTask) The number of messages per task.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	maxMessagesPerTask(String maxMessagesPerTask) The number of messages per task.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageConverter(Object 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageConverter(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageCreatedStrategy(Object 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageCreatedStrategy(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageIdEnabled(boolean messageIdEnabled) When sending, specifies whether message IDs should be added.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageIdEnabled(String messageIdEnabled) When sending, specifies whether message IDs should be added.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageListenerContainerFactory(Object messageListenerContainerFactory) Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageListenerContainerFactory(String messageListenerContainerFactory) Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageTimestampEnabled(boolean messageTimestampEnabled) Specifies whether timestamps should be enabled by default on sending messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	messageTimestampEnabled(String messageTimestampEnabled) Specifies whether timestamps should be enabled by default on sending messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	pubSubNoLocal(boolean pubSubNoLocal) Specifies whether to inhibit the delivery of messages published by its own connection.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	pubSubNoLocal(String pubSubNoLocal) Specifies whether to inhibit the delivery of messages published by its own connection.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	receiveTimeout(long receiveTimeout) The timeout for receiving messages (in milliseconds).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	receiveTimeout(String receiveTimeout) The timeout for receiving messages (in milliseconds).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	recoveryInterval(long recoveryInterval) Specifies the interval between recovery attempts, i.e.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	recoveryInterval(String recoveryInterval) Specifies the interval between recovery attempts, i.e.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	replyToSameDestinationAllowed(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval) Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	requestTimeoutCheckerInterval(String requestTimeoutCheckerInterval) Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	taskExecutor(Object taskExecutor) Allows you to specify a custom task executor for consuming messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	taskExecutor(String taskExecutor) Allows you to specify a custom task executor for consuming messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transactionManager(Object transactionManager) The Spring transaction manager to use.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transactionManager(String transactionManager) The Spring transaction manager to use.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transactionName(String transactionName) The name of the transaction to use.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transactionTimeout(int transactionTimeout) The timeout value of the transaction (in seconds), if using transacted mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transactionTimeout(String transactionTimeout) The timeout value of the transaction (in seconds), if using transacted mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transferException(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transferExchange(boolean transferExchange) You can transfer the exchange over the wire instead of just the body and headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	transferExchange(String transferExchange) You can transfer the exchange over the wire instead of just the body and headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	useMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID) Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	useMessageIDAsCorrelationID(String useMessageIDAsCorrelationID) Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	waitForProvisionCorrelationToBeUpdatedCounter(String 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 JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime) Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(String 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.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Method Detail

basic

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder basic()

acceptMessagesWhileStopping

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

acceptMessagesWhileStopping - the value to set

Returns:

the dsl builder

acceptMessagesWhileStopping

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder acceptMessagesWhileStopping(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

acceptMessagesWhileStopping - the value to set

Returns:

the dsl builder

allowReplyManagerQuickStop

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

allowReplyManagerQuickStop - the value to set

Returns:

the dsl builder

allowReplyManagerQuickStop

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder allowReplyManagerQuickStop(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

allowReplyManagerQuickStop - the value to set

Returns:

the dsl builder

consumerType

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder consumerType(JmsEndpointBuilderFactory.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: <code>org.apache.camel.component.jms.ConsumerType</code> type. Default: Default Group: consumer (advanced)

Parameters:

consumerType - the value to set

Returns:

the dsl builder

consumerType

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder consumerType(String 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 will be converted to a <code>org.apache.camel.component.jms.ConsumerType</code> type. Default: Default Group: consumer (advanced)

Parameters:

consumerType - the value to set

Returns:

the dsl builder

defaultTaskExecutorType

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder defaultTaskExecutorType(JmsEndpointBuilderFactory.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: <code>org.apache.camel.component.jms.DefaultTaskExecutorType</code> type. Group: consumer (advanced)

Parameters:

defaultTaskExecutorType - the value to set

Returns:

the dsl builder

defaultTaskExecutorType

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder defaultTaskExecutorType(String 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 will be converted to a <code>org.apache.camel.component.jms.DefaultTaskExecutorType</code> type. Group: consumer (advanced)

Parameters:

defaultTaskExecutorType - the value to set

Returns:

the dsl builder

eagerLoadingOfProperties

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

eagerLoadingOfProperties - the value to set

Returns:

the dsl builder

eagerLoadingOfProperties

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder eagerLoadingOfProperties(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

eagerLoadingOfProperties - the value to set

Returns:

the dsl builder

eagerPoisonBody

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>java.lang.String</code> type. Default: Poison JMS message due to ${exception.message} Group: consumer (advanced)

Parameters:

eagerPoisonBody - the value to set

Returns:

the dsl builder

exceptionHandler

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exceptionHandler(org.apache.camel.spi.ExceptionHandler exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exceptionHandler

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exceptionHandler(String exceptionHandler)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)

Parameters:

exceptionHandler - the value to set

Returns:

the dsl builder

exchangePattern

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exchangePattern

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exchangePattern(String exchangePattern)

Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)

Parameters:

exchangePattern - the value to set

Returns:

the dsl builder

exposeListenerSession

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exposeListenerSession(boolean exposeListenerSession)

Specifies whether the listener session should be exposed when consuming messages. The option is a: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

exposeListenerSession - the value to set

Returns:

the dsl builder

exposeListenerSession

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exposeListenerSession(String exposeListenerSession)

Specifies whether the listener session should be exposed when consuming messages. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

exposeListenerSession - the value to set

Returns:

the dsl builder

replyToSameDestinationAllowed

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

replyToSameDestinationAllowed - the value to set

Returns:

the dsl builder

replyToSameDestinationAllowed

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder replyToSameDestinationAllowed(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer (advanced)

Parameters:

replyToSameDestinationAllowed - the value to set

Returns:

the dsl builder

taskExecutor

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder taskExecutor(Object taskExecutor)

Allows you to specify a custom task executor for consuming messages. The option is a: <code>org.springframework.core.task.TaskExecutor</code> type. Group: consumer (advanced)

Parameters:

taskExecutor - the value to set

Returns:

the dsl builder

taskExecutor

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder taskExecutor(String taskExecutor)

Allows you to specify a custom task executor for consuming messages. The option will be converted to a <code>org.springframework.core.task.TaskExecutor</code> type. Group: consumer (advanced)

Parameters:

taskExecutor - the value to set

Returns:

the dsl builder

allowSerializedHeaders

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

allowSerializedHeaders - the value to set

Returns:

the dsl builder

allowSerializedHeaders

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder allowSerializedHeaders(String 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 will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

allowSerializedHeaders - the value to set

Returns:

the dsl builder

artemisStreamingEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder artemisStreamingEnabled(boolean artemisStreamingEnabled)

Whether optimizing for Apache Artemis streaming mode. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

artemisStreamingEnabled - the value to set

Returns:

the dsl builder

artemisStreamingEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder artemisStreamingEnabled(String artemisStreamingEnabled)

Whether optimizing for Apache Artemis streaming mode. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

artemisStreamingEnabled - the value to set

Returns:

the dsl builder

asyncStartListener

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

asyncStartListener

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder asyncStartListener(String 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 will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

asyncStopListener

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder asyncStopListener(boolean asyncStopListener)

Whether to stop the JmsConsumer message listener asynchronously, when stopping a route. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStopListener - the value to set

Returns:

the dsl builder

asyncStopListener

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder asyncStopListener(String asyncStopListener)

Whether to stop the JmsConsumer message listener asynchronously, when stopping a route. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

asyncStopListener - the value to set

Returns:

the dsl builder

destinationResolver

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder destinationResolver(Object 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: <code>org.springframework.jms.support.destination.DestinationResolver</code> type. Group: advanced

Parameters:

destinationResolver - the value to set

Returns:

the dsl builder

destinationResolver

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder destinationResolver(String 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 will be converted to a <code>org.springframework.jms.support.destination.DestinationResolver</code> type. Group: advanced

Parameters:

destinationResolver - the value to set

Returns:

the dsl builder

errorHandler

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder errorHandler(Object 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: <code>org.springframework.util.ErrorHandler</code> type. Group: advanced

Parameters:

errorHandler - the value to set

Returns:

the dsl builder

errorHandler

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder errorHandler(String 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 will be converted to a <code>org.springframework.util.ErrorHandler</code> type. Group: advanced

Parameters:

errorHandler - the value to set

Returns:

the dsl builder

exceptionListener

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exceptionListener(Object exceptionListener)

Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option is a: <code>javax.jms.ExceptionListener</code> type. Group: advanced

Parameters:

exceptionListener - the value to set

Returns:

the dsl builder

exceptionListener

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder exceptionListener(String exceptionListener)

Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions. The option will be converted to a <code>javax.jms.ExceptionListener</code> type. Group: advanced

Parameters:

exceptionListener - the value to set

Returns:

the dsl builder

headerFilterStrategy

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder headerFilterStrategy(String headerFilterStrategy)

To use a custom HeaderFilterStrategy to filter header to and from Camel message. The option will be converted to a <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: advanced

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

idleConsumerLimit

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>int</code> type. Default: 1 Group: advanced

Parameters:

idleConsumerLimit - the value to set

Returns:

the dsl builder

idleConsumerLimit

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder idleConsumerLimit(String idleConsumerLimit)

Specify the limit for the number of consumers that are allowed to be idle at any given time. The option will be converted to a <code>int</code> type. Default: 1 Group: advanced

Parameters:

idleConsumerLimit - the value to set

Returns:

the dsl builder

idleTaskExecutionLimit

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>int</code> type. Default: 1 Group: advanced

Parameters:

idleTaskExecutionLimit - the value to set

Returns:

the dsl builder

idleTaskExecutionLimit

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder idleTaskExecutionLimit(String 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 will be converted to a <code>int</code> type. Default: 1 Group: advanced

Parameters:

idleTaskExecutionLimit - the value to set

Returns:

the dsl builder

includeAllJMSXProperties

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

includeAllJMSXProperties

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder includeAllJMSXProperties(String 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 will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

jmsKeyFormatStrategy

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder jmsKeyFormatStrategy(Object 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: <code>org.apache.camel.component.jms.JmsKeyFormatStrategy</code> type. Group: advanced

Parameters:

jmsKeyFormatStrategy - the value to set

Returns:

the dsl builder

jmsKeyFormatStrategy

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder jmsKeyFormatStrategy(String 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 will be converted to a <code>org.apache.camel.component.jms.JmsKeyFormatStrategy</code> type. Group: advanced

Parameters:

jmsKeyFormatStrategy - the value to set

Returns:

the dsl builder

mapJmsMessage

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

mapJmsMessage

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder mapJmsMessage(String 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 will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

maxMessagesPerTask

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>int</code> type. Default: -1 Group: advanced

Parameters:

maxMessagesPerTask - the value to set

Returns:

the dsl builder

maxMessagesPerTask

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder maxMessagesPerTask(String 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 will be converted to a <code>int</code> type. Default: -1 Group: advanced

Parameters:

maxMessagesPerTask - the value to set

Returns:

the dsl builder

messageConverter

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageConverter(Object 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: <code>org.springframework.jms.support.converter.MessageConverter</code> type. Group: advanced

Parameters:

messageConverter - the value to set

Returns:

the dsl builder

messageConverter

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageConverter(String 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 will be converted to a <code>org.springframework.jms.support.converter.MessageConverter</code> type. Group: advanced

Parameters:

messageConverter - the value to set

Returns:

the dsl builder

messageCreatedStrategy

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageCreatedStrategy(Object 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: <code>org.apache.camel.component.jms.MessageCreatedStrategy</code> type. Group: advanced

Parameters:

messageCreatedStrategy - the value to set

Returns:

the dsl builder

messageCreatedStrategy

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageCreatedStrategy(String 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 will be converted to a <code>org.apache.camel.component.jms.MessageCreatedStrategy</code> type. Group: advanced

Parameters:

messageCreatedStrategy - the value to set

Returns:

the dsl builder

messageIdEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: true Group: advanced

Parameters:

messageIdEnabled - the value to set

Returns:

the dsl builder

messageIdEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageIdEnabled(String 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 will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

messageIdEnabled - the value to set

Returns:

the dsl builder

messageListenerContainerFactory

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageListenerContainerFactory(Object 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: <code>org.apache.camel.component.jms.MessageListenerContainerFactory</code> type. Group: advanced

Parameters:

messageListenerContainerFactory - the value to set

Returns:

the dsl builder

messageListenerContainerFactory

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageListenerContainerFactory(String 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 will be converted to a <code>org.apache.camel.component.jms.MessageListenerContainerFactory</code> type. Group: advanced

Parameters:

messageListenerContainerFactory - the value to set

Returns:

the dsl builder

messageTimestampEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: true Group: advanced

Parameters:

messageTimestampEnabled - the value to set

Returns:

the dsl builder

messageTimestampEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder messageTimestampEnabled(String 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 will be converted to a <code>boolean</code> type. Default: true Group: advanced

Parameters:

messageTimestampEnabled - the value to set

Returns:

the dsl builder

pubSubNoLocal

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder pubSubNoLocal(boolean pubSubNoLocal)

Specifies whether to inhibit the delivery of messages published by its own connection. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

pubSubNoLocal - the value to set

Returns:

the dsl builder

pubSubNoLocal

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder pubSubNoLocal(String pubSubNoLocal)

Specifies whether to inhibit the delivery of messages published by its own connection. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

pubSubNoLocal - the value to set

Returns:

the dsl builder

receiveTimeout

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder receiveTimeout(long receiveTimeout)

The timeout for receiving messages (in milliseconds). The option is a: <code>long</code> type. Default: 1000 Group: advanced

Parameters:

receiveTimeout - the value to set

Returns:

the dsl builder

receiveTimeout

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder receiveTimeout(String receiveTimeout)

The timeout for receiving messages (in milliseconds). The option will be converted to a <code>long</code> type. Default: 1000 Group: advanced

Parameters:

receiveTimeout - the value to set

Returns:

the dsl builder

recoveryInterval

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>long</code> type. Default: 5000 Group: advanced

Parameters:

recoveryInterval - the value to set

Returns:

the dsl builder

recoveryInterval

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder recoveryInterval(String 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 will be converted to a <code>long</code> type. Default: 5000 Group: advanced

Parameters:

recoveryInterval - the value to set

Returns:

the dsl builder

requestTimeoutCheckerInterval

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>long</code> type. Default: 1000 Group: advanced

Parameters:

requestTimeoutCheckerInterval - the value to set

Returns:

the dsl builder

requestTimeoutCheckerInterval

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder requestTimeoutCheckerInterval(String 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 will be converted to a <code>long</code> type. Default: 1000 Group: advanced

Parameters:

requestTimeoutCheckerInterval - the value to set

Returns:

the dsl builder

synchronous

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

synchronous - the value to set

Returns:

the dsl builder

transferException

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

transferException - the value to set

Returns:

the dsl builder

transferException

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder transferException(String 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 will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

transferException - the value to set

Returns:

the dsl builder

transferExchange

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced

Parameters:

transferExchange - the value to set

Returns:

the dsl builder

transferExchange

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder transferExchange(String 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 will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

transferExchange - the value to set

Returns:

the dsl builder

useMessageIDAsCorrelationID

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder useMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)

Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

useMessageIDAsCorrelationID - the value to set

Returns:

the dsl builder

useMessageIDAsCorrelationID

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder useMessageIDAsCorrelationID(String useMessageIDAsCorrelationID)

Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Parameters:

useMessageIDAsCorrelationID - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedCounter

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder 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: <code>int</code> type. Default: 50 Group: advanced

Parameters:

waitForProvisionCorrelationToBeUpdatedCounter - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedCounter

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder waitForProvisionCorrelationToBeUpdatedCounter(String 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 will be converted to a <code>int</code> type. Default: 50 Group: advanced

Parameters:

waitForProvisionCorrelationToBeUpdatedCounter - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)

Interval in millis to sleep each time while waiting for provisional correlation id to be updated. The option is a: <code>long</code> type. Default: 100 Group: advanced

Parameters:

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(String waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)

Interval in millis to sleep each time while waiting for provisional correlation id to be updated. The option will be converted to a <code>long</code> type. Default: 100 Group: advanced

Parameters:

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime - the value to set

Returns:

the dsl builder

lazyCreateTransactionManager

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder lazyCreateTransactionManager(boolean lazyCreateTransactionManager)

If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true. The option is a: <code>boolean</code> type. Default: true Group: transaction (advanced)

Parameters:

lazyCreateTransactionManager - the value to set

Returns:

the dsl builder

lazyCreateTransactionManager

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder lazyCreateTransactionManager(String lazyCreateTransactionManager)

If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true. The option will be converted to a <code>boolean</code> type. Default: true Group: transaction (advanced)

Parameters:

lazyCreateTransactionManager - the value to set

Returns:

the dsl builder

transactionManager

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder transactionManager(Object transactionManager)

The Spring transaction manager to use. The option is a: <code>org.springframework.transaction.PlatformTransactionManager</code> type. Group: transaction (advanced)

Parameters:

transactionManager - the value to set

Returns:

the dsl builder

transactionManager

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder transactionManager(String transactionManager)

The Spring transaction manager to use. The option will be converted to a <code>org.springframework.transaction.PlatformTransactionManager</code> type. Group: transaction (advanced)

Parameters:

transactionManager - the value to set

Returns:

the dsl builder

transactionName

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder transactionName(String transactionName)

The name of the transaction to use. The option is a: <code>java.lang.String</code> type. Group: transaction (advanced)

Parameters:

transactionName - the value to set

Returns:

the dsl builder

transactionTimeout

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder transactionTimeout(int transactionTimeout)

The timeout value of the transaction (in seconds), if using transacted mode. The option is a: <code>int</code> type. Default: -1 Group: transaction (advanced)

Parameters:

transactionTimeout - the value to set

Returns:

the dsl builder

transactionTimeout

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder transactionTimeout(String transactionTimeout)

The timeout value of the transaction (in seconds), if using transacted mode. The option will be converted to a <code>int</code> type. Default: -1 Group: transaction (advanced)

Parameters:

transactionTimeout - the value to set

Returns:

the dsl builder