org.apache.camel.builder.component.dsl

Interface SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.springrabbit.SpringRabbitMQComponent>

All Known Implementing Classes:

SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilderImpl

Enclosing interface:

SpringRabbitmqComponentBuilderFactory

public static interface SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder
extends ComponentBuilder<org.apache.camel.component.springrabbit.SpringRabbitMQComponent>

Builder for the Spring RabbitMQ component.

Method Summary

Modifier and Type	Method and Description
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	amqpAdmin(org.springframework.amqp.core.AmqpAdmin amqpAdmin) Optional AMQP Admin service to use for auto declaring elements (queues, exchanges, bindings).
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	autoDeclare(boolean autoDeclare) Specifies whether the consumer should auto declare binding between exchange, queue and routing key when starting.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	autoStartup(boolean autoStartup) Specifies whether the consumer container should auto-startup.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	connectionFactory(org.springframework.amqp.rabbit.connection.ConnectionFactory connectionFactory) The connection factory to be use.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	deadLetterExchange(String deadLetterExchange) The name of the dead letter exchange.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	deadLetterExchangeType(String deadLetterExchangeType) The type of the dead letter exchange.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	deadLetterQueue(String deadLetterQueue) The name of the dead letter queue.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	deadLetterRoutingKey(String deadLetterRoutingKey) The routing key for the dead letter exchange.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	errorHandler(org.springframework.util.ErrorHandler errorHandler) To use a custom ErrorHandler for handling exceptions from the message listener (consumer).
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	ignoreDeclarationExceptions(boolean ignoreDeclarationExceptions) Switch on ignore exceptions such as mismatched properties when declaring.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	listenerContainerFactory(org.apache.camel.component.springrabbit.ListenerContainerFactory listenerContainerFactory) To use a custom factory for creating and configuring ListenerContainer to be used by the consumer for receiving messages.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	messageConverter(org.springframework.amqp.support.converter.MessageConverter messageConverter) To use a custom MessageConverter so you can be in control how to map to/from a org.springframework.amqp.core.Message.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	messagePropertiesConverter(org.apache.camel.component.springrabbit.MessagePropertiesConverter messagePropertiesConverter) To use a custom MessagePropertiesConverter so you can be in control how to map to/from a org.springframework.amqp.core.MessageProperties.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	prefetchCount(int prefetchCount) Tell the broker how many messages to send to each consumer in a single request.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	shutdownTimeout(long shutdownTimeout) The time to wait for workers in milliseconds after the container is stopped.
default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder	testConnectionOnStartup(boolean testConnectionOnStartup) Specifies whether to test the connection on startup.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

amqpAdmin

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder amqpAdmin(org.springframework.amqp.core.AmqpAdmin amqpAdmin)

Optional AMQP Admin service to use for auto declaring elements (queues, exchanges, bindings). The option is a: <code>org.springframework.amqp.core.AmqpAdmin</code> type. Group: common

Parameters:

amqpAdmin - the value to set

Returns:

the dsl builder

connectionFactory

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

Parameters:

connectionFactory - the value to set

Returns:

the dsl builder

testConnectionOnStartup

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder 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

autoDeclare

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder autoDeclare(boolean autoDeclare)

Specifies whether the consumer should auto declare binding between exchange, queue and routing key when starting. Enabling this can be good for development to make it easy to standup exchanges, queues and bindings on the broker. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

autoDeclare - the value to set

Returns:

the dsl builder

autoStartup

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder autoStartup(boolean autoStartup)

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

Parameters:

autoStartup - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

deadLetterExchange

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder deadLetterExchange(String deadLetterExchange)

The name of the dead letter exchange. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

deadLetterExchange - the value to set

Returns:

the dsl builder

deadLetterExchangeType

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder deadLetterExchangeType(String deadLetterExchangeType)

The type of the dead letter exchange. The option is a: <code>java.lang.String</code> type. Default: direct Group: consumer

Parameters:

deadLetterExchangeType - the value to set

Returns:

the dsl builder

deadLetterQueue

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder deadLetterQueue(String deadLetterQueue)

The name of the dead letter queue. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

deadLetterQueue - the value to set

Returns:

the dsl builder

deadLetterRoutingKey

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder deadLetterRoutingKey(String deadLetterRoutingKey)

The routing key for the dead letter exchange. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

deadLetterRoutingKey - the value to set

Returns:

the dsl builder

errorHandler

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder errorHandler(org.springframework.util.ErrorHandler errorHandler)

To use a custom ErrorHandler for handling exceptions from the message listener (consumer). The option is a: <code>org.springframework.util.ErrorHandler</code> type. Group: consumer (advanced)

Parameters:

errorHandler - the value to set

Returns:

the dsl builder

listenerContainerFactory

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder listenerContainerFactory(org.apache.camel.component.springrabbit.ListenerContainerFactory listenerContainerFactory)

To use a custom factory for creating and configuring ListenerContainer to be used by the consumer for receiving messages. The option is a: <code>org.apache.camel.component.springrabbit.ListenerContainerFactory</code> type. Group: consumer (advanced)

Parameters:

listenerContainerFactory - the value to set

Returns:

the dsl builder

prefetchCount

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder prefetchCount(int prefetchCount)

Tell the broker how many messages to send to each consumer in a single request. Often this can be set quite high to improve throughput. The option is a: <code>int</code> type. Default: 250 Group: consumer (advanced)

Parameters:

prefetchCount - the value to set

Returns:

the dsl builder

shutdownTimeout

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder shutdownTimeout(long shutdownTimeout)

The time to wait for workers in milliseconds after the container is stopped. If any workers are active when the shutdown signal comes they will be allowed to finish processing as long as they can finish within this timeout. The option is a: <code>long</code> type. Default: 5000 Group: consumer (advanced)

Parameters:

shutdownTimeout - the value to set

Returns:

the dsl builder

lazyStartProducer

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder 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

autowiredEnabled

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder autowiredEnabled(boolean autowiredEnabled)

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

ignoreDeclarationExceptions

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder ignoreDeclarationExceptions(boolean ignoreDeclarationExceptions)

Switch on ignore exceptions such as mismatched properties when declaring. The option is a: <code>boolean</code> type. Default: false Group: advanced

Parameters:

ignoreDeclarationExceptions - the value to set

Returns:

the dsl builder

messageConverter

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder messageConverter(org.springframework.amqp.support.converter.MessageConverter messageConverter)

To use a custom MessageConverter so you can be in control how to map to/from a org.springframework.amqp.core.Message. The option is a: <code>org.springframework.amqp.support.converter.MessageConverter</code> type. Group: advanced

Parameters:

messageConverter - the value to set

Returns:

the dsl builder

messagePropertiesConverter

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder messagePropertiesConverter(org.apache.camel.component.springrabbit.MessagePropertiesConverter messagePropertiesConverter)

To use a custom MessagePropertiesConverter so you can be in control how to map to/from a org.springframework.amqp.core.MessageProperties. The option is a: <code>org.apache.camel.component.springrabbit.MessagePropertiesConverter</code> type. Group: advanced

Parameters:

messagePropertiesConverter - the value to set

Returns:

the dsl builder

headerFilterStrategy

default SpringRabbitmqComponentBuilderFactory.SpringRabbitmqComponentBuilder headerFilterStrategy(org.apache.camel.spi.HeaderFilterStrategy headerFilterStrategy)

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a: <code>org.apache.camel.spi.HeaderFilterStrategy</code> type. Group: filter

Parameters:

headerFilterStrategy - the value to set

Returns:

the dsl builder