org.apache.camel.builder.endpoint.dsl

Interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver

All Known Subinterfaces:

SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder

Enclosing interface:

SpringRabbitMQEndpointBuilderFactory

public static interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder

Builder for endpoint producers for the Spring RabbitMQ component.

Method Summary

Modifier and Type	Method and Description
default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointProducerBuilder	advanced()
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	connectionFactory(Object connectionFactory) The connection factory to be use.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	connectionFactory(String connectionFactory) The connection factory to be use.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	disableReplyTo(boolean disableReplyTo) Specifies whether Camel ignores the ReplyTo header in messages.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	disableReplyTo(String disableReplyTo) Specifies whether Camel ignores the ReplyTo header in messages.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	lazyStartProducer(String lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	replyTimeout(long replyTimeout) Specify the timeout in milliseconds to be used when waiting for a reply message when doing request/reply messaging.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	replyTimeout(String replyTimeout) Specify the timeout in milliseconds to be used when waiting for a reply message when doing request/reply messaging.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	routingKey(String routingKey) The value of a routing key to use.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	testConnectionOnStartup(boolean testConnectionOnStartup) Specifies whether to test the connection on startup.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	testConnectionOnStartup(String testConnectionOnStartup) Specifies whether to test the connection on startup.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	usePublisherConnection(boolean usePublisherConnection) Use a separate connection for publishers and consumers.
default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder	usePublisherConnection(String usePublisherConnection) Use a separate connection for publishers and consumers.

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

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, expr, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Method Detail

advanced

default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointProducerBuilder advanced()

connectionFactory

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder connectionFactory(Object connectionFactory)

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

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

connectionFactory

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

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

disableReplyTo

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

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

disableReplyTo

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

Parameters:

disableReplyTo - the value to set

Returns:

the dsl builder

routingKey

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

Parameters:

routingKey - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder 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

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder 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

Parameters:

testConnectionOnStartup - the value to set

Returns:

the dsl builder

lazyStartProducer

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder lazyStartProducer(boolean lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

lazyStartProducer

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder lazyStartProducer(String lazyStartProducer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

replyTimeout

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder replyTimeout(long replyTimeout)

Specify the timeout in milliseconds to be used when waiting for a reply message when doing request/reply messaging. The default value is 5 seconds. A negative value indicates an indefinite timeout. The option is a: <code>long</code> type. Default: 5000 Group: producer

Parameters:

replyTimeout - the value to set

Returns:

the dsl builder

replyTimeout

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder replyTimeout(String replyTimeout)

Specify the timeout in milliseconds to be used when waiting for a reply message when doing request/reply messaging. The default value is 5 seconds. A negative value indicates an indefinite timeout. The option will be converted to a <code>long</code> type. Default: 5000 Group: producer

Parameters:

replyTimeout - the value to set

Returns:

the dsl builder

usePublisherConnection

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder usePublisherConnection(boolean usePublisherConnection)

Use a separate connection for publishers and consumers. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

usePublisherConnection - the value to set

Returns:

the dsl builder

usePublisherConnection

default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder usePublisherConnection(String usePublisherConnection)

Use a separate connection for publishers and consumers. The option will be converted to a <code>boolean</code> type. Default: false Group: producer

Parameters:

usePublisherConnection - the value to set

Returns:

the dsl builder