Package 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 Details

    • advanced

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointProducerBuilder advanced()

    • connectionFactory

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder 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
      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 org.springframework.amqp.rabbit.connection.ConnectionFactory type. Group: common
      Parameters:
      connectionFactory - the value to set
      Returns:
      the dsl builder

    • deadLetterExchange

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder deadLetterExchange(String deadLetterExchange)
      The name of the dead letter exchange. The option is a: java.lang.String type. Group: common
      Parameters:
      deadLetterExchange - the value to set
      Returns:
      the dsl builder

    • deadLetterExchangeType

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder deadLetterExchangeType(String deadLetterExchangeType)
      The type of the dead letter exchange. The option is a: java.lang.String type. Default: direct Group: common
      Parameters:
      deadLetterExchangeType - the value to set
      Returns:
      the dsl builder

    • deadLetterQueue

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder deadLetterQueue(String deadLetterQueue)
      The name of the dead letter queue. The option is a: java.lang.String type. Group: common
      Parameters:
      deadLetterQueue - the value to set
      Returns:
      the dsl builder

    • deadLetterRoutingKey

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder deadLetterRoutingKey(String deadLetterRoutingKey)
      The routing key for the dead letter exchange. The option is a: java.lang.String type. Group: common
      Parameters:
      deadLetterRoutingKey - 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: boolean 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 boolean type. Default: false Group: common
      Parameters:
      disableReplyTo - the value to set
      Returns:
      the dsl builder

    • queues

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder 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
      Parameters:
      queues - 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: java.lang.String 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: boolean 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 boolean type. Default: false Group: common
      Parameters:
      testConnectionOnStartup - the value to set
      Returns:
      the dsl builder

    • allowNullBody

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder allowNullBody(boolean allowNullBody)
      Whether to allow sending messages with no body. If this option is false and the message body is null, then an MessageConversionException is thrown. The option is a: boolean type. Default: false Group: producer
      Parameters:
      allowNullBody - the value to set
      Returns:
      the dsl builder

    • allowNullBody

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder allowNullBody(String allowNullBody)
      Whether to allow sending messages with no body. If this option is false and the message body is null, then an MessageConversionException is thrown. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      allowNullBody - the value to set
      Returns:
      the dsl builder

    • autoDeclareProducer

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder autoDeclareProducer(boolean autoDeclareProducer)
      Specifies whether the producer should auto declare binding between exchange, queue and routing key when starting. The option is a: boolean type. Default: false Group: producer
      Parameters:
      autoDeclareProducer - the value to set
      Returns:
      the dsl builder

    • autoDeclareProducer

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder autoDeclareProducer(String autoDeclareProducer)
      Specifies whether the producer should auto declare binding between exchange, queue and routing key when starting. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      autoDeclareProducer - the value to set
      Returns:
      the dsl builder

    • confirm

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder confirm(String confirm)
      Controls whether to wait for confirms. The connection factory must be configured for publisher confirms and this method. auto = Camel detects if the connection factory uses confirms or not. disabled = Confirms is disabled. enabled = Confirms is enabled. The option is a: java.lang.String type. Default: auto Group: producer
      Parameters:
      confirm - the value to set
      Returns:
      the dsl builder

    • confirmTimeout

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder confirmTimeout(long confirmTimeout)
      Specify the timeout in milliseconds to be used when waiting for a message sent to be confirmed by RabbitMQ when doing send only messaging (InOnly). The default value is 5 seconds. A negative value indicates an indefinite timeout. The option is a: long type. Default: 5000 Group: producer
      Parameters:
      confirmTimeout - the value to set
      Returns:
      the dsl builder

    • confirmTimeout

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder confirmTimeout(String confirmTimeout)
      Specify the timeout in milliseconds to be used when waiting for a message sent to be confirmed by RabbitMQ when doing send only messaging (InOnly). The default value is 5 seconds. A negative value indicates an indefinite timeout. The option will be converted to a long type. Default: 5000 Group: producer
      Parameters:
      confirmTimeout - 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 (InOut) messaging. The default value is 30 seconds. A negative value indicates an indefinite timeout (Beware that this will cause a memory leak if a reply is not received). The option is a: long type. Default: 30000 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 (InOut) messaging. The default value is 30 seconds. A negative value indicates an indefinite timeout (Beware that this will cause a memory leak if a reply is not received). The option will be converted to a long type. Default: 30000 Group: producer
      Parameters:
      replyTimeout - the value to set
      Returns:
      the dsl builder

    • skipBindQueue

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder skipBindQueue(boolean skipBindQueue)
      If true the queue will not be bound to the exchange after declaring it. The option is a: boolean type. Default: false Group: producer
      Parameters:
      skipBindQueue - the value to set
      Returns:
      the dsl builder

    • skipBindQueue

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder skipBindQueue(String skipBindQueue)
      If true the queue will not be bound to the exchange after declaring it. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      skipBindQueue - the value to set
      Returns:
      the dsl builder

    • skipDeclareExchange

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder skipDeclareExchange(boolean skipDeclareExchange)
      This can be used if we need to declare the queue but not the exchange. The option is a: boolean type. Default: false Group: producer
      Parameters:
      skipDeclareExchange - the value to set
      Returns:
      the dsl builder

    • skipDeclareExchange

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder skipDeclareExchange(String skipDeclareExchange)
      This can be used if we need to declare the queue but not the exchange. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      skipDeclareExchange - the value to set
      Returns:
      the dsl builder

    • skipDeclareQueue

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder skipDeclareQueue(boolean skipDeclareQueue)
      If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. The option is a: boolean type. Default: false Group: producer
      Parameters:
      skipDeclareQueue - the value to set
      Returns:
      the dsl builder

    • skipDeclareQueue

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointProducerBuilder skipDeclareQueue(String skipDeclareQueue)
      If true the producer will not declare and bind a queue. This can be used for directing messages via an existing routing key. The option will be converted to a boolean type. Default: false Group: producer
      Parameters:
      skipDeclareQueue - 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: boolean 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 boolean type. Default: false Group: producer
      Parameters:
      usePublisherConnection - the value to set
      Returns:
      the dsl builder