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

Interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder

All Superinterfaces:

ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder, ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

ActiveMQ6EndpointBuilderFactory

public static interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder
extends ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder, ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Builder for endpoint for the ActiveMQ 6.x component.

Method Summary

Modifier and Type	Method	Description
default ActiveMQ6EndpointBuilderFactory.AdvancedActiveMQ6EndpointBuilder	advanced()
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	clientId(String clientId)	Sets the JMS client ID to use.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)	The connection factory to be use.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	connectionFactory(String connectionFactory)	The connection factory to be use.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	disableReplyTo(boolean disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	disableReplyTo(String disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	durableSubscriptionName(String durableSubscriptionName)	The durable subscriber name for specifying durable topic subscriptions.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	jmsMessageType(String jmsMessageType)	Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	jmsMessageType(org.apache.camel.component.jms.JmsMessageType jmsMessageType)	Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	password(String password)	Password to use with the ConnectionFactory.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	replyTo(String replyTo)	Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer).
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	testConnectionOnStartup(boolean testConnectionOnStartup)	Specifies whether to test the connection on startup.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	testConnectionOnStartup(String testConnectionOnStartup)	Specifies whether to test the connection on startup.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	transacted(boolean transacted)	Specifies whether to use transacted mode.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	transacted(String transacted)	Specifies whether to use transacted mode.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	transactedInOut(boolean transactedInOut)	Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	transactedInOut(String transactedInOut)	Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations.
default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder	username(String username)	Username to use with the ConnectionFactory.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

acknowledgementModeName, artemisConsumerPriority, artemisConsumerPriority, asyncConsumer, asyncConsumer, autoStartup, autoStartup, cacheLevel, cacheLevel, cacheLevelName, concurrentConsumers, concurrentConsumers, errorHandlerLoggingLevel, errorHandlerLoggingLevel, errorHandlerLogStackTrace, errorHandlerLogStackTrace, maxConcurrentConsumers, maxConcurrentConsumers, replyToDeliveryPersistent, replyToDeliveryPersistent, selector, subscriptionDurable, subscriptionDurable, subscriptionName, subscriptionShared, subscriptionShared

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

deliveryDelay, deliveryDelay, deliveryMode, deliveryMode, deliveryPersistent, deliveryPersistent, explicitQosEnabled, explicitQosEnabled, formatDateHeadersToIso8601, formatDateHeadersToIso8601, preserveMessageQos, preserveMessageQos, priority, priority, replyToConcurrentConsumers, replyToConcurrentConsumers, replyToMaxConcurrentConsumers, replyToMaxConcurrentConsumers, replyToOnTimeoutMaxConcurrentConsumers, replyToOnTimeoutMaxConcurrentConsumers, replyToOverride, replyToType, replyToType, requestTimeout, requestTimeout, timeToLive, timeToLive

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

advanced

default ActiveMQ6EndpointBuilderFactory.AdvancedActiveMQ6EndpointBuilder advanced()

Specified by:

advanced in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

advanced in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

clientId

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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 with JMS 1.1. The option is a: java.lang.String type. Group: common

Specified by:

clientId in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

clientId in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

clientId - the value to set

Returns:

the dsl builder

connectionFactory

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)

The connection factory to be use. A connection factory must be configured either on the component or endpoint. The option is a: jakarta.jms.ConnectionFactory type. Group: common

Specified by:

connectionFactory in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

connectionFactory in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionFactory

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder connectionFactory(String connectionFactory)

The connection factory to be use. A connection factory must be configured either on the component or endpoint. The option will be converted to a jakarta.jms.ConnectionFactory type. Group: common

Specified by:

connectionFactory in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

connectionFactory in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

disableReplyTo

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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

Specified by:

disableReplyTo in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

disableReplyTo in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

disableReplyTo

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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

Specified by:

disableReplyTo in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

disableReplyTo in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

durableSubscriptionName

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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

Specified by:

durableSubscriptionName in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

durableSubscriptionName in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

durableSubscriptionName - the value to set

Returns:

the dsl builder

jmsMessageType

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder jmsMessageType(org.apache.camel.component.jms.JmsMessageType jmsMessageType)

Allows you to force the use of a specific jakarta.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

Specified by:

jmsMessageType in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

jmsMessageType in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

jmsMessageType - the value to set

Returns:

the dsl builder

jmsMessageType

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder jmsMessageType(String jmsMessageType)

Allows you to force the use of a specific jakarta.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

Specified by:

jmsMessageType in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

jmsMessageType in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

jmsMessageType - the value to set

Returns:

the dsl builder

replyTo

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder replyTo(String replyTo)

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

Specified by:

replyTo in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

replyTo in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

replyTo - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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

Specified by:

testConnectionOnStartup in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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

Specified by:

testConnectionOnStartup in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

password

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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

Specified by:

password in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

password in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

username

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder 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

Specified by:

username in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

username in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

username - the value to set

Returns:

the dsl builder

transacted

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder transacted(boolean transacted)

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

Specified by:

transacted in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

transacted in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder

transacted

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder transacted(String transacted)

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

Specified by:

transacted in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

transacted in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder

transactedInOut

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder transactedInOut(boolean transactedInOut)

Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction. The option is a: boolean type. Default: false Group: transaction

Specified by:

transactedInOut in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

transactedInOut in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

transactedInOut - the value to set

Returns:

the dsl builder

transactedInOut

default ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointBuilder transactedInOut(String transactedInOut)

Specifies whether InOut operations (request reply) default to using transacted mode If this flag is set to true, then Spring JmsTemplate will have sessionTransacted set to true, and the acknowledgeMode as transacted on the JmsTemplate used for InOut operations. Note from Spring JMS: that within a JTA transaction, the parameters passed to createQueue, createTopic methods are not taken into account. Depending on the Java EE transaction context, the container makes its own decisions on these values. Analogously, these parameters are not taken into account within a locally managed transaction either, since Spring JMS operates on an existing JMS Session in this case. Setting this flag to true will use a short local JMS transaction when running outside of a managed transaction, and a synchronized local JMS transaction in case of a managed transaction (other than an XA transaction) being present. This has the effect of a local JMS transaction being managed alongside the main transaction (which might be a native JDBC transaction), with the JMS transaction committing right after the main transaction. The option will be converted to a boolean type. Default: false Group: transaction

Specified by:

transactedInOut in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointConsumerBuilder

Specified by:

transactedInOut in interface ActiveMQ6EndpointBuilderFactory.ActiveMQ6EndpointProducerBuilder

Parameters:

transactedInOut - the value to set

Returns:

the dsl builder