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

Interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder, SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Enclosing interface:

SpringRabbitMQEndpointBuilderFactory

public static interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder
extends SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder, SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Builder for endpoint for the Spring RabbitMQ component.

Method Summary

Modifier and Type	Method	Description
default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointBuilder	advanced()
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	connectionFactory(String connectionFactory)	The connection factory to be use.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	connectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory)	The connection factory to be use.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	deadLetterExchange(String deadLetterExchange)	The name of the dead letter exchange.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	deadLetterExchangeType(String deadLetterExchangeType)	The type of the dead letter exchange.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	deadLetterQueue(String deadLetterQueue)	The name of the dead letter queue.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	deadLetterRoutingKey(String deadLetterRoutingKey)	The routing key for the dead letter exchange.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	disableReplyTo(boolean disableReplyTo)	Specifies whether Camel ignores the ReplyTo header in messages.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	disableReplyTo(String disableReplyTo)	Specifies whether Camel ignores the ReplyTo header in messages.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	queues(String queues)	The queue(s) to use for consuming or producing messages.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	routingKey(String routingKey)	The value of a routing key to use.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	testConnectionOnStartup(boolean testConnectionOnStartup)	Specifies whether to test the connection on startup.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder	testConnectionOnStartup(String testConnectionOnStartup)	Specifies whether to test the connection on startup.

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

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

acknowledgeMode, acknowledgeMode, asyncConsumer, asyncConsumer, autoDeclare, autoDeclare, autoStartup, autoStartup, exchangeType, exclusive, exclusive, maximumRetryAttempts, maximumRetryAttempts, noLocal, noLocal, rejectAndDontRequeue, rejectAndDontRequeue, retryDelay, retryDelay

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

allowNullBody, allowNullBody, autoDeclareProducer, autoDeclareProducer, confirm, confirmTimeout, confirmTimeout, replyTimeout, replyTimeout, skipBindQueue, skipBindQueue, skipDeclareExchange, skipDeclareExchange, skipDeclareQueue, skipDeclareQueue, usePublisherConnection, usePublisherConnection

Method Details

advanced

default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointBuilder advanced()

Specified by:

advanced in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

advanced in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

connectionFactory

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder connectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory)

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

Specified by:

connectionFactory in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

connectionFactory in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionFactory

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder 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 org.springframework.amqp.rabbit.connection.ConnectionFactory type. Group: common

Specified by:

connectionFactory in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

connectionFactory in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

deadLetterExchange

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder deadLetterExchange(String deadLetterExchange)

The name of the dead letter exchange. The option is a: java.lang.String type. Group: common

Specified by:

deadLetterExchange in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

deadLetterExchange in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

deadLetterExchange - the value to set

Returns:

the dsl builder

deadLetterExchangeType

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder deadLetterExchangeType(String deadLetterExchangeType)

The type of the dead letter exchange. The option is a: java.lang.String type. Default: direct Group: common

Specified by:

deadLetterExchangeType in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

deadLetterExchangeType in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

deadLetterExchangeType - the value to set

Returns:

the dsl builder

deadLetterQueue

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder deadLetterQueue(String deadLetterQueue)

The name of the dead letter queue. The option is a: java.lang.String type. Group: common

Specified by:

deadLetterQueue in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

deadLetterQueue in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

deadLetterQueue - the value to set

Returns:

the dsl builder

deadLetterRoutingKey

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder deadLetterRoutingKey(String deadLetterRoutingKey)

The routing key for the dead letter exchange. The option is a: java.lang.String type. Group: common

Specified by:

deadLetterRoutingKey in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

deadLetterRoutingKey in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

deadLetterRoutingKey - the value to set

Returns:

the dsl builder

disableReplyTo

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder disableReplyTo(boolean disableReplyTo)

Specifies whether Camel ignores the ReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the ReplyTo 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 SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

disableReplyTo in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

disableReplyTo

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder disableReplyTo(String disableReplyTo)

Specifies whether Camel ignores the ReplyTo header in messages. If true, Camel does not send a reply back to the destination specified in the ReplyTo 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 SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

disableReplyTo in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

queues

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder queues(String queues)

The queue(s) to use for consuming or producing messages. Multiple queue names can be separated by comma. If none has been configured then Camel will generate an unique id as the queue name. The option is a: java.lang.String type. Group: common

Specified by:

queues in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

queues in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

queues - the value to set

Returns:

the dsl builder

routingKey

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder routingKey(String routingKey)

The value of a routing key to use. Default is empty which is not helpful when using the default (or any direct) exchange, but fine if the exchange is a headers exchange for instance. The option is a: java.lang.String type. Group: common

Specified by:

routingKey in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

routingKey in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

routingKey - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder 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 SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder 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 SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

Specified by:

testConnectionOnStartup in interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder