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

Interface AMQPEndpointBuilderFactory.AMQPEndpointBuilder

All Superinterfaces:

AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder, AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder, org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

Enclosing interface:

AMQPEndpointBuilderFactory

public static interface AMQPEndpointBuilderFactory.AMQPEndpointBuilder
extends AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder, AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Builder for endpoint for the AMQP component.

Method Summary

Modifier and Type	Method	Description
default AMQPEndpointBuilderFactory.AdvancedAMQPEndpointBuilder	advanced()
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	clientId(String clientId)	Sets the JMS client ID to use.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)	The connection factory to be use.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	connectionFactory(String connectionFactory)	The connection factory to be use.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	disableReplyTo(boolean disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	disableReplyTo(String disableReplyTo)	Specifies whether Camel ignores the JMSReplyTo header in messages.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	durableSubscriptionName(String durableSubscriptionName)	The durable subscriber name for specifying durable topic subscriptions.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	jmsMessageType(String jmsMessageType)	Allows you to force the use of a specific jakarta.jms.Message implementation for sending JMS messages.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	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 AMQPEndpointBuilderFactory.AMQPEndpointBuilder	password(String password)	Password to use with the ConnectionFactory.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	replyTo(String replyTo)	Provides an explicit ReplyTo destination (overrides any incoming value of Message.getJMSReplyTo() in consumer).
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	testConnectionOnStartup(boolean testConnectionOnStartup)	Specifies whether to test the connection on startup.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	testConnectionOnStartup(String testConnectionOnStartup)	Specifies whether to test the connection on startup.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	transacted(boolean transacted)	Specifies whether to use transacted mode.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	transacted(String transacted)	Specifies whether to use transacted mode.
default AMQPEndpointBuilderFactory.AMQPEndpointBuilder	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 AMQPEndpointBuilderFactory.AMQPEndpointBuilder	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 AMQPEndpointBuilderFactory.AMQPEndpointBuilder	username(String username)	Username to use with the ConnectionFactory.

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

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.AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

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 AMQPEndpointBuilderFactory.AdvancedAMQPEndpointBuilder advanced()

Specified by:

advanced in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

advanced in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

clientId

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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: <code>java.lang.String</code> type. Group: common

Specified by:

clientId in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

clientId in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

clientId - the value to set

Returns:

the dsl builder

connectionFactory

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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: <code>jakarta.jms.ConnectionFactory</code> type. Group: common

Specified by:

connectionFactory in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

connectionFactory in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionFactory

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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 <code>jakarta.jms.ConnectionFactory</code> type. Group: common

Specified by:

connectionFactory in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

connectionFactory in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

disableReplyTo

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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: <code>boolean</code> type. Default: false Group: common

Specified by:

disableReplyTo in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

disableReplyTo in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

disableReplyTo

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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 <code>boolean</code> type. Default: false Group: common

Specified by:

disableReplyTo in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

disableReplyTo in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

durableSubscriptionName

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder durableSubscriptionName(String durableSubscriptionName)

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

Specified by:

durableSubscriptionName in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

durableSubscriptionName in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

durableSubscriptionName - the value to set

Returns:

the dsl builder

jmsMessageType

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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: <code>org.apache.camel.component.jms.JmsMessageType</code> type. Group: common

Specified by:

jmsMessageType in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

jmsMessageType in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

jmsMessageType - the value to set

Returns:

the dsl builder

jmsMessageType

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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 <code>org.apache.camel.component.jms.JmsMessageType</code> type. Group: common

Specified by:

jmsMessageType in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

jmsMessageType in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

jmsMessageType - the value to set

Returns:

the dsl builder

replyTo

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder replyTo(String replyTo)

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

Specified by:

replyTo in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

replyTo in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

replyTo - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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: <code>boolean</code> type. Default: false Group: common

Specified by:

testConnectionOnStartup in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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 <code>boolean</code> type. Default: false Group: common

Specified by:

testConnectionOnStartup in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

password

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder password(String password)

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

Specified by:

password in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

password in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

password - the value to set

Returns:

the dsl builder

username

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder username(String username)

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

Specified by:

username in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

username in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

username - the value to set

Returns:

the dsl builder

transacted

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder transacted(boolean transacted)

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

Specified by:

transacted in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

transacted in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder

transacted

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder transacted(String transacted)

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

Specified by:

transacted in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

transacted in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

transacted - the value to set

Returns:

the dsl builder

transactedInOut

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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: <code>boolean</code> type. Default: false Group: transaction

Specified by:

transactedInOut in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

transactedInOut in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

transactedInOut - the value to set

Returns:

the dsl builder

transactedInOut

default AMQPEndpointBuilderFactory.AMQPEndpointBuilder 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 <code>boolean</code> type. Default: false Group: transaction

Specified by:

transactedInOut in interface AMQPEndpointBuilderFactory.AMQPEndpointConsumerBuilder

Specified by:

transactedInOut in interface AMQPEndpointBuilderFactory.AMQPEndpointProducerBuilder

Parameters:

transactedInOut - the value to set

Returns:

the dsl builder