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

Interface RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
    All Known Subinterfaces:
    RabbitMQEndpointBuilderFactory.RabbitMQEndpointBuilder
    Enclosing interface:
    RabbitMQEndpointBuilderFactory
    public static interface RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder
extends org.apache.camel.builder.EndpointProducerBuilder
    Builder for endpoint producers for the RabbitMQ component.

    • Method Detail

      • addresses

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder 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.RabbitMQEndpointProducerBuilder 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.RabbitMQEndpointProducerBuilder 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.RabbitMQEndpointProducerBuilder 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.RabbitMQEndpointProducerBuilder 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.RabbitMQEndpointProducerBuilder 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: <code>com.rabbitmq.client.ConnectionFactory</code> type. Group: common
        Parameters:
        connectionFactory - the value to set
        Returns:
        the dsl builder

      • connectionFactory

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

      • additionalHeaders

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

      • additionalHeaders

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder additionalHeaders​(String additionalHeaders)
        Map of additional headers. These headers will be set only when the 'allowCustomHeaders' is set to true. The option will be converted to 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 RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder 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. 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

      • additionalProperties

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder additionalProperties​(String 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. The option will be converted to 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

      • allowCustomHeaders

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder allowCustomHeaders​(boolean allowCustomHeaders)
        Allow pass custom values to header. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        allowCustomHeaders - the value to set
        Returns:
        the dsl builder

      • allowCustomHeaders

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder allowCustomHeaders​(String allowCustomHeaders)
        Allow pass custom values to header. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        allowCustomHeaders - the value to set
        Returns:
        the dsl builder

      • allowNullHeaders

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

      • bridgeEndpoint

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder bridgeEndpoint​(boolean bridgeEndpoint)
        If the bridgeEndpoint is true, the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY. The option is a: <code>boolean</code> type. Default: false Group: producer
        Parameters:
        bridgeEndpoint - the value to set
        Returns:
        the dsl builder

      • bridgeEndpoint

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder bridgeEndpoint​(String bridgeEndpoint)
        If the bridgeEndpoint is true, the producer will ignore the message header of rabbitmq.EXCHANGE_NAME and rabbitmq.ROUTING_KEY. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
        Parameters:
        bridgeEndpoint - the value to set
        Returns:
        the dsl builder

      • channelPoolMaxSize

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

      • channelPoolMaxSize

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder channelPoolMaxSize​(String channelPoolMaxSize)
        Get maximum number of opened channel in pool. The option will be converted to a <code>int</code> type. Default: 10 Group: producer
        Parameters:
        channelPoolMaxSize - the value to set
        Returns:
        the dsl builder

      • channelPoolMaxWait

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

      • channelPoolMaxWait

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder channelPoolMaxWait​(String channelPoolMaxWait)
        Set the maximum number of milliseconds to wait for a channel from the pool. The option will be converted to a <code>long</code> type. Default: 1000 Group: producer
        Parameters:
        channelPoolMaxWait - the value to set
        Returns:
        the dsl builder

      • guaranteedDeliveries

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

      • guaranteedDeliveries

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

      • immediate

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

      • immediate

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

      • lazyStartProducer

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

      • lazyStartProducer

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

      • mandatory

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

      • mandatory

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

      • publisherAcknowledgements

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

      • publisherAcknowledgements

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

      • publisherAcknowledgementsTimeout

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

      • publisherAcknowledgementsTimeout

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder publisherAcknowledgementsTimeout​(String publisherAcknowledgementsTimeout)
        The amount of time in milliseconds to wait for a basic.ack response from RabbitMQ server. The option will be converted to a <code>long</code> type. Group: producer
        Parameters:
        publisherAcknowledgementsTimeout - the value to set
        Returns:
        the dsl builder

      • trustManager

        default RabbitMQEndpointBuilderFactory.RabbitMQEndpointProducerBuilder trustManager​(Object 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

      • trustManager

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