Package org.apache.camel.builder.component.dsl

Interface RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder

All Superinterfaces:
ComponentBuilder<org.apache.camel.component.rabbitmq.RabbitMQComponent>
All Known Implementing Classes:
RabbitmqComponentBuilderFactory.RabbitmqComponentBuilderImpl
Enclosing interface:
RabbitmqComponentBuilderFactory
public static interface RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder extends ComponentBuilder<org.apache.camel.component.rabbitmq.RabbitMQComponent>
Builder for the RabbitMQ component.

  • Method Details

    • addresses

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder addresses(String addresses)
      If this option is set, camel-rabbitmq will try to create connection based on the setting of option addresses. The addresses value is a string which looks like server1:12345, server2:12345. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      addresses - the value to set
      Returns:
      the dsl builder

    • autoDelete

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder autoDelete(boolean autoDelete)
      If it is true, the exchange will be deleted when it is no longer in use. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      autoDelete - the value to set
      Returns:
      the dsl builder

    • connectionFactory

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder connectionFactory(com.rabbitmq.client.ConnectionFactory connectionFactory)
      To use a custom RabbitMQ connection factory. When this option is set, all connection options (connectionTimeout, requestedChannelMax...) set on URI are not used. The option is a: <code>com.rabbitmq.client.ConnectionFactory</code> type. Group: common
      Parameters:
      connectionFactory - the value to set
      Returns:
      the dsl builder

    • deadLetterExchange

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder deadLetterExchange(String deadLetterExchange)
      The name of the dead letter exchange. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      deadLetterExchange - the value to set
      Returns:
      the dsl builder

    • deadLetterExchangeType

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder deadLetterExchangeType(String deadLetterExchangeType)
      The type of the dead letter exchange. The option is a: <code>java.lang.String</code> type. Default: direct Group: common
      Parameters:
      deadLetterExchangeType - the value to set
      Returns:
      the dsl builder

    • deadLetterQueue

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder deadLetterQueue(String deadLetterQueue)
      The name of the dead letter queue. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      deadLetterQueue - the value to set
      Returns:
      the dsl builder

    • deadLetterRoutingKey

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder deadLetterRoutingKey(String deadLetterRoutingKey)
      The routing key for the dead letter exchange. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      deadLetterRoutingKey - the value to set
      Returns:
      the dsl builder

    • declare

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder declare(boolean declare)
      If the option is true, camel declare the exchange and queue name and bind them together. If the option is false, camel won't declare the exchange and queue name on the server. The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      declare - the value to set
      Returns:
      the dsl builder

    • durable

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder durable(boolean durable)
      If we are declaring a durable exchange (the exchange will survive a server restart). The option is a: <code>boolean</code> type. Default: true Group: common
      Parameters:
      durable - the value to set
      Returns:
      the dsl builder

    • exclusive

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder exclusive(boolean exclusive)
      Exclusive queues may only be accessed by the current connection, and are deleted when that connection closes. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      exclusive - the value to set
      Returns:
      the dsl builder

    • hostname

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder hostname(String hostname)
      The hostname of the running RabbitMQ instance or cluster. The option is a: <code>java.lang.String</code> type. Group: common
      Parameters:
      hostname - the value to set
      Returns:
      the dsl builder

    • passive

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder passive(boolean passive)
      Passive queues depend on the queue already to be available at RabbitMQ. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      passive - the value to set
      Returns:
      the dsl builder

    • portNumber

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder portNumber(int portNumber)
      Port number for the host with the running rabbitmq instance or cluster. The option is a: <code>int</code> type. Default: 5672 Group: common
      Parameters:
      portNumber - the value to set
      Returns:
      the dsl builder

    • skipExchangeDeclare

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder skipExchangeDeclare(boolean skipExchangeDeclare)
      This can be used if we need to declare the queue but not the exchange. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      skipExchangeDeclare - the value to set
      Returns:
      the dsl builder

    • skipQueueBind

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder skipQueueBind(boolean skipQueueBind)
      If true the queue will not be bound to the exchange after declaring it. The option is a: <code>boolean</code> type. Default: false Group: common
      Parameters:
      skipQueueBind - the value to set
      Returns:
      the dsl builder

    • skipQueueDeclare

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder skipQueueDeclare(boolean skipQueueDeclare)
      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: <code>boolean</code> type. Default: false Group: common
      Parameters:
      skipQueueDeclare - the value to set
      Returns:
      the dsl builder

    • vhost

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder vhost(String vhost)
      The vhost for the channel. The option is a: <code>java.lang.String</code> type. Default: / Group: common
      Parameters:
      vhost - the value to set
      Returns:
      the dsl builder

    • autoAck

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder autoAck(boolean autoAck)
      If messages should be auto acknowledged. The option is a: <code>boolean</code> type. Default: true Group: consumer
      Parameters:
      autoAck - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder 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

    • exclusiveConsumer

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder exclusiveConsumer(boolean exclusiveConsumer)
      Request exclusive access to the queue (meaning only this consumer can access the queue). This is useful when you want a long-lived shared queue to be temporarily accessible by just one consumer. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      exclusiveConsumer - the value to set
      Returns:
      the dsl builder

    • prefetchCount

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder prefetchCount(int prefetchCount)
      The maximum number of messages that the server will deliver, 0 if unlimited. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time. The option is a: <code>int</code> type. Group: consumer
      Parameters:
      prefetchCount - the value to set
      Returns:
      the dsl builder

    • prefetchEnabled

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder prefetchEnabled(boolean prefetchEnabled)
      Enables the quality of service on the RabbitMQConsumer side. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      prefetchEnabled - the value to set
      Returns:
      the dsl builder

    • prefetchGlobal

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder prefetchGlobal(boolean prefetchGlobal)
      If the settings should be applied to the entire channel rather than each consumer You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      prefetchGlobal - the value to set
      Returns:
      the dsl builder

    • prefetchSize

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder prefetchSize(int prefetchSize)
      The maximum amount of content (measured in octets) that the server will deliver, 0 if unlimited. You need to specify the option of prefetchSize, prefetchCount, prefetchGlobal at the same time. The option is a: <code>int</code> type. Group: consumer
      Parameters:
      prefetchSize - the value to set
      Returns:
      the dsl builder

    • recoverFromDeclareException

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder recoverFromDeclareException(boolean recoverFromDeclareException)
      Decides whether an exception during declaration of exchanges or queues is recoverable or not. If the option is false, camel will throw an exception when starting the consumer, which will interrupt application startup (e.g. in the case when the exchange / queue is already declared in RabbitMQ and has incompatible configuration). If set to true, the consumer will try to reconnect periodically. The option is a: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      recoverFromDeclareException - the value to set
      Returns:
      the dsl builder

    • threadPoolSize

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder threadPoolSize(int threadPoolSize)
      The consumer uses a Thread Pool Executor with a fixed number of threads. This setting allows you to set that number of threads. The option is a: <code>int</code> type. Default: 10 Group: consumer (advanced)
      Parameters:
      threadPoolSize - the value to set
      Returns:
      the dsl builder

    • additionalHeaders

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder additionalHeaders(Map<String,Object> additionalHeaders)
      Map of additional headers. These headers will be set only when the 'allowCustomHeaders' is set to true. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: producer
      Parameters:
      additionalHeaders - the value to set
      Returns:
      the dsl builder

    • additionalProperties

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder additionalProperties(Map<String,Object> additionalProperties)
      Map of additional properties. These are standard RabbitMQ properties as defined in com.rabbitmq.client.AMQP.BasicProperties The map keys should be from org.apache.camel.component.rabbitmq.RabbitMQConstants. Any other keys will be ignored. When the message already contains these headers they will be given precedence over these properties. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: producer
      Parameters:
      additionalProperties - the value to set
      Returns:
      the dsl builder

    • allowNullHeaders

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder allowNullHeaders(boolean allowNullHeaders)
      Allow pass null values to header. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      allowNullHeaders - the value to set
      Returns:
      the dsl builder

    • channelPoolMaxSize

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder channelPoolMaxSize(int channelPoolMaxSize)
      Get maximum number of opened channel in pool. The option is a: <code>int</code> type. Default: 10 Group: producer
      Parameters:
      channelPoolMaxSize - the value to set
      Returns:
      the dsl builder

    • channelPoolMaxWait

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder channelPoolMaxWait(long channelPoolMaxWait)
      Set the maximum number of milliseconds to wait for a channel from the pool. The option is a: <code>long</code> type. Default: 1000 Group: producer
      Parameters:
      channelPoolMaxWait - the value to set
      Returns:
      the dsl builder

    • guaranteedDeliveries

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder guaranteedDeliveries(boolean guaranteedDeliveries)
      When true, an exception will be thrown when the message cannot be delivered (basic.return) and the message is marked as mandatory. PublisherAcknowledgement will also be activated in this case. See also publisher acknowledgements - When will messages be confirmed. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      guaranteedDeliveries - the value to set
      Returns:
      the dsl builder

    • immediate

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder immediate(boolean immediate)
      This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set, the server will return an undeliverable message with a Return method. If this flag is zero, the server will queue the message, but with no guarantee that it will ever be consumed. If the header is present rabbitmq.IMMEDIATE it will override this option. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      immediate - the value to set
      Returns:
      the dsl builder

    • lazyStartProducer

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder 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

    • mandatory

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder mandatory(boolean mandatory)
      This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set, the server will return an unroutable message with a Return method. If this flag is zero, the server silently drops the message. If the header is present rabbitmq.MANDATORY it will override this option. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      mandatory - the value to set
      Returns:
      the dsl builder

    • publisherAcknowledgements

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder publisherAcknowledgements(boolean publisherAcknowledgements)
      When true, the message will be published with publisher acknowledgements turned on. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      publisherAcknowledgements - the value to set
      Returns:
      the dsl builder

    • publisherAcknowledgementsTimeout

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder publisherAcknowledgementsTimeout(long publisherAcknowledgementsTimeout)
      The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server. The option is a: <code>long</code> type. Group: producer
      Parameters:
      publisherAcknowledgementsTimeout - the value to set
      Returns:
      the dsl builder

    • args

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder args(Map<String,Object> args)
      Specify arguments for configuring the different RabbitMQ concepts, a different prefix is required for each: Exchange: arg.exchange. Queue: arg.queue. Binding: arg.binding. DLQ: arg.dlq.queue. DLQ Binding: arg.dlq.binding. For example to declare a queue with message ttl argument: http://localhost:5672/exchange/queueargs=arg.queue.x-message-ttl=60000. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: advanced
      Parameters:
      args - the value to set
      Returns:
      the dsl builder

    • autoDetectConnectionFactory

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder autoDetectConnectionFactory(boolean autoDetectConnectionFactory)
      Whether to auto-detect looking up RabbitMQ connection factory from the registry. When enabled and a single instance of the connection factory is found then it will be used. An explicit connection factory can be configured on the component or endpoint level which takes precedence. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autoDetectConnectionFactory - the value to set
      Returns:
      the dsl builder

    • automaticRecoveryEnabled

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder automaticRecoveryEnabled(Boolean automaticRecoveryEnabled)
      Enables connection automatic recovery (uses connection implementation that performs automatic recovery when connection shutdown is not initiated by the application). The option is a: <code>java.lang.Boolean</code> type. Group: advanced
      Parameters:
      automaticRecoveryEnabled - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder 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

    • clientProperties

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder clientProperties(Map<String,Object> clientProperties)
      Connection client properties (client info used in negotiating with the server). The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: advanced
      Parameters:
      clientProperties - the value to set
      Returns:
      the dsl builder

    • connectionFactoryExceptionHandler

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder connectionFactoryExceptionHandler(com.rabbitmq.client.ExceptionHandler connectionFactoryExceptionHandler)
      Custom rabbitmq ExceptionHandler for ConnectionFactory. The option is a: <code>com.rabbitmq.client.ExceptionHandler</code> type. Group: advanced
      Parameters:
      connectionFactoryExceptionHandler - the value to set
      Returns:
      the dsl builder

    • connectionTimeout

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder connectionTimeout(int connectionTimeout)
      Connection timeout. The option is a: <code>int</code> type. Default: 60000 Group: advanced
      Parameters:
      connectionTimeout - the value to set
      Returns:
      the dsl builder

    • networkRecoveryInterval

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder networkRecoveryInterval(Integer networkRecoveryInterval)
      Network recovery interval in milliseconds (interval used when recovering from network failure). The option is a: <code>java.lang.Integer</code> type. Default: 5000 Group: advanced
      Parameters:
      networkRecoveryInterval - the value to set
      Returns:
      the dsl builder

    • requestedChannelMax

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder requestedChannelMax(int requestedChannelMax)
      Connection requested channel max (max number of channels offered). The option is a: <code>int</code> type. Default: 2047 Group: advanced
      Parameters:
      requestedChannelMax - the value to set
      Returns:
      the dsl builder

    • requestedFrameMax

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder requestedFrameMax(int requestedFrameMax)
      Connection requested frame max (max size of frame offered). The option is a: <code>int</code> type. Default: 0 Group: advanced
      Parameters:
      requestedFrameMax - the value to set
      Returns:
      the dsl builder

    • requestedHeartbeat

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder requestedHeartbeat(int requestedHeartbeat)
      Connection requested heartbeat (heart-beat in seconds offered). The option is a: <code>int</code> type. Default: 60 Group: advanced
      Parameters:
      requestedHeartbeat - the value to set
      Returns:
      the dsl builder

    • requestTimeout

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder requestTimeout(long requestTimeout)
      Set timeout for waiting for a reply when using the InOut Exchange Pattern (in milliseconds). The option is a: <code>long</code> type. Default: 20000 Group: advanced
      Parameters:
      requestTimeout - the value to set
      Returns:
      the dsl builder

    • requestTimeoutCheckerInterval

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder requestTimeoutCheckerInterval(long requestTimeoutCheckerInterval)
      Set requestTimeoutCheckerInterval for inOut exchange. The option is a: <code>long</code> type. Default: 1000 Group: advanced
      Parameters:
      requestTimeoutCheckerInterval - the value to set
      Returns:
      the dsl builder

    • topologyRecoveryEnabled

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder topologyRecoveryEnabled(Boolean topologyRecoveryEnabled)
      Enables connection topology recovery (should topology recovery be performed). The option is a: <code>java.lang.Boolean</code> type. Group: advanced
      Parameters:
      topologyRecoveryEnabled - the value to set
      Returns:
      the dsl builder

    • transferException

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder transferException(boolean transferException)
      When true and an inOut Exchange failed on the consumer side send the caused Exception back in the response. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      transferException - the value to set
      Returns:
      the dsl builder

    • password

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder password(String password)
      Password for authenticated access. The option is a: <code>java.lang.String</code> type. Default: guest Group: security
      Parameters:
      password - the value to set
      Returns:
      the dsl builder

    • sslProtocol

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder sslProtocol(String sslProtocol)
      Enables SSL on connection, accepted value are true, TLS and 'SSLv3. The option is a: <code>java.lang.String</code> type. Group: security
      Parameters:
      sslProtocol - the value to set
      Returns:
      the dsl builder

    • trustManager

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder trustManager(TrustManager trustManager)
      Configure SSL trust manager, SSL should be enabled for this option to be effective. The option is a: <code>javax.net.ssl.TrustManager</code> type. Group: security
      Parameters:
      trustManager - the value to set
      Returns:
      the dsl builder

    • username

      default RabbitmqComponentBuilderFactory.RabbitmqComponentBuilder username(String username)
      Username in case of authenticated access. The option is a: <code>java.lang.String</code> type. Default: guest Group: security
      Parameters:
      username - the value to set
      Returns:
      the dsl builder