org.apache.camel.builder.endpoint.dsl

Interface JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder

Enclosing interface:

JmsEndpointBuilderFactory

public static interface JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Advanced builder for endpoint producers for the JMS component.

Method Summary

Modifier and Type	Method and Description
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	allowAdditionalHeaders(String allowAdditionalHeaders) This option is used to allow additional headers which may have values that are invalid according to JMS specification.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	allowNullBody(boolean allowNullBody) Whether to allow sending messages with no body.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	allowNullBody(String allowNullBody) Whether to allow sending messages with no body.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	allowSerializedHeaders(boolean allowSerializedHeaders) Controls whether or not to include serialized headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	allowSerializedHeaders(String allowSerializedHeaders) Controls whether or not to include serialized headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	alwaysCopyMessage(boolean alwaysCopyMessage) If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	alwaysCopyMessage(String alwaysCopyMessage) If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	artemisStreamingEnabled(boolean artemisStreamingEnabled) Whether optimizing for Apache Artemis streaming mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	artemisStreamingEnabled(String artemisStreamingEnabled) Whether optimizing for Apache Artemis streaming mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	asyncStartListener(boolean asyncStartListener) Whether to startup the JmsConsumer message listener asynchronously, when starting a route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	asyncStartListener(String asyncStartListener) Whether to startup the JmsConsumer message listener asynchronously, when starting a route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	asyncStopListener(boolean asyncStopListener) Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	asyncStopListener(String asyncStopListener) Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
default JmsEndpointBuilderFactory.JmsEndpointProducerBuilder	basic()
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	correlationProperty(String correlationProperty) When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	disableTimeToLive(boolean disableTimeToLive) Use this option to force disabling time to live.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	disableTimeToLive(String disableTimeToLive) Use this option to force disabling time to live.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	exceptionListener(Object exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	exceptionListener(String exceptionListener) Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	forceSendOriginalMessage(boolean forceSendOriginalMessage) When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	forceSendOriginalMessage(String forceSendOriginalMessage) When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	headerFilterStrategy(String headerFilterStrategy) To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	idleConsumerLimit(int idleConsumerLimit) Specify the limit for the number of consumers that are allowed to be idle at any given time.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	idleConsumerLimit(String idleConsumerLimit) Specify the limit for the number of consumers that are allowed to be idle at any given time.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	idleTaskExecutionLimit(int idleTaskExecutionLimit) Specifies the limit for idle executions of a receive task, not having received any message within its execution.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	idleTaskExecutionLimit(String idleTaskExecutionLimit) Specifies the limit for idle executions of a receive task, not having received any message within its execution.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	includeAllJMSXProperties(boolean includeAllJMSXProperties) Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	includeAllJMSXProperties(String includeAllJMSXProperties) Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	includeSentJMSMessageID(boolean includeSentJMSMessageID) Only applicable when sending to JMS destination using InOnly (eg fire and forget).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	includeSentJMSMessageID(String includeSentJMSMessageID) Only applicable when sending to JMS destination using InOnly (eg fire and forget).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	jmsKeyFormatStrategy(Object jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	jmsKeyFormatStrategy(String jmsKeyFormatStrategy) Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	lazyCreateTransactionManager(boolean lazyCreateTransactionManager) If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	lazyCreateTransactionManager(String lazyCreateTransactionManager) If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	maxMessagesPerTask(int maxMessagesPerTask) The number of messages per task.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	maxMessagesPerTask(String maxMessagesPerTask) The number of messages per task.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	messageIdEnabled(boolean messageIdEnabled) When sending, specifies whether message IDs should be added.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	messageIdEnabled(String messageIdEnabled) When sending, specifies whether message IDs should be added.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	messageListenerContainerFactory(Object messageListenerContainerFactory) Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	messageListenerContainerFactory(String messageListenerContainerFactory) Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	messageTimestampEnabled(boolean messageTimestampEnabled) Specifies whether timestamps should be enabled by default on sending messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	messageTimestampEnabled(String messageTimestampEnabled) Specifies whether timestamps should be enabled by default on sending messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	pubSubNoLocal(boolean pubSubNoLocal) Specifies whether to inhibit the delivery of messages published by its own connection.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	pubSubNoLocal(String pubSubNoLocal) Specifies whether to inhibit the delivery of messages published by its own connection.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	receiveTimeout(long receiveTimeout) The timeout for receiving messages (in milliseconds).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	receiveTimeout(String receiveTimeout) The timeout for receiving messages (in milliseconds).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	recoveryInterval(long recoveryInterval) Specifies the interval between recovery attempts, i.e.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	recoveryInterval(String recoveryInterval) Specifies the interval between recovery attempts, i.e.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	replyToCacheLevelName(String replyToCacheLevelName) Sets the cache level by name for the reply consumer when doing request/reply over JMS.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	replyToDestinationSelectorName(String replyToDestinationSelectorName) Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue).
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval) Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	requestTimeoutCheckerInterval(String requestTimeoutCheckerInterval) Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	streamMessageTypeEnabled(boolean streamMessageTypeEnabled) Sets whether StreamMessage type is enabled or not.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	streamMessageTypeEnabled(String streamMessageTypeEnabled) Sets whether StreamMessage type is enabled or not.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	synchronous(boolean synchronous) Sets whether synchronous processing should be strictly used.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	synchronous(String synchronous) Sets whether synchronous processing should be strictly used.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	transactionManager(Object transactionManager) The Spring transaction manager to use.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	transactionManager(String transactionManager) The Spring transaction manager to use.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	transactionName(String transactionName) The name of the transaction to use.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	transactionTimeout(int transactionTimeout) The timeout value of the transaction (in seconds), if using transacted mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	transactionTimeout(String transactionTimeout) The timeout value of the transaction (in seconds), if using transacted mode.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	transferExchange(boolean transferExchange) You can transfer the exchange over the wire instead of just the body and headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	transferExchange(String transferExchange) You can transfer the exchange over the wire instead of just the body and headers.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	useMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID) Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	useMessageIDAsCorrelationID(String useMessageIDAsCorrelationID) Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	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.AdvancedJmsEndpointProducerBuilder	waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime) Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder	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.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

basic

default JmsEndpointBuilderFactory.JmsEndpointProducerBuilder basic()

allowAdditionalHeaders

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder allowAdditionalHeaders(String allowAdditionalHeaders)

This option is used to allow additional headers which may have values that are invalid according to JMS specification. For example some message systems such as WMQ do this with header names using prefix JMS_IBM_MQMD_ containing values with byte array or other invalid types. You can specify multiple header names separated by comma, and use as suffix for wildcard matching. The option is a: <code>java.lang.String</code> type. Group: producer (advanced)

Parameters:

allowAdditionalHeaders - the value to set

Returns:

the dsl builder

allowNullBody

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder allowNullBody(boolean allowNullBody)

Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown. The option is a: <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

allowNullBody - the value to set

Returns:

the dsl builder

allowNullBody

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder allowNullBody(String allowNullBody)

Whether to allow sending messages with no body. If this option is false and the message body is null, then an JMSException is thrown. The option will be converted to a <code>boolean</code> type. Default: true Group: producer (advanced)

Parameters:

allowNullBody - the value to set

Returns:

the dsl builder

alwaysCopyMessage

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder alwaysCopyMessage(boolean alwaysCopyMessage)

If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set). The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

alwaysCopyMessage - the value to set

Returns:

the dsl builder

alwaysCopyMessage

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder alwaysCopyMessage(String alwaysCopyMessage)

If true, Camel will always make a JMS message copy of the message when it is passed to the producer for sending. Copying the message is needed in some situations, such as when a replyToDestinationSelectorName is set (incidentally, Camel will set the alwaysCopyMessage option to true, if a replyToDestinationSelectorName is set). The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

alwaysCopyMessage - the value to set

Returns:

the dsl builder

correlationProperty

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder correlationProperty(String correlationProperty)

When using InOut exchange pattern use this JMS property instead of JMSCorrelationID JMS property to correlate messages. If set messages will be correlated solely on the value of this property JMSCorrelationID property will be ignored and not set by Camel. The option is a: <code>java.lang.String</code> type. Group: producer (advanced)

Parameters:

correlationProperty - the value to set

Returns:

the dsl builder

disableTimeToLive

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder disableTimeToLive(boolean disableTimeToLive)

Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

disableTimeToLive - the value to set

Returns:

the dsl builder

disableTimeToLive

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder disableTimeToLive(String disableTimeToLive)

Use this option to force disabling time to live. For example when you do request/reply over JMS, then Camel will by default use the requestTimeout value as time to live on the message being sent. The problem is that the sender and receiver systems have to have their clocks synchronized, so they are in sync. This is not always so easy to archive. So you can use disableTimeToLive=true to not set a time to live value on the sent message. Then the message will not expire on the receiver system. See below in section About time to live for more details. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

disableTimeToLive - the value to set

Returns:

the dsl builder

forceSendOriginalMessage

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder forceSendOriginalMessage(boolean forceSendOriginalMessage)

When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

forceSendOriginalMessage - the value to set

Returns:

the dsl builder

forceSendOriginalMessage

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder forceSendOriginalMessage(String forceSendOriginalMessage)

When using mapJmsMessage=false Camel will create a new JMS message to send to a new JMS destination if you touch the headers (get or set) during the route. Set this option to true to force Camel to send the original JMS message that was received. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

forceSendOriginalMessage - the value to set

Returns:

the dsl builder

includeSentJMSMessageID

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder includeSentJMSMessageID(boolean includeSentJMSMessageID)

Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

includeSentJMSMessageID - the value to set

Returns:

the dsl builder

includeSentJMSMessageID

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder includeSentJMSMessageID(String includeSentJMSMessageID)

Only applicable when sending to JMS destination using InOnly (eg fire and forget). Enabling this option will enrich the Camel Exchange with the actual JMSMessageID that was used by the JMS client when the message was sent to the JMS destination. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

includeSentJMSMessageID - the value to set

Returns:

the dsl builder

replyToCacheLevelName

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder replyToCacheLevelName(String replyToCacheLevelName)

Sets the cache level by name for the reply consumer when doing request/reply over JMS. This option only applies when using fixed reply queues (not temporary). Camel will by default use: CACHE_CONSUMER for exclusive or shared w/ replyToSelectorName. And CACHE_SESSION for shared without replyToSelectorName. Some JMS brokers such as IBM WebSphere may require to set the replyToCacheLevelName=CACHE_NONE to work. Note: If using temporary queues then CACHE_NONE is not allowed, and you must use a higher value such as CACHE_CONSUMER or CACHE_SESSION. The option is a: <code>java.lang.String</code> type. Group: producer (advanced)

Parameters:

replyToCacheLevelName - the value to set

Returns:

the dsl builder

replyToDestinationSelectorName

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder replyToDestinationSelectorName(String replyToDestinationSelectorName)

Sets the JMS Selector using the fixed name to be used so you can filter out your own replies from the others when using a shared queue (that is, if you are not using a temporary reply queue). The option is a: <code>java.lang.String</code> type. Group: producer (advanced)

Parameters:

replyToDestinationSelectorName - the value to set

Returns:

the dsl builder

streamMessageTypeEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder streamMessageTypeEnabled(boolean streamMessageTypeEnabled)

Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data. The option is a: <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

streamMessageTypeEnabled - the value to set

Returns:

the dsl builder

streamMessageTypeEnabled

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder streamMessageTypeEnabled(String streamMessageTypeEnabled)

Sets whether StreamMessage type is enabled or not. Message payloads of streaming kind such as files, InputStream, etc will either by sent as BytesMessage or StreamMessage. This option controls which kind will be used. By default BytesMessage is used which enforces the entire message payload to be read into memory. By enabling this option the message payload is read into memory in chunks and each chunk is then written to the StreamMessage until no more data. The option will be converted to a <code>boolean</code> type. Default: false Group: producer (advanced)

Parameters:

streamMessageTypeEnabled - the value to set

Returns:

the dsl builder

allowSerializedHeaders

default JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder synchronous(boolean synchronous)

Sets whether synchronous processing should be strictly used. 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.AdvancedJmsEndpointProducerBuilder synchronous(String synchronous)

Sets whether synchronous processing should be strictly used. 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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.AdvancedJmsEndpointProducerBuilder 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