Interface JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
,org.apache.camel.builder.EndpointProducerBuilder
,org.apache.camel.EndpointProducerResolver
,JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
,JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Enclosing interface:
- JmsEndpointBuilderFactory
public static interface JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder extends JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder, JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
Advanced builder for endpoint for the JMS component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
allowSerializedHeaders(boolean allowSerializedHeaders)
Controls whether or not to include serialized headers.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
allowSerializedHeaders(String allowSerializedHeaders)
Controls whether or not to include serialized headers.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
artemisStreamingEnabled(boolean artemisStreamingEnabled)
Whether optimizing for Apache Artemis streaming mode.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
artemisStreamingEnabled(String artemisStreamingEnabled)
Whether optimizing for Apache Artemis streaming mode.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
asyncStartListener(boolean asyncStartListener)
Whether to startup the JmsConsumer message listener asynchronously, when starting a route.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
asyncStartListener(String asyncStartListener)
Whether to startup the JmsConsumer message listener asynchronously, when starting a route.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
asyncStopListener(boolean asyncStopListener)
Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
asyncStopListener(String asyncStopListener)
Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.default JmsEndpointBuilderFactory.JmsEndpointBuilder
basic()
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
destinationResolver(org.springframework.jms.support.destination.DestinationResolver destinationResolver)
A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry).default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
errorHandler(org.springframework.util.ErrorHandler errorHandler)
Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
exceptionListener(String exceptionListener)
Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
exceptionListener(javax.jms.ExceptionListener exceptionListener)
Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
headerFilterStrategy(String headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)
To use a custom HeaderFilterStrategy to filter header to and from Camel message.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
idleConsumerLimit(int idleConsumerLimit)
Specify the limit for the number of consumers that are allowed to be idle at any given time.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
idleConsumerLimit(String idleConsumerLimit)
Specify the limit for the number of consumers that are allowed to be idle at any given time.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
idleTaskExecutionLimit(int idleTaskExecutionLimit)
Specifies the limit for idle executions of a receive task, not having received any message within its execution.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
idleTaskExecutionLimit(String idleTaskExecutionLimit)
Specifies the limit for idle executions of a receive task, not having received any message within its execution.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
includeAllJMSXProperties(boolean includeAllJMSXProperties)
Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
includeAllJMSXProperties(String includeAllJMSXProperties)
Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
jmsKeyFormatStrategy(String jmsKeyFormatStrategy)
Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
jmsKeyFormatStrategy(org.apache.camel.component.jms.JmsKeyFormatStrategy jmsKeyFormatStrategy)
Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
lazyCreateTransactionManager(boolean lazyCreateTransactionManager)
If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
lazyCreateTransactionManager(String lazyCreateTransactionManager)
If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
maxMessagesPerTask(int maxMessagesPerTask)
The number of messages per task.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
maxMessagesPerTask(String maxMessagesPerTask)
The number of messages per task.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
messageConverter(org.springframework.jms.support.converter.MessageConverter messageConverter)
To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
messageCreatedStrategy(org.apache.camel.component.jms.MessageCreatedStrategy messageCreatedStrategy)
To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
messageIdEnabled(boolean messageIdEnabled)
When sending, specifies whether message IDs should be added.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
messageIdEnabled(String messageIdEnabled)
When sending, specifies whether message IDs should be added.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
messageListenerContainerFactory(String messageListenerContainerFactory)
Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
messageListenerContainerFactory(org.apache.camel.component.jms.MessageListenerContainerFactory messageListenerContainerFactory)
Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
messageTimestampEnabled(boolean messageTimestampEnabled)
Specifies whether timestamps should be enabled by default on sending messages.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
messageTimestampEnabled(String messageTimestampEnabled)
Specifies whether timestamps should be enabled by default on sending messages.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
pubSubNoLocal(boolean pubSubNoLocal)
Specifies whether to inhibit the delivery of messages published by its own connection.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
pubSubNoLocal(String pubSubNoLocal)
Specifies whether to inhibit the delivery of messages published by its own connection.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
receiveTimeout(long receiveTimeout)
The timeout for receiving messages (in milliseconds).default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
receiveTimeout(String receiveTimeout)
The timeout for receiving messages (in milliseconds).default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
recoveryInterval(long recoveryInterval)
Specifies the interval between recovery attempts, i.e.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
recoveryInterval(String recoveryInterval)
Specifies the interval between recovery attempts, i.e.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval)
Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
requestTimeoutCheckerInterval(String requestTimeoutCheckerInterval)
Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
synchronous(boolean synchronous)
Sets whether synchronous processing should be strictly used.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
synchronous(String synchronous)
Sets whether synchronous processing should be strictly used.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
transactionManager(String transactionManager)
The Spring transaction manager to use.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
The Spring transaction manager to use.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
transactionName(String transactionName)
The name of the transaction to use.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
transactionTimeout(int transactionTimeout)
The timeout value of the transaction (in seconds), if using transacted mode.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
transactionTimeout(String transactionTimeout)
The timeout value of the transaction (in seconds), if using transacted mode.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
transferExchange(boolean transferExchange)
You can transfer the exchange over the wire instead of just the body and headers.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
transferExchange(String transferExchange)
You can transfer the exchange over the wire instead of just the body and headers.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
useMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)
Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
useMessageIDAsCorrelationID(String useMessageIDAsCorrelationID)
Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
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.AdvancedJmsEndpointBuilder
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)
Interval in millis to sleep each time while waiting for provisional correlation id to be updated.default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder
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, expr, getRawUri, getUri
-
Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
acceptMessagesWhileStopping, acceptMessagesWhileStopping, allowReplyManagerQuickStop, allowReplyManagerQuickStop, consumerType, consumerType, defaultTaskExecutorType, defaultTaskExecutorType, eagerLoadingOfProperties, eagerLoadingOfProperties, eagerPoisonBody, exceptionHandler, exceptionHandler, exchangePattern, exchangePattern, exposeListenerSession, exposeListenerSession, replyToConsumerType, replyToConsumerType, replyToSameDestinationAllowed, replyToSameDestinationAllowed, taskExecutor, taskExecutor
-
Methods inherited from interface org.apache.camel.builder.endpoint.dsl.JmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
allowAdditionalHeaders, allowNullBody, allowNullBody, alwaysCopyMessage, alwaysCopyMessage, correlationProperty, disableTimeToLive, disableTimeToLive, forceSendOriginalMessage, forceSendOriginalMessage, includeSentJMSMessageID, includeSentJMSMessageID, lazyStartProducer, lazyStartProducer, replyToCacheLevelName, replyToDestinationSelectorName, streamMessageTypeEnabled, streamMessageTypeEnabled
-
-
-
-
Method Detail
-
basic
default JmsEndpointBuilderFactory.JmsEndpointBuilder basic()
- Specified by:
basic
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
basic
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
-
allowSerializedHeaders
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
allowSerializedHeaders
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
allowSerializedHeaders
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
allowSerializedHeaders
- the value to set- Returns:
- the dsl builder
-
allowSerializedHeaders
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
allowSerializedHeaders
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
allowSerializedHeaders
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
allowSerializedHeaders
- the value to set- Returns:
- the dsl builder
-
artemisStreamingEnabled
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder artemisStreamingEnabled(boolean artemisStreamingEnabled)
Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used. The option is a: <code>boolean</code> type. Default: false Group: advanced- Specified by:
artemisStreamingEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
artemisStreamingEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
artemisStreamingEnabled
- the value to set- Returns:
- the dsl builder
-
artemisStreamingEnabled
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder artemisStreamingEnabled(String artemisStreamingEnabled)
Whether optimizing for Apache Artemis streaming mode. This can reduce memory overhead when using Artemis with JMS StreamMessage types. This option must only be enabled if Apache Artemis is being used. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced- Specified by:
artemisStreamingEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
artemisStreamingEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
artemisStreamingEnabled
- the value to set- Returns:
- the dsl builder
-
asyncStartListener
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
asyncStartListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
asyncStartListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
asyncStartListener
- the value to set- Returns:
- the dsl builder
-
asyncStartListener
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
asyncStartListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
asyncStartListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
asyncStartListener
- the value to set- Returns:
- the dsl builder
-
asyncStopListener
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
asyncStopListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
asyncStopListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
asyncStopListener
- the value to set- Returns:
- the dsl builder
-
asyncStopListener
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
asyncStopListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
asyncStopListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
asyncStopListener
- the value to set- Returns:
- the dsl builder
-
destinationResolver
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder destinationResolver(org.springframework.jms.support.destination.DestinationResolver destinationResolver)
A pluggable org.springframework.jms.support.destination.DestinationResolver that allows you to use your own resolver (for example, to lookup the real destination in a JNDI registry). The option is a: <code>org.springframework.jms.support.destination.DestinationResolver</code> type. Group: advanced- Specified by:
destinationResolver
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
destinationResolver
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
destinationResolver
- the value to set- Returns:
- the dsl builder
-
destinationResolver
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
destinationResolver
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
destinationResolver
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
destinationResolver
- the value to set- Returns:
- the dsl builder
-
errorHandler
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder errorHandler(org.springframework.util.ErrorHandler errorHandler)
Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message. By default these exceptions will be logged at the WARN level, if no errorHandler has been configured. You can configure logging level and whether stack traces should be logged using errorHandlerLoggingLevel and errorHandlerLogStackTrace options. This makes it much easier to configure, than having to code a custom errorHandler. The option is a: <code>org.springframework.util.ErrorHandler</code> type. Group: advanced- Specified by:
errorHandler
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
errorHandler
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
errorHandler
- the value to set- Returns:
- the dsl builder
-
errorHandler
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
errorHandler
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
errorHandler
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
errorHandler
- the value to set- Returns:
- the dsl builder
-
exceptionListener
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder exceptionListener(javax.jms.ExceptionListener 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- Specified by:
exceptionListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
exceptionListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
exceptionListener
- the value to set- Returns:
- the dsl builder
-
exceptionListener
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
exceptionListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
exceptionListener
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
exceptionListener
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
headerFilterStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
headerFilterStrategy
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
headerFilterStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
headerFilterStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
headerFilterStrategy
- the value to set- Returns:
- the dsl builder
-
idleConsumerLimit
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
idleConsumerLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
idleConsumerLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
idleConsumerLimit
- the value to set- Returns:
- the dsl builder
-
idleConsumerLimit
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
idleConsumerLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
idleConsumerLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
idleConsumerLimit
- the value to set- Returns:
- the dsl builder
-
idleTaskExecutionLimit
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
idleTaskExecutionLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
idleTaskExecutionLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
idleTaskExecutionLimit
- the value to set- Returns:
- the dsl builder
-
idleTaskExecutionLimit
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
idleTaskExecutionLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
idleTaskExecutionLimit
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
idleTaskExecutionLimit
- the value to set- Returns:
- the dsl builder
-
includeAllJMSXProperties
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
includeAllJMSXProperties
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
includeAllJMSXProperties
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
includeAllJMSXProperties
- the value to set- Returns:
- the dsl builder
-
includeAllJMSXProperties
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
includeAllJMSXProperties
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
includeAllJMSXProperties
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
includeAllJMSXProperties
- the value to set- Returns:
- the dsl builder
-
jmsKeyFormatStrategy
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder jmsKeyFormatStrategy(org.apache.camel.component.jms.JmsKeyFormatStrategy jmsKeyFormatStrategy)
Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification. Camel provides two implementations out of the box: default and passthrough. The default strategy will safely marshal dots and hyphens (. and -). The passthrough strategy leaves the key as is. Can be used for JMS brokers which do not care whether JMS header keys contain illegal characters. You can provide your own implementation of the org.apache.camel.component.jms.JmsKeyFormatStrategy and refer to it using the # notation. The option is a: <code>org.apache.camel.component.jms.JmsKeyFormatStrategy</code> type. Group: advanced- Specified by:
jmsKeyFormatStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
jmsKeyFormatStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
jmsKeyFormatStrategy
- the value to set- Returns:
- the dsl builder
-
jmsKeyFormatStrategy
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
jmsKeyFormatStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
jmsKeyFormatStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
jmsKeyFormatStrategy
- the value to set- Returns:
- the dsl builder
-
mapJmsMessage
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
mapJmsMessage
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
mapJmsMessage
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
mapJmsMessage
- the value to set- Returns:
- the dsl builder
-
mapJmsMessage
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
mapJmsMessage
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
mapJmsMessage
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
mapJmsMessage
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerTask
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
maxMessagesPerTask
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
maxMessagesPerTask
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
maxMessagesPerTask
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerTask
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
maxMessagesPerTask
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
maxMessagesPerTask
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
maxMessagesPerTask
- the value to set- Returns:
- the dsl builder
-
messageConverter
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder messageConverter(org.springframework.jms.support.converter.MessageConverter messageConverter)
To use a custom Spring org.springframework.jms.support.converter.MessageConverter so you can be in control how to map to/from a javax.jms.Message. The option is a: <code>org.springframework.jms.support.converter.MessageConverter</code> type. Group: advanced- Specified by:
messageConverter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageConverter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageConverter
- the value to set- Returns:
- the dsl builder
-
messageConverter
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
messageConverter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageConverter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageConverter
- the value to set- Returns:
- the dsl builder
-
messageCreatedStrategy
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder messageCreatedStrategy(org.apache.camel.component.jms.MessageCreatedStrategy messageCreatedStrategy)
To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of javax.jms.Message objects when Camel is sending a JMS message. The option is a: <code>org.apache.camel.component.jms.MessageCreatedStrategy</code> type. Group: advanced- Specified by:
messageCreatedStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageCreatedStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageCreatedStrategy
- the value to set- Returns:
- the dsl builder
-
messageCreatedStrategy
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
messageCreatedStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageCreatedStrategy
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageCreatedStrategy
- the value to set- Returns:
- the dsl builder
-
messageIdEnabled
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
messageIdEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageIdEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageIdEnabled
- the value to set- Returns:
- the dsl builder
-
messageIdEnabled
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
messageIdEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageIdEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageIdEnabled
- the value to set- Returns:
- the dsl builder
-
messageListenerContainerFactory
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder messageListenerContainerFactory(org.apache.camel.component.jms.MessageListenerContainerFactory messageListenerContainerFactory)
Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages. Setting this will automatically set consumerType to Custom. The option is a: <code>org.apache.camel.component.jms.MessageListenerContainerFactory</code> type. Group: advanced- Specified by:
messageListenerContainerFactory
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageListenerContainerFactory
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageListenerContainerFactory
- the value to set- Returns:
- the dsl builder
-
messageListenerContainerFactory
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
messageListenerContainerFactory
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageListenerContainerFactory
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageListenerContainerFactory
- the value to set- Returns:
- the dsl builder
-
messageTimestampEnabled
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
messageTimestampEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageTimestampEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageTimestampEnabled
- the value to set- Returns:
- the dsl builder
-
messageTimestampEnabled
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
messageTimestampEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
messageTimestampEnabled
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
messageTimestampEnabled
- the value to set- Returns:
- the dsl builder
-
pubSubNoLocal
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
pubSubNoLocal
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
pubSubNoLocal
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
pubSubNoLocal
- the value to set- Returns:
- the dsl builder
-
pubSubNoLocal
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
pubSubNoLocal
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
pubSubNoLocal
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
pubSubNoLocal
- the value to set- Returns:
- the dsl builder
-
receiveTimeout
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder receiveTimeout(long receiveTimeout)
The timeout for receiving messages (in milliseconds). The option is a: <code>long</code> type. Default: 1000 Group: advanced- Specified by:
receiveTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
receiveTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
receiveTimeout
- the value to set- Returns:
- the dsl builder
-
receiveTimeout
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
receiveTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
receiveTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
receiveTimeout
- the value to set- Returns:
- the dsl builder
-
recoveryInterval
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
recoveryInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
recoveryInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
recoveryInterval
- the value to set- Returns:
- the dsl builder
-
recoveryInterval
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
recoveryInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
recoveryInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
recoveryInterval
- the value to set- Returns:
- the dsl builder
-
requestTimeoutCheckerInterval
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
requestTimeoutCheckerInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
requestTimeoutCheckerInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
requestTimeoutCheckerInterval
- the value to set- Returns:
- the dsl builder
-
requestTimeoutCheckerInterval
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
requestTimeoutCheckerInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
requestTimeoutCheckerInterval
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
requestTimeoutCheckerInterval
- the value to set- Returns:
- the dsl builder
-
synchronous
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder synchronous(boolean synchronous)
Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced- Specified by:
synchronous
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
synchronous
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
synchronous
- the value to set- Returns:
- the dsl builder
-
synchronous
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
synchronous
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
synchronous
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
synchronous
- the value to set- Returns:
- the dsl builder
-
transferException
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
transferException
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transferException
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
transferException
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
transferException
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transferException
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transferException
- the value to set- Returns:
- the dsl builder
-
transferExchange
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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 receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!. The option is a: <code>boolean</code> type. Default: false Group: advanced- Specified by:
transferExchange
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transferExchange
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transferExchange
- the value to set- Returns:
- the dsl builder
-
transferExchange
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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 receiver to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumers having to use compatible Camel versions!. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced- Specified by:
transferExchange
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transferExchange
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transferExchange
- the value to set- Returns:
- the dsl builder
-
useMessageIDAsCorrelationID
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
useMessageIDAsCorrelationID
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
useMessageIDAsCorrelationID
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
useMessageIDAsCorrelationID
- the value to set- Returns:
- the dsl builder
-
useMessageIDAsCorrelationID
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
useMessageIDAsCorrelationID
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
useMessageIDAsCorrelationID
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
useMessageIDAsCorrelationID
- the value to set- Returns:
- the dsl builder
-
waitForProvisionCorrelationToBeUpdatedCounter
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
waitForProvisionCorrelationToBeUpdatedCounter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
waitForProvisionCorrelationToBeUpdatedCounter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
waitForProvisionCorrelationToBeUpdatedCounter
- the value to set- Returns:
- the dsl builder
-
waitForProvisionCorrelationToBeUpdatedCounter
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
waitForProvisionCorrelationToBeUpdatedCounter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
waitForProvisionCorrelationToBeUpdatedCounter
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
waitForProvisionCorrelationToBeUpdatedCounter
- the value to set- Returns:
- the dsl builder
-
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
- the value to set- Returns:
- the dsl builder
-
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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- Specified by:
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
waitForProvisionCorrelationToBeUpdatedThreadSleepingTime
- the value to set- Returns:
- the dsl builder
-
lazyCreateTransactionManager
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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)- Specified by:
lazyCreateTransactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
lazyCreateTransactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
lazyCreateTransactionManager
- the value to set- Returns:
- the dsl builder
-
lazyCreateTransactionManager
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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)- Specified by:
lazyCreateTransactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
lazyCreateTransactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
lazyCreateTransactionManager
- the value to set- Returns:
- the dsl builder
-
transactionManager
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)
The Spring transaction manager to use. The option is a: <code>org.springframework.transaction.PlatformTransactionManager</code> type. Group: transaction (advanced)- Specified by:
transactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transactionManager
- the value to set- Returns:
- the dsl builder
-
transactionManager
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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)- Specified by:
transactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transactionManager
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transactionManager
- the value to set- Returns:
- the dsl builder
-
transactionName
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder transactionName(String transactionName)
The name of the transaction to use. The option is a: <code>java.lang.String</code> type. Group: transaction (advanced)- Specified by:
transactionName
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transactionName
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transactionName
- the value to set- Returns:
- the dsl builder
-
transactionTimeout
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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)- Specified by:
transactionTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transactionTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transactionTimeout
- the value to set- Returns:
- the dsl builder
-
transactionTimeout
default JmsEndpointBuilderFactory.AdvancedJmsEndpointBuilder 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)- Specified by:
transactionTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder
- Specified by:
transactionTimeout
in interfaceJmsEndpointBuilderFactory.AdvancedJmsEndpointProducerBuilder
- Parameters:
transactionTimeout
- the value to set- Returns:
- the dsl builder
-
-