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

Interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointBuilder
Enclosing interface:
SpringRabbitMQEndpointBuilderFactory
public static interface SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the Spring RabbitMQ component.

  • Method Details

    • advanced

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder advanced()

    • connectionFactory

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

    • connectionFactory

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

    • acknowledgeMode

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder acknowledgeMode(org.springframework.amqp.core.AcknowledgeMode acknowledgeMode)
      Flag controlling the behaviour of the container with respect to message acknowledgement. The most common usage is to let the container handle the acknowledgements (so the listener doesn't need to know about the channel or the message). Set to AcknowledgeMode.MANUAL if the listener will send the acknowledgements itself using Channel.basicAck(long, boolean). Manual acks are consistent with either a transactional or non-transactional channel, but if you are doing no other work on the channel at the same other than receiving a single message then the transaction is probably unnecessary. Set to AcknowledgeMode.NONE to tell the broker not to expect any acknowledgements, and it will assume all messages are acknowledged as soon as they are sent (this is autoack in native Rabbit broker terms). If AcknowledgeMode.NONE then the channel cannot be transactional (so the container will fail on start up if that flag is accidentally set). The option is a: <code>org.springframework.amqp.core.AcknowledgeMode</code> type. Group: consumer
      Parameters:
      acknowledgeMode - the value to set
      Returns:
      the dsl builder

    • acknowledgeMode

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder acknowledgeMode(String acknowledgeMode)
      Flag controlling the behaviour of the container with respect to message acknowledgement. The most common usage is to let the container handle the acknowledgements (so the listener doesn't need to know about the channel or the message). Set to AcknowledgeMode.MANUAL if the listener will send the acknowledgements itself using Channel.basicAck(long, boolean). Manual acks are consistent with either a transactional or non-transactional channel, but if you are doing no other work on the channel at the same other than receiving a single message then the transaction is probably unnecessary. Set to AcknowledgeMode.NONE to tell the broker not to expect any acknowledgements, and it will assume all messages are acknowledged as soon as they are sent (this is autoack in native Rabbit broker terms). If AcknowledgeMode.NONE then the channel cannot be transactional (so the container will fail on start up if that flag is accidentally set). The option will be converted to a <code>org.springframework.amqp.core.AcknowledgeMode</code> type. Group: consumer
      Parameters:
      acknowledgeMode - the value to set
      Returns:
      the dsl builder

    • asyncConsumer

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder asyncConsumer(boolean asyncConsumer)
      Whether the consumer processes the Exchange asynchronously. If enabled then the consumer may pickup the next message from the queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the consumer will pickup the next message from the queue. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      asyncConsumer - the value to set
      Returns:
      the dsl builder

    • asyncConsumer

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder asyncConsumer(String asyncConsumer)
      Whether the consumer processes the Exchange asynchronously. If enabled then the consumer may pickup the next message from the queue, while the previous message is being processed asynchronously (by the Asynchronous Routing Engine). This means that messages may be processed not 100% strictly in order. If disabled (as default) then the Exchange is fully processed before the consumer will pickup the next message from the queue. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      asyncConsumer - the value to set
      Returns:
      the dsl builder

    • autoDeclare

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder autoDeclare(boolean autoDeclare)
      Specifies whether the consumer should auto declare binding between exchange, queue and routing key when starting. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      autoDeclare - the value to set
      Returns:
      the dsl builder

    • autoDeclare

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder autoDeclare(String autoDeclare)
      Specifies whether the consumer should auto declare binding between exchange, queue and routing key when starting. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      autoDeclare - the value to set
      Returns:
      the dsl builder

    • autoStartup

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

    • autoStartup

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder autoStartup(String autoStartup)
      Specifies whether the consumer container should auto-startup. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      autoStartup - the value to set
      Returns:
      the dsl builder

    • deadLetterExchange

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

    • exchangeType

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder exchangeType(String exchangeType)
      The type of the exchange. The option is a: <code>java.lang.String</code> type. Default: direct Group: consumer
      Parameters:
      exchangeType - the value to set
      Returns:
      the dsl builder

    • exclusive

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder exclusive(boolean exclusive)
      Set to true for an exclusive consumer. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      exclusive - the value to set
      Returns:
      the dsl builder

    • exclusive

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder exclusive(String exclusive)
      Set to true for an exclusive consumer. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      exclusive - the value to set
      Returns:
      the dsl builder

    • maximumRetryAttempts

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder maximumRetryAttempts(int maximumRetryAttempts)
      How many times a Rabbitmq consumer will retry the same message if Camel failed to process the message. The option is a: <code>int</code> type. Default: 5 Group: consumer
      Parameters:
      maximumRetryAttempts - the value to set
      Returns:
      the dsl builder

    • maximumRetryAttempts

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder maximumRetryAttempts(String maximumRetryAttempts)
      How many times a Rabbitmq consumer will retry the same message if Camel failed to process the message. The option will be converted to a <code>int</code> type. Default: 5 Group: consumer
      Parameters:
      maximumRetryAttempts - the value to set
      Returns:
      the dsl builder

    • noLocal

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder noLocal(boolean noLocal)
      Set to true for an no-local consumer. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      noLocal - the value to set
      Returns:
      the dsl builder

    • noLocal

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder noLocal(String noLocal)
      Set to true for an no-local consumer. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      noLocal - the value to set
      Returns:
      the dsl builder

    • queues

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder queues(String queues)
      The queue(s) to use for consuming 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 for the consumer. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      queues - the value to set
      Returns:
      the dsl builder

    • rejectAndDontRequeue

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder rejectAndDontRequeue(boolean rejectAndDontRequeue)
      Whether a Rabbitmq consumer should reject the message without requeuing. This enables failed messages to be sent to a Dead Letter Exchange/Queue, if the broker is so configured. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      rejectAndDontRequeue - the value to set
      Returns:
      the dsl builder

    • rejectAndDontRequeue

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder rejectAndDontRequeue(String rejectAndDontRequeue)
      Whether a Rabbitmq consumer should reject the message without requeuing. This enables failed messages to be sent to a Dead Letter Exchange/Queue, if the broker is so configured. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      rejectAndDontRequeue - the value to set
      Returns:
      the dsl builder

    • retryDelay

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder retryDelay(int retryDelay)
      Delay in millis a Rabbitmq consumer will wait before redelivering a message that Camel failed to process. The option is a: <code>int</code> type. Default: 1000 Group: consumer
      Parameters:
      retryDelay - the value to set
      Returns:
      the dsl builder

    • retryDelay

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder retryDelay(String retryDelay)
      Delay in millis a Rabbitmq consumer will wait before redelivering a message that Camel failed to process. The option will be converted to a <code>int</code> type. Default: 1000 Group: consumer
      Parameters:
      retryDelay - the value to set
      Returns:
      the dsl builder