Package org.apache.camel.builder.endpoint.dsl

Interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder

All Superinterfaces:

ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder, ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

ActiveMQEndpointBuilderFactory

public static interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder
extends ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder, ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Advanced builder for endpoint for the ActiveMQ component.

Method Summary

Modifier and Type	Method	Description
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	allowSerializedHeaders(boolean allowSerializedHeaders)	Controls whether or not to include serialized headers.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	allowSerializedHeaders(String allowSerializedHeaders)	Controls whether or not to include serialized headers.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	artemisStreamingEnabled(boolean artemisStreamingEnabled)	Whether optimizing for Apache Artemis streaming mode.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	artemisStreamingEnabled(String artemisStreamingEnabled)	Whether optimizing for Apache Artemis streaming mode.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	asyncStartListener(boolean asyncStartListener)	Whether to startup the JmsConsumer message listener asynchronously, when starting a route.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	asyncStartListener(String asyncStartListener)	Whether to startup the JmsConsumer message listener asynchronously, when starting a route.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	asyncStopListener(boolean asyncStopListener)	Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	asyncStopListener(String asyncStopListener)	Whether to stop the JmsConsumer message listener asynchronously, when stopping a route.
default ActiveMQEndpointBuilderFactory.ActiveMQEndpointBuilder	basic()
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	errorHandler(String errorHandler)	Specifies a org.springframework.util.ErrorHandler to be invoked in case of any uncaught exceptions thrown while processing a Message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	exceptionListener(jakarta.jms.ExceptionListener exceptionListener)	Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	exceptionListener(String exceptionListener)	Specifies the JMS Exception Listener that is to be notified of any underlying JMS exceptions.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	headerFilterStrategy(String headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)	To use a custom HeaderFilterStrategy to filter header to and from Camel message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	idleConsumerLimit(int idleConsumerLimit)	Specify the limit for the number of consumers that are allowed to be idle at any given time.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	idleConsumerLimit(String idleConsumerLimit)	Specify the limit for the number of consumers that are allowed to be idle at any given time.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	idleTaskExecutionLimit(int idleTaskExecutionLimit)	Specifies the limit for idle executions of a receive task, not having received any message within its execution.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	idleTaskExecutionLimit(String idleTaskExecutionLimit)	Specifies the limit for idle executions of a receive task, not having received any message within its execution.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	includeAllJMSXProperties(boolean includeAllJMSXProperties)	Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	includeAllJMSXProperties(String includeAllJMSXProperties)	Whether to include all JMSXxxx properties when mapping from JMS to Camel Message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	jmsKeyFormatStrategy(String jmsKeyFormatStrategy)	Pluggable strategy for encoding and decoding JMS keys so they can be compliant with the JMS specification.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	lazyCreateTransactionManager(boolean lazyCreateTransactionManager)	If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	lazyCreateTransactionManager(String lazyCreateTransactionManager)	If true, Camel will create a JmsTransactionManager, if there is no transactionManager injected when option transacted=true.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	mapJmsMessage(boolean mapJmsMessage)	Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	mapJmsMessage(String mapJmsMessage)	Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	maxMessagesPerTask(int maxMessagesPerTask)	The number of messages per task.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	maxMessagesPerTask(String maxMessagesPerTask)	The number of messages per task.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 jakarta.jms.Message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 jakarta.jms.Message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	messageCreatedStrategy(String messageCreatedStrategy)	To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	messageCreatedStrategy(org.apache.camel.component.jms.MessageCreatedStrategy messageCreatedStrategy)	To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	messageIdEnabled(boolean messageIdEnabled)	When sending, specifies whether message IDs should be added.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	messageIdEnabled(String messageIdEnabled)	When sending, specifies whether message IDs should be added.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	messageListenerContainerFactory(String messageListenerContainerFactory)	Registry ID of the MessageListenerContainerFactory used to determine what org.springframework.jms.listener.AbstractMessageListenerContainer to use to consume messages.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	messageTimestampEnabled(boolean messageTimestampEnabled)	Specifies whether timestamps should be enabled by default on sending messages.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	messageTimestampEnabled(String messageTimestampEnabled)	Specifies whether timestamps should be enabled by default on sending messages.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	pubSubNoLocal(boolean pubSubNoLocal)	Specifies whether to inhibit the delivery of messages published by its own connection.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	pubSubNoLocal(String pubSubNoLocal)	Specifies whether to inhibit the delivery of messages published by its own connection.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	receiveTimeout(long receiveTimeout)	The timeout for receiving messages (in milliseconds).
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	receiveTimeout(String receiveTimeout)	The timeout for receiving messages (in milliseconds).
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	recoveryInterval(long recoveryInterval)	Specifies the interval between recovery attempts, i.e.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	recoveryInterval(String recoveryInterval)	Specifies the interval between recovery attempts, i.e.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval)	Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	requestTimeoutCheckerInterval(String requestTimeoutCheckerInterval)	Configures how often Camel should check for timed out Exchanges when doing request/reply over JMS.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	synchronous(boolean synchronous)	Sets whether synchronous processing should be strictly used.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	synchronous(String synchronous)	Sets whether synchronous processing should be strictly used.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	transactionManager(String transactionManager)	The Spring transaction manager to use.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	transactionManager(org.springframework.transaction.PlatformTransactionManager transactionManager)	The Spring transaction manager to use.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	transactionName(String transactionName)	The name of the transaction to use.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	transactionTimeout(int transactionTimeout)	The timeout value of the transaction (in seconds), if using transacted mode.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	transactionTimeout(String transactionTimeout)	The timeout value of the transaction (in seconds), if using transacted mode.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 jakarta.jms.ObjectMessage.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 jakarta.jms.ObjectMessage.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	transferExchange(boolean transferExchange)	You can transfer the exchange over the wire instead of just the body and headers.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	transferExchange(String transferExchange)	You can transfer the exchange over the wire instead of just the body and headers.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	useMessageIDAsCorrelationID(boolean useMessageIDAsCorrelationID)	Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	useMessageIDAsCorrelationID(String useMessageIDAsCorrelationID)	Specifies whether JMSMessageID should always be used as JMSCorrelationID for InOut messages.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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 ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	waitForProvisionCorrelationToBeUpdatedThreadSleepingTime(long waitForProvisionCorrelationToBeUpdatedThreadSleepingTime)	Interval in millis to sleep each time while waiting for provisional correlation id to be updated.
default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder	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.endpoint.dsl.ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

acceptMessagesWhileStopping, acceptMessagesWhileStopping, allowReplyManagerQuickStop, allowReplyManagerQuickStop, consumerType, consumerType, defaultTaskExecutorType, defaultTaskExecutorType, destinationOptions, destinationOptions, 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.ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

allowAdditionalHeaders, allowNullBody, allowNullBody, alwaysCopyMessage, alwaysCopyMessage, correlationProperty, disableTimeToLive, disableTimeToLive, forceSendOriginalMessage, forceSendOriginalMessage, includeSentJMSMessageID, includeSentJMSMessageID, lazyStartProducer, lazyStartProducer, replyToCacheLevelName, replyToDestinationSelectorName, streamMessageTypeEnabled, streamMessageTypeEnabled

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Details

basic

default ActiveMQEndpointBuilderFactory.ActiveMQEndpointBuilder basic()

Specified by:

basic in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

basic in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

allowSerializedHeaders

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

allowSerializedHeaders in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

allowSerializedHeaders - the value to set

Returns:

the dsl builder

allowSerializedHeaders

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

allowSerializedHeaders in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

allowSerializedHeaders - the value to set

Returns:

the dsl builder

artemisStreamingEnabled

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

artemisStreamingEnabled in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

artemisStreamingEnabled - the value to set

Returns:

the dsl builder

artemisStreamingEnabled

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

artemisStreamingEnabled in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

artemisStreamingEnabled - the value to set

Returns:

the dsl builder

asyncStartListener

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

asyncStartListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

asyncStartListener

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

asyncStartListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

asyncStartListener - the value to set

Returns:

the dsl builder

asyncStopListener

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

asyncStopListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

asyncStopListener - the value to set

Returns:

the dsl builder

asyncStopListener

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

asyncStopListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

asyncStopListener - the value to set

Returns:

the dsl builder

destinationResolver

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

destinationResolver in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

destinationResolver - the value to set

Returns:

the dsl builder

destinationResolver

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

destinationResolver in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

destinationResolver - the value to set

Returns:

the dsl builder

errorHandler

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

errorHandler in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

errorHandler - the value to set

Returns:

the dsl builder

errorHandler

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

errorHandler in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

errorHandler - the value to set

Returns:

the dsl builder

exceptionListener

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder exceptionListener(jakarta.jms.ExceptionListener exceptionListener)

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

Specified by:

exceptionListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

exceptionListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

exceptionListener - the value to set

Returns:

the dsl builder

exceptionListener

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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>jakarta.jms.ExceptionListener</code> type. Group: advanced

Specified by:

exceptionListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

exceptionListener in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

exceptionListener - the value to set

Returns:

the dsl builder

headerFilterStrategy

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

headerFilterStrategy

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

headerFilterStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder

idleConsumerLimit

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

idleConsumerLimit in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

idleConsumerLimit - the value to set

Returns:

the dsl builder

idleConsumerLimit

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

idleConsumerLimit in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

idleConsumerLimit - the value to set

Returns:

the dsl builder

idleTaskExecutionLimit

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

idleTaskExecutionLimit in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

idleTaskExecutionLimit - the value to set

Returns:

the dsl builder

idleTaskExecutionLimit

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

idleTaskExecutionLimit in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

idleTaskExecutionLimit - the value to set

Returns:

the dsl builder

includeAllJMSXProperties

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

includeAllJMSXProperties in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

includeAllJMSXProperties

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

includeAllJMSXProperties in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

includeAllJMSXProperties - the value to set

Returns:

the dsl builder

jmsKeyFormatStrategy

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

jmsKeyFormatStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

jmsKeyFormatStrategy - the value to set

Returns:

the dsl builder

jmsKeyFormatStrategy

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

jmsKeyFormatStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

jmsKeyFormatStrategy - the value to set

Returns:

the dsl builder

mapJmsMessage

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder mapJmsMessage(boolean mapJmsMessage)

Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Specified by:

mapJmsMessage in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

mapJmsMessage in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

mapJmsMessage

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder mapJmsMessage(String mapJmsMessage)

Specifies whether Camel should auto map the received JMS message to a suited payload type, such as jakarta.jms.TextMessage to a String etc. The option will be converted to a <code>boolean</code> type. Default: true Group: advanced

Specified by:

mapJmsMessage in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

mapJmsMessage in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

mapJmsMessage - the value to set

Returns:

the dsl builder

maxMessagesPerTask

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

maxMessagesPerTask in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

maxMessagesPerTask - the value to set

Returns:

the dsl builder

maxMessagesPerTask

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

maxMessagesPerTask in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

maxMessagesPerTask - the value to set

Returns:

the dsl builder

messageConverter

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 jakarta.jms.Message. The option is a: <code>org.springframework.jms.support.converter.MessageConverter</code> type. Group: advanced

Specified by:

messageConverter in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageConverter in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageConverter - the value to set

Returns:

the dsl builder

messageConverter

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 jakarta.jms.Message. The option will be converted to a <code>org.springframework.jms.support.converter.MessageConverter</code> type. Group: advanced

Specified by:

messageConverter in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageConverter in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageConverter - the value to set

Returns:

the dsl builder

messageCreatedStrategy

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder messageCreatedStrategy(org.apache.camel.component.jms.MessageCreatedStrategy messageCreatedStrategy)

To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message. The option is a: <code>org.apache.camel.component.jms.MessageCreatedStrategy</code> type. Group: advanced

Specified by:

messageCreatedStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageCreatedStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageCreatedStrategy - the value to set

Returns:

the dsl builder

messageCreatedStrategy

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder messageCreatedStrategy(String messageCreatedStrategy)

To use the given MessageCreatedStrategy which are invoked when Camel creates new instances of jakarta.jms.Message objects when Camel is sending a JMS message. The option will be converted to a <code>org.apache.camel.component.jms.MessageCreatedStrategy</code> type. Group: advanced

Specified by:

messageCreatedStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageCreatedStrategy in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageCreatedStrategy - the value to set

Returns:

the dsl builder

messageIdEnabled

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageIdEnabled in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageIdEnabled - the value to set

Returns:

the dsl builder

messageIdEnabled

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageIdEnabled in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageIdEnabled - the value to set

Returns:

the dsl builder

messageListenerContainerFactory

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageListenerContainerFactory in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageListenerContainerFactory - the value to set

Returns:

the dsl builder

messageListenerContainerFactory

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageListenerContainerFactory in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageListenerContainerFactory - the value to set

Returns:

the dsl builder

messageTimestampEnabled

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageTimestampEnabled in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageTimestampEnabled - the value to set

Returns:

the dsl builder

messageTimestampEnabled

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

messageTimestampEnabled in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

messageTimestampEnabled - the value to set

Returns:

the dsl builder

pubSubNoLocal

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

pubSubNoLocal in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

pubSubNoLocal - the value to set

Returns:

the dsl builder

pubSubNoLocal

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

pubSubNoLocal in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

pubSubNoLocal - the value to set

Returns:

the dsl builder

receiveTimeout

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

receiveTimeout in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

receiveTimeout - the value to set

Returns:

the dsl builder

receiveTimeout

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

receiveTimeout in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

receiveTimeout - the value to set

Returns:

the dsl builder

recoveryInterval

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

recoveryInterval in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

recoveryInterval - the value to set

Returns:

the dsl builder

recoveryInterval

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

recoveryInterval in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

recoveryInterval - the value to set

Returns:

the dsl builder

requestTimeoutCheckerInterval

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

requestTimeoutCheckerInterval in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

requestTimeoutCheckerInterval - the value to set

Returns:

the dsl builder

requestTimeoutCheckerInterval

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

requestTimeoutCheckerInterval in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

requestTimeoutCheckerInterval - the value to set

Returns:

the dsl builder

synchronous

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

synchronous in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

synchronous

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

synchronous in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

synchronous - the value to set

Returns:

the dsl builder

transferException

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!. The option is a: <code>boolean</code> type. Default: false Group: advanced

Specified by:

transferException in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transferException in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transferException - the value to set

Returns:

the dsl builder

transferException

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 jakarta.jms.ObjectMessage. If the client is Camel, the returned Exception is rethrown. This allows you to use Camel JMS as a bridge in your routing - for example, using persistent queues to enable robust routing. Notice that if you also have transferExchange enabled, this option takes precedence. The caught exception is required to be serializable. The original Exception on the consumer side can be wrapped in an outer exception such as org.apache.camel.RuntimeCamelException when returned to the producer. Use this with caution as the data is using Java Object serialization and requires the received to be able to deserialize the data at Class level, which forces a strong coupling between the producers and consumer!. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced

Specified by:

transferException in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transferException in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transferException - the value to set

Returns:

the dsl builder

transferExchange

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transferExchange in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transferExchange - the value to set

Returns:

the dsl builder

transferExchange

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transferExchange in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transferExchange - the value to set

Returns:

the dsl builder

useMessageIDAsCorrelationID

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

useMessageIDAsCorrelationID in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

useMessageIDAsCorrelationID - the value to set

Returns:

the dsl builder

useMessageIDAsCorrelationID

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

useMessageIDAsCorrelationID in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

useMessageIDAsCorrelationID - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedCounter

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

waitForProvisionCorrelationToBeUpdatedCounter in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

waitForProvisionCorrelationToBeUpdatedCounter - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedCounter

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

waitForProvisionCorrelationToBeUpdatedCounter in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

waitForProvisionCorrelationToBeUpdatedCounter - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime - the value to set

Returns:

the dsl builder

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

waitForProvisionCorrelationToBeUpdatedThreadSleepingTime - the value to set

Returns:

the dsl builder

lazyCreateTransactionManager

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

lazyCreateTransactionManager in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

lazyCreateTransactionManager - the value to set

Returns:

the dsl builder

lazyCreateTransactionManager

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

lazyCreateTransactionManager in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

lazyCreateTransactionManager - the value to set

Returns:

the dsl builder

transactionManager

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transactionManager in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transactionManager - the value to set

Returns:

the dsl builder

transactionManager

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transactionManager in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transactionManager - the value to set

Returns:

the dsl builder

transactionName

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transactionName in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transactionName - the value to set

Returns:

the dsl builder

transactionTimeout

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transactionTimeout in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transactionTimeout - the value to set

Returns:

the dsl builder

transactionTimeout

default ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointBuilder 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 interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointConsumerBuilder

Specified by:

transactionTimeout in interface ActiveMQEndpointBuilderFactory.AdvancedActiveMQEndpointProducerBuilder

Parameters:

transactionTimeout - the value to set

Returns:

the dsl builder