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

Interface RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder

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

    • Method Detail

      • bridgeErrorHandler

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder 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 (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer (advanced)
        Parameters:
        bridgeErrorHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder exceptionHandler​(org.apache.camel.spi.ExceptionHandler exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exceptionHandler

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder exceptionHandler​(String exceptionHandler)
        To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option will be converted to a <code>org.apache.camel.spi.ExceptionHandler</code> type. Group: consumer (advanced)
        Parameters:
        exceptionHandler - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder exchangePattern​(org.apache.camel.ExchangePattern exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option is a: <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • exchangePattern

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder exchangePattern​(String exchangePattern)
        Sets the exchange pattern when the consumer creates an exchange. The option will be converted to a <code>org.apache.camel.ExchangePattern</code> type. Group: consumer (advanced)
        Parameters:
        exchangePattern - the value to set
        Returns:
        the dsl builder

      • threadPoolSize

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

      • threadPoolSize

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

      • allowMessageBodySerialization

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        allowMessageBodySerialization - the value to set
        Returns:
        the dsl builder

      • allowMessageBodySerialization

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: advanced
        Parameters:
        allowMessageBodySerialization - the value to set
        Returns:
        the dsl builder

      • args

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder args​(String key,
                                                                                    Object value)
        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. The option is multivalued, and you can use the args(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder

      • args

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder args​(Map values)
        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. The option is multivalued, and you can use the args(String, Object) method to add a value (call the method multiple times to set more values). Group: advanced
        Parameters:
        values - the values
        Returns:
        the dsl builder

      • clientProperties

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder clientProperties​(String clientProperties)
        Connection client properties (client info used in negotiating with the server). The option will be converted to 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 RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder 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

      • connectionFactoryExceptionHandler

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder connectionFactoryExceptionHandler​(String connectionFactoryExceptionHandler)
        Custom rabbitmq ExceptionHandler for ConnectionFactory. The option will be converted to a <code>com.rabbitmq.client.ExceptionHandler</code> type. Group: advanced
        Parameters:
        connectionFactoryExceptionHandler - the value to set
        Returns:
        the dsl builder

      • networkRecoveryInterval

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

      • networkRecoveryInterval

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

      • requestedChannelMax

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

      • requestedChannelMax

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder requestedChannelMax​(String requestedChannelMax)
        Connection requested channel max (max number of channels offered). The option will be converted to a <code>int</code> type. Default: 2047 Group: advanced
        Parameters:
        requestedChannelMax - the value to set
        Returns:
        the dsl builder

      • requestedHeartbeat

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

      • requestTimeout

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

      • requestTimeoutCheckerInterval

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

      • requestTimeoutCheckerInterval

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder requestTimeoutCheckerInterval​(String requestTimeoutCheckerInterval)
        Set requestTimeoutCheckerInterval for inOut exchange. The option will be converted to a <code>long</code> type. Default: 1000 Group: advanced
        Parameters:
        requestTimeoutCheckerInterval - the value to set
        Returns:
        the dsl builder

      • topologyRecoveryEnabled

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

      • topologyRecoveryEnabled

        default RabbitMQEndpointBuilderFactory.AdvancedRabbitMQEndpointConsumerBuilder topologyRecoveryEnabled​(String topologyRecoveryEnabled)
        Enables connection topology recovery (should topology recovery be performed). The option will be converted to a <code>java.lang.Boolean</code> type. Group: advanced
        Parameters:
        topologyRecoveryEnabled - the value to set
        Returns:
        the dsl builder

      • transferException

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

      • transferException

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