org.apache.camel.builder.endpoint.dsl

Interface JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder

All Superinterfaces:

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

All Known Subinterfaces:

JmsEndpointBuilderFactory.JmsEndpointBuilder

Enclosing interface:

JmsEndpointBuilderFactory

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

Builder for endpoint consumers for the JMS component.

Method Summary

Modifier and Type	Method and Description
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	acknowledgementModeName(String acknowledgementModeName) The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE.
default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder	advanced()
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	asyncConsumer(boolean asyncConsumer) Whether the JmsConsumer processes the Exchange asynchronously.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	asyncConsumer(String asyncConsumer) Whether the JmsConsumer processes the Exchange asynchronously.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	autoStartup(boolean autoStartup) Specifies whether the consumer container should auto-startup.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	autoStartup(String autoStartup) Specifies whether the consumer container should auto-startup.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	cacheLevel(int cacheLevel) Sets the cache level by ID for the underlying JMS resources.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	cacheLevel(String cacheLevel) Sets the cache level by ID for the underlying JMS resources.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	cacheLevelName(String cacheLevelName) Sets the cache level by name for the underlying JMS resources.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	clientId(String clientId) Sets the JMS client ID to use.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	concurrentConsumers(int concurrentConsumers) Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS).
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	concurrentConsumers(String concurrentConsumers) Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS).
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	connectionFactory(Object connectionFactory) Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or setListenerConnectionFactory(ConnectionFactory).
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	connectionFactory(String connectionFactory) Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or setListenerConnectionFactory(ConnectionFactory).
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	disableReplyTo(boolean disableReplyTo) Specifies whether Camel ignores the JMSReplyTo header in messages.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	disableReplyTo(String disableReplyTo) Specifies whether Camel ignores the JMSReplyTo header in messages.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	durableSubscriptionName(String durableSubscriptionName) The durable subscriber name for specifying durable topic subscriptions.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	errorHandlerLoggingLevel(org.apache.camel.LoggingLevel errorHandlerLoggingLevel) Allows to configure the default errorHandler logging level for logging uncaught exceptions.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	errorHandlerLoggingLevel(String errorHandlerLoggingLevel) Allows to configure the default errorHandler logging level for logging uncaught exceptions.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	errorHandlerLogStackTrace(boolean errorHandlerLogStackTrace) Allows to control whether stacktraces should be logged or not, by the default errorHandler.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	errorHandlerLogStackTrace(String errorHandlerLogStackTrace) Allows to control whether stacktraces should be logged or not, by the default errorHandler.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	jmsMessageType(JmsEndpointBuilderFactory.JmsMessageType jmsMessageType) Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	jmsMessageType(String jmsMessageType) Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	maxConcurrentConsumers(int maxConcurrentConsumers) Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS).
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	maxConcurrentConsumers(String maxConcurrentConsumers) Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS).
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	password(String password) Password to use with the ConnectionFactory.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	replyTo(String replyTo) Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo().
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	replyToDeliveryPersistent(boolean replyToDeliveryPersistent) Specifies whether to use persistent delivery by default for replies.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	replyToDeliveryPersistent(String replyToDeliveryPersistent) Specifies whether to use persistent delivery by default for replies.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	selector(String selector) Sets the JMS selector to use.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	subscriptionDurable(boolean subscriptionDurable) Set whether to make the subscription durable.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	subscriptionDurable(String subscriptionDurable) Set whether to make the subscription durable.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	subscriptionName(String subscriptionName) Set the name of a subscription to create.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	subscriptionShared(boolean subscriptionShared) Set whether to make the subscription shared.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	subscriptionShared(String subscriptionShared) Set whether to make the subscription shared.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	testConnectionOnStartup(boolean testConnectionOnStartup) Specifies whether to test the connection on startup.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	testConnectionOnStartup(String testConnectionOnStartup) Specifies whether to test the connection on startup.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	transacted(boolean transacted) Specifies whether to use transacted mode.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	transacted(String transacted) Specifies whether to use transacted mode.
default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder	username(String username) Username to use with the ConnectionFactory.

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

doSetProperty, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve

Method Detail

advanced

default JmsEndpointBuilderFactory.AdvancedJmsEndpointConsumerBuilder advanced()

clientId

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder clientId(String clientId)

Sets the JMS client ID to use. Note that this value, if specified, must be unique and can only be used by a single JMS connection instance. It is typically only required for durable topic subscriptions. If using Apache ActiveMQ you may prefer to use Virtual Topics instead. The option is a: java.lang.String type. Group: common

connectionFactory

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder connectionFactory(Object connectionFactory)

Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or setListenerConnectionFactory(ConnectionFactory). The option is a: javax.jms.ConnectionFactory type. Group: common

connectionFactory

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder connectionFactory(String connectionFactory)

Sets the default connection factory to be used if a connection factory is not specified for either setTemplateConnectionFactory(ConnectionFactory) or setListenerConnectionFactory(ConnectionFactory). The option will be converted to a javax.jms.ConnectionFactory type. Group: common

disableReplyTo

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder disableReplyTo(boolean disableReplyTo)

Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. The option is a: boolean type. Default: false Group: common

disableReplyTo

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder disableReplyTo(String disableReplyTo)

Specifies whether Camel ignores the JMSReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the JMSReplyTo header. You can use this option if you want Camel to consume from a route and you do not want Camel to automatically send back a reply message because another component in your code handles the reply message. You can also use this option if you want to use Camel as a proxy between different message brokers and you want to route message from one system to another. The option will be converted to a boolean type. Default: false Group: common

durableSubscriptionName

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder durableSubscriptionName(String durableSubscriptionName)

The durable subscriber name for specifying durable topic subscriptions. The clientId option must be configured as well. The option is a: java.lang.String type. Group: common

jmsMessageType

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder jmsMessageType(JmsEndpointBuilderFactory.JmsMessageType jmsMessageType)

Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. The option is a: org.apache.camel.component.jms.JmsMessageType type. Group: common

jmsMessageType

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder jmsMessageType(String jmsMessageType)

Allows you to force the use of a specific javax.jms.Message implementation for sending JMS messages. Possible values are: Bytes, Map, Object, Stream, Text. By default, Camel would determine which JMS message type to use from the In body type. This option allows you to specify it. The option will be converted to a org.apache.camel.component.jms.JmsMessageType type. Group: common

testConnectionOnStartup

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder testConnectionOnStartup(boolean testConnectionOnStartup)

Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. The option is a: boolean type. Default: false Group: common

testConnectionOnStartup

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder testConnectionOnStartup(String testConnectionOnStartup)

Specifies whether to test the connection on startup. This ensures that when Camel starts that all the JMS consumers have a valid connection to the JMS broker. If a connection cannot be granted then Camel throws an exception on startup. This ensures that Camel is not started with failed connections. The JMS producers is tested as well. The option will be converted to a boolean type. Default: false Group: common

acknowledgementModeName

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder acknowledgementModeName(String acknowledgementModeName)

The JMS acknowledgement name, which is one of: SESSION_TRANSACTED, CLIENT_ACKNOWLEDGE, AUTO_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE. The option is a: java.lang.String type. Default: AUTO_ACKNOWLEDGE Group: consumer

asyncConsumer

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder asyncConsumer(boolean asyncConsumer)

Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions). The option is a: boolean type. Default: false Group: consumer

asyncConsumer

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder asyncConsumer(String asyncConsumer)

Whether the JmsConsumer processes the Exchange asynchronously. If enabled then the JmsConsumer may pickup the next message from the JMS queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the JmsConsumer will pickup the next message from the JMS queue. Note if transacted has been enabled, then asyncConsumer=true does not run asynchronously, as transaction must be executed synchronously (Camel 3.0 may support async transactions). The option will be converted to a boolean type. Default: false Group: consumer

autoStartup

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder autoStartup(boolean autoStartup)

Specifies whether the consumer container should auto-startup. The option is a: boolean type. Default: true Group: consumer

autoStartup

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder autoStartup(String autoStartup)

Specifies whether the consumer container should auto-startup. The option will be converted to a boolean type. Default: true Group: consumer

cacheLevel

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder cacheLevel(int cacheLevel)

Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. The option is a: int type. Group: consumer

cacheLevel

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder cacheLevel(String cacheLevel)

Sets the cache level by ID for the underlying JMS resources. See cacheLevelName option for more details. The option will be converted to a int type. Group: consumer

cacheLevelName

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder cacheLevelName(String cacheLevelName)

Sets the cache level by name for the underlying JMS resources. Possible values are: CACHE_AUTO, CACHE_CONNECTION, CACHE_CONSUMER, CACHE_NONE, and CACHE_SESSION. The default setting is CACHE_AUTO. See the Spring documentation and Transactions Cache Levels for more information. The option is a: java.lang.String type. Default: CACHE_AUTO Group: consumer

concurrentConsumers

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder concurrentConsumers(int concurrentConsumers)

Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option is a: int type. Default: 1 Group: consumer

concurrentConsumers

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder concurrentConsumers(String concurrentConsumers)

Specifies the default number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option will be converted to a int type. Default: 1 Group: consumer

maxConcurrentConsumers

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder maxConcurrentConsumers(int maxConcurrentConsumers)

Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option is a: int type. Group: consumer

maxConcurrentConsumers

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder maxConcurrentConsumers(String maxConcurrentConsumers)

Specifies the maximum number of concurrent consumers when consuming from JMS (not for request/reply over JMS). See also the maxMessagesPerTask option to control dynamic scaling up/down of threads. When doing request/reply over JMS then the option replyToMaxConcurrentConsumers is used to control number of concurrent consumers on the reply message listener. The option will be converted to a int type. Group: consumer

replyTo

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder replyTo(String replyTo)

Provides an explicit ReplyTo destination, which overrides any incoming value of Message.getJMSReplyTo(). The option is a: java.lang.String type. Group: consumer

replyToDeliveryPersistent

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder replyToDeliveryPersistent(boolean replyToDeliveryPersistent)

Specifies whether to use persistent delivery by default for replies. The option is a: boolean type. Default: true Group: consumer

replyToDeliveryPersistent

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder replyToDeliveryPersistent(String replyToDeliveryPersistent)

Specifies whether to use persistent delivery by default for replies. The option will be converted to a boolean type. Default: true Group: consumer

selector

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder selector(String selector)

Sets the JMS selector to use. The option is a: java.lang.String type. Group: consumer

subscriptionDurable

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder subscriptionDurable(boolean subscriptionDurable)

Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. The option is a: boolean type. Default: false Group: consumer

subscriptionDurable

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder subscriptionDurable(String subscriptionDurable)

Set whether to make the subscription durable. The durable subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a durable subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. The option will be converted to a boolean type. Default: false Group: consumer

subscriptionName

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder subscriptionName(String subscriptionName)

Set the name of a subscription to create. To be applied in case of a topic (pub-sub domain) with a shared or durable subscription. The subscription name needs to be unique within this client's JMS client id. Default is the class name of the specified message listener. Note: Only 1 concurrent consumer (which is the default of this message listener container) is allowed for each subscription, except for a shared subscription (which requires JMS 2.0). The option is a: java.lang.String type. Group: consumer

subscriptionShared

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder subscriptionShared(boolean subscriptionShared)

Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. The option is a: boolean type. Default: false Group: consumer

subscriptionShared

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder subscriptionShared(String subscriptionShared)

Set whether to make the subscription shared. The shared subscription name to be used can be specified through the subscriptionName property. Default is false. Set this to true to register a shared subscription, typically in combination with a subscriptionName value (unless your message listener class name is good enough as subscription name). Note that shared subscriptions may also be durable, so this flag can (and often will) be combined with subscriptionDurable as well. Only makes sense when listening to a topic (pub-sub domain), therefore this method switches the pubSubDomain flag as well. Requires a JMS 2.0 compatible message broker. The option will be converted to a boolean type. Default: false Group: consumer

errorHandlerLoggingLevel

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder errorHandlerLoggingLevel(org.apache.camel.LoggingLevel errorHandlerLoggingLevel)

Allows to configure the default errorHandler logging level for logging uncaught exceptions. The option is a: org.apache.camel.LoggingLevel type. Default: WARN Group: logging

errorHandlerLoggingLevel

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder errorHandlerLoggingLevel(String errorHandlerLoggingLevel)

Allows to configure the default errorHandler logging level for logging uncaught exceptions. The option will be converted to a org.apache.camel.LoggingLevel type. Default: WARN Group: logging

errorHandlerLogStackTrace

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder errorHandlerLogStackTrace(boolean errorHandlerLogStackTrace)

Allows to control whether stacktraces should be logged or not, by the default errorHandler. The option is a: boolean type. Default: true Group: logging

errorHandlerLogStackTrace

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder errorHandlerLogStackTrace(String errorHandlerLogStackTrace)

Allows to control whether stacktraces should be logged or not, by the default errorHandler. The option will be converted to a boolean type. Default: true Group: logging

password

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder password(String password)

Password to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. The option is a: java.lang.String type. Group: security

username

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder username(String username)

Username to use with the ConnectionFactory. You can also configure username/password directly on the ConnectionFactory. The option is a: java.lang.String type. Group: security

transacted

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder transacted(boolean transacted)

Specifies whether to use transacted mode. The option is a: boolean type. Default: false Group: transaction

transacted

default JmsEndpointBuilderFactory.JmsEndpointConsumerBuilder transacted(String transacted)

Specifies whether to use transacted mode. The option will be converted to a boolean type. Default: false Group: transaction