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

Interface SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointBuilder
Enclosing interface:
SpringRabbitMQEndpointBuilderFactory
public static interface SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Spring RabbitMQ component.

  • Method Details

    • basic

      default SpringRabbitMQEndpointBuilderFactory.SpringRabbitMQEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder 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 SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder 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

    • concurrentConsumers

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder concurrentConsumers(Integer concurrentConsumers)
      The number of consumers. The option is a: <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      concurrentConsumers - the value to set
      Returns:
      the dsl builder

    • concurrentConsumers

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder concurrentConsumers(String concurrentConsumers)
      The number of consumers. The option will be converted to a <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      concurrentConsumers - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder 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 SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder 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 SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder 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 SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder 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

    • maxConcurrentConsumers

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder maxConcurrentConsumers(Integer maxConcurrentConsumers)
      The maximum number of consumers (available only with SMLC). The option is a: <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      maxConcurrentConsumers - the value to set
      Returns:
      the dsl builder

    • maxConcurrentConsumers

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder maxConcurrentConsumers(String maxConcurrentConsumers)
      The maximum number of consumers (available only with SMLC). The option will be converted to a <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      maxConcurrentConsumers - the value to set
      Returns:
      the dsl builder

    • messageListenerContainerType

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder messageListenerContainerType(String messageListenerContainerType)
      The type of the MessageListenerContainer. The option is a: <code>java.lang.String</code> type. Default: DMLC Group: consumer (advanced)
      Parameters:
      messageListenerContainerType - the value to set
      Returns:
      the dsl builder

    • prefetchCount

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder prefetchCount(Integer prefetchCount)
      Tell the broker how many messages to send in a single request. Often this can be set quite high to improve throughput. The option is a: <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      prefetchCount - the value to set
      Returns:
      the dsl builder

    • prefetchCount

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder prefetchCount(String prefetchCount)
      Tell the broker how many messages to send in a single request. Often this can be set quite high to improve throughput. The option will be converted to a <code>java.lang.Integer</code> type. Group: consumer (advanced)
      Parameters:
      prefetchCount - the value to set
      Returns:
      the dsl builder

    • retry

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder retry(org.springframework.retry.interceptor.RetryOperationsInterceptor retry)
      Custom retry configuration to use. If this is configured then the other settings such as maximumRetryAttempts for retry are not in use. The option is a: <code>org.springframework.retry.interceptor.RetryOperationsInterceptor</code> type. Group: consumer (advanced)
      Parameters:
      retry - the value to set
      Returns:
      the dsl builder

    • retry

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder retry(String retry)
      Custom retry configuration to use. If this is configured then the other settings such as maximumRetryAttempts for retry are not in use. The option will be converted to a <code>org.springframework.retry.interceptor.RetryOperationsInterceptor</code> type. Group: consumer (advanced)
      Parameters:
      retry - the value to set
      Returns:
      the dsl builder

    • args

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder args(String key, Object value)
      Specify arguments for configuring the different RabbitMQ concepts, a different prefix is required for each element: arg.consumer. arg.exchange. arg.queue. arg.binding. arg.dlq.exchange. arg.dlq.queue. arg.dlq.binding. For example to declare a queue with message ttl argument: args=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 SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder args(Map values)
      Specify arguments for configuring the different RabbitMQ concepts, a different prefix is required for each element: arg.consumer. arg.exchange. arg.queue. arg.binding. arg.dlq.exchange. arg.dlq.queue. arg.dlq.binding. For example to declare a queue with message ttl argument: args=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

    • messageConverter

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder messageConverter(org.springframework.amqp.support.converter.MessageConverter messageConverter)
      To use a custom MessageConverter so you can be in control how to map to/from a org.springframework.amqp.core.Message. The option is a: <code>org.springframework.amqp.support.converter.MessageConverter</code> type. Group: advanced
      Parameters:
      messageConverter - the value to set
      Returns:
      the dsl builder

    • messageConverter

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder messageConverter(String messageConverter)
      To use a custom MessageConverter so you can be in control how to map to/from a org.springframework.amqp.core.Message. The option will be converted to a <code>org.springframework.amqp.support.converter.MessageConverter</code> type. Group: advanced
      Parameters:
      messageConverter - the value to set
      Returns:
      the dsl builder

    • messagePropertiesConverter

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder messagePropertiesConverter(org.apache.camel.component.springrabbit.MessagePropertiesConverter messagePropertiesConverter)
      To use a custom MessagePropertiesConverter so you can be in control how to map to/from a org.springframework.amqp.core.MessageProperties. The option is a: <code>org.apache.camel.component.springrabbit.MessagePropertiesConverter</code> type. Group: advanced
      Parameters:
      messagePropertiesConverter - the value to set
      Returns:
      the dsl builder

    • messagePropertiesConverter

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder messagePropertiesConverter(String messagePropertiesConverter)
      To use a custom MessagePropertiesConverter so you can be in control how to map to/from a org.springframework.amqp.core.MessageProperties. The option will be converted to a <code>org.apache.camel.component.springrabbit.MessagePropertiesConverter</code> type. Group: advanced
      Parameters:
      messagePropertiesConverter - the value to set
      Returns:
      the dsl builder

    • synchronous

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder synchronous(boolean synchronous)
      Sets whether synchronous processing should be strictly used. The option is a: <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      synchronous - the value to set
      Returns:
      the dsl builder

    • synchronous

      default SpringRabbitMQEndpointBuilderFactory.AdvancedSpringRabbitMQEndpointConsumerBuilder synchronous(String synchronous)
      Sets whether synchronous processing should be strictly used. The option will be converted to a <code>boolean</code> type. Default: false Group: advanced
      Parameters:
      synchronous - the value to set
      Returns:
      the dsl builder