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: java.lang.String type. Group: common
      • 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: java.lang.Boolean type. Default: true Group: common
      • 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 java.lang.Boolean type. Default: true Group: common
      • connectionFactory

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder connectionFactory​(Object 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: com.rabbitmq.client.ConnectionFactory type. Group: common
      • 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 com.rabbitmq.client.ConnectionFactory type. Group: common
      • 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: boolean type. Default: true Group: common
      • 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 boolean type. Default: true Group: common
      • 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: boolean type. Default: false Group: common
      • 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 boolean type. Default: false Group: common
      • 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: boolean type. Default: false Group: common
      • bridgeErrorHandler

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder 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: boolean type. Default: false Group: consumer
      • bridgeErrorHandler

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder bridgeErrorHandler​(String 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 will be converted to a boolean type. Default: false Group: consumer
      • 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: int type. Default: 1 Group: consumer
      • 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: boolean type. Default: false Group: consumer
      • 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 boolean type. Default: false Group: consumer
      • 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: int type. Group: consumer
      • 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 int type. Group: consumer
      • 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: boolean type. Default: false Group: consumer
      • 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 boolean type. Default: false Group: consumer
      • 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: boolean type. Default: false Group: consumer
      • 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 boolean type. Default: false Group: consumer
      • 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: int type. Group: consumer
      • 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 int type. Group: consumer
      • 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: boolean type. Default: false Group: consumer
      • 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 boolean type. Default: false Group: consumer
      • allowMessageBodySerialization

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder allowMessageBodySerialization​(boolean allowMessageBodySerialization)
        Whether to allow Java serialization of the message body or not. If this value is true, the message body will be serialized on the producer side using Java serialization, if no type converter can handle the message body. On the consumer side, it will deserialize the message body if this value is true and the message contains a CamelSerialize header. Setting this value to true may introduce a security vulnerability as it allows an attacker to attempt to deserialize to a gadget object which could result in a RCE or other security vulnerability. The option is a: boolean type. Default: false Group: allowMessageBodySerialization
      • allowMessageBodySerialization

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointConsumerBuilder allowMessageBodySerialization​(String allowMessageBodySerialization)
        Whether to allow Java serialization of the message body or not. If this value is true, the message body will be serialized on the producer side using Java serialization, if no type converter can handle the message body. On the consumer side, it will deserialize the message body if this value is true and the message contains a CamelSerialize header. Setting this value to true may introduce a security vulnerability as it allows an attacker to attempt to deserialize to a gadget object which could result in a RCE or other security vulnerability. The option will be converted to a boolean type. Default: false Group: allowMessageBodySerialization