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

Interface RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    All Known Subinterfaces:
    RabbitMQEndpointBuilderFactory.RabbitMQEndpointBuilder
    Enclosing interface:
    RabbitMQEndpointBuilderFactory
    public static interface RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint consumers for the RabbitMQ component.

    • Method Detail

      • addresses

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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 RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • autoDelete

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

      • automaticRecoveryEnabled

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder automaticRecoveryEnabled​(Boolean automaticRecoveryEnabled)
        Enables connection automatic recovery (uses connection implementation that performs automatic recovery when existing connection has failures). The option is a: <code>java.lang.Boolean</code> type. Default: true Group: common
        Parameters:
        automaticRecoveryEnabled - the value to set
        Returns:
        the dsl builder

      • automaticRecoveryEnabled

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder automaticRecoveryEnabled​(String automaticRecoveryEnabled)
        Enables connection automatic recovery (uses connection implementation that performs automatic recovery when existing connection has failures). The option will be converted to a <code>java.lang.Boolean</code> type. Default: true Group: common
        Parameters:
        automaticRecoveryEnabled - the value to set
        Returns:
        the dsl builder

      • connectionFactory

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • connectionFactory

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder connectionFactory​(String 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 will be converted to a <code>com.rabbitmq.client.ConnectionFactory</code> type. Group: common
        Parameters:
        connectionFactory - the value to set
        Returns:
        the dsl builder

      • deadLetterExchangeType

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • declare

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • declare

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder declare​(String 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 will be converted to a <code>boolean</code> type. Default: true Group: common
        Parameters:
        declare - the value to set
        Returns:
        the dsl builder

      • durable

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • durable

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

      • exclusive

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • exclusive

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

      • passive

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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 RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder portNumber​(int portNumber)
        Port number for the host with the running rabbitmq instance or cluster. Default value is 5672. The option is a: <code>int</code> type. Group: common
        Parameters:
        portNumber - the value to set
        Returns:
        the dsl builder

      • portNumber

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

      • routingKey

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder routingKey​(String routingKey)
        The routing key to use when binding a consumer queue to the exchange. For producer routing keys, you set the header rabbitmq.ROUTING_KEY. The option is a: <code>java.lang.String</code> type. Group: common
        Parameters:
        routingKey - the value to set
        Returns:
        the dsl builder

      • skipDlqDeclare

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder skipDlqDeclare​(boolean skipDlqDeclare)
        If true the producer will not declare and bind a dead letter queue. This can be used if you have also DLQ rabbitmq consumer and you want to avoid argument clashing between Producer and Consumer. This option have no effect, if DLQ configured (deadLetterExchange option is not set). The option is a: <code>boolean</code> type. Default: false Group: common
        Parameters:
        skipDlqDeclare - the value to set
        Returns:
        the dsl builder

      • skipDlqDeclare

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder skipDlqDeclare​(String skipDlqDeclare)
        If true the producer will not declare and bind a dead letter queue. This can be used if you have also DLQ rabbitmq consumer and you want to avoid argument clashing between Producer and Consumer. This option have no effect, if DLQ configured (deadLetterExchange option is not set). The option will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        skipDlqDeclare - the value to set
        Returns:
        the dsl builder

      • skipExchangeDeclare

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • skipExchangeDeclare

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

      • skipQueueBind

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • skipQueueBind

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

      • skipQueueDeclare

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • skipQueueDeclare

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder skipQueueDeclare​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: common
        Parameters:
        skipQueueDeclare - the value to set
        Returns:
        the dsl builder

      • concurrentConsumers

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder concurrentConsumers​(int concurrentConsumers)
        Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). The option is a: <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        concurrentConsumers - the value to set
        Returns:
        the dsl builder

      • concurrentConsumers

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder concurrentConsumers​(String concurrentConsumers)
        Number of concurrent consumers when consuming from broker. (eg similar as to the same option for the JMS component). The option will be converted to a <code>int</code> type. Default: 1 Group: consumer
        Parameters:
        concurrentConsumers - the value to set
        Returns:
        the dsl builder

      • consumerTag

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder consumerTag​(String consumerTag)
        Specify a client-generated consumer tag to establish context when invoking the consume operation. The option is a: <code>java.lang.String</code> type. Group: consumer
        Parameters:
        consumerTag - the value to set
        Returns:
        the dsl builder

      • exclusiveConsumer

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • exclusiveConsumer

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder exclusiveConsumer​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        exclusiveConsumer - the value to set
        Returns:
        the dsl builder

      • prefetchCount

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • prefetchCount

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder prefetchCount​(String 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 will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        prefetchCount - the value to set
        Returns:
        the dsl builder

      • prefetchEnabled

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • prefetchEnabled

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder prefetchEnabled​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        prefetchEnabled - the value to set
        Returns:
        the dsl builder

      • prefetchGlobal

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • prefetchGlobal

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder prefetchGlobal​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        prefetchGlobal - the value to set
        Returns:
        the dsl builder

      • prefetchSize

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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

      • prefetchSize

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder prefetchSize​(String 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 will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        prefetchSize - the value to set
        Returns:
        the dsl builder

      • recoverFromDeclareException

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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: true Group: consumer
        Parameters:
        recoverFromDeclareException - the value to set
        Returns:
        the dsl builder

      • recoverFromDeclareException

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder recoverFromDeclareException​(String 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 will be converted to a <code>boolean</code> type. Default: true Group: consumer
        Parameters:
        recoverFromDeclareException - the value to set
        Returns:
        the dsl builder

      • reQueue

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder reQueue​(boolean reQueue)
        This is used by the consumer to control rejection of the message. When the consumer is complete processing the exchange, and if the exchange failed, then the consumer is going to reject the message from the RabbitMQ broker. If the header CamelRabbitmqRequeue is present then the value of the header will be used, otherwise this endpoint value is used as fallback. If the value is false (by default) then the message is discarded/dead-lettered. If the value is true, then the message is re-queued. The option is a: <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        reQueue - the value to set
        Returns:
        the dsl builder

      • reQueue

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder reQueue​(String reQueue)
        This is used by the consumer to control rejection of the message. When the consumer is complete processing the exchange, and if the exchange failed, then the consumer is going to reject the message from the RabbitMQ broker. If the header CamelRabbitmqRequeue is present then the value of the header will be used, otherwise this endpoint value is used as fallback. If the value is false (by default) then the message is discarded/dead-lettered. If the value is true, then the message is re-queued. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer
        Parameters:
        reQueue - the value to set
        Returns:
        the dsl builder

      • trustManager

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