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

Interface StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
All Known Subinterfaces:
StubEndpointBuilderFactory.AdvancedStubEndpointBuilder
Enclosing interface:
StubEndpointBuilderFactory
public static interface StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the Stub component.

  • Method Details

    • basic

      default StubEndpointBuilderFactory.StubEndpointConsumerBuilder basic()

    • bridgeErrorHandler

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • bridgeErrorHandler

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder bridgeErrorHandler(String bridgeErrorHandler)
      Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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 (advanced)
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder 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: org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exceptionHandler

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder 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 org.apache.camel.spi.ExceptionHandler type. Group: consumer (advanced)
      Parameters:
      exceptionHandler - the value to set
      Returns:
      the dsl builder

    • exchangePattern

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder exchangePattern(org.apache.camel.ExchangePattern exchangePattern)
      Sets the exchange pattern when the consumer creates an exchange. The option is a: org.apache.camel.ExchangePattern type. Group: consumer (advanced)
      Parameters:
      exchangePattern - the value to set
      Returns:
      the dsl builder

    • exchangePattern

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

    • limitConcurrentConsumers

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder limitConcurrentConsumers(boolean limitConcurrentConsumers)
      Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. The option is a: boolean type. Default: true Group: consumer (advanced)
      Parameters:
      limitConcurrentConsumers - the value to set
      Returns:
      the dsl builder

    • limitConcurrentConsumers

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder limitConcurrentConsumers(String limitConcurrentConsumers)
      Whether to limit the number of concurrentConsumers to the maximum of 500. By default, an exception will be thrown if an endpoint is configured with a greater number. You can disable that check by turning this option off. The option will be converted to a boolean type. Default: true Group: consumer (advanced)
      Parameters:
      limitConcurrentConsumers - the value to set
      Returns:
      the dsl builder

    • multipleConsumers

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder multipleConsumers(boolean multipleConsumers)
      Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      multipleConsumers - the value to set
      Returns:
      the dsl builder

    • multipleConsumers

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder multipleConsumers(String multipleConsumers)
      Specifies whether multiple consumers are allowed. If enabled, you can use SEDA for Publish-Subscribe messaging. That is, you can send a message to the SEDA queue and have each consumer receive a copy of the message. When enabled, this option should be specified on every consumer endpoint. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      multipleConsumers - the value to set
      Returns:
      the dsl builder

    • pollTimeout

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder pollTimeout(int pollTimeout)
      The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. The option is a: int type. Default: 1000 Group: consumer (advanced)
      Parameters:
      pollTimeout - the value to set
      Returns:
      the dsl builder

    • pollTimeout

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder pollTimeout(String pollTimeout)
      The timeout (in milliseconds) used when polling. When a timeout occurs, the consumer can check whether it is allowed to continue running. Setting a lower value allows the consumer to react more quickly upon shutdown. The option will be converted to a int type. Default: 1000 Group: consumer (advanced)
      Parameters:
      pollTimeout - the value to set
      Returns:
      the dsl builder

    • purgeWhenStopping

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder purgeWhenStopping(boolean purgeWhenStopping)
      Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded. The option is a: boolean type. Default: false Group: consumer (advanced)
      Parameters:
      purgeWhenStopping - the value to set
      Returns:
      the dsl builder

    • purgeWhenStopping

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder purgeWhenStopping(String purgeWhenStopping)
      Whether to purge the task queue when stopping the consumer/route. This allows to stop faster, as any pending messages on the queue is discarded. The option will be converted to a boolean type. Default: false Group: consumer (advanced)
      Parameters:
      purgeWhenStopping - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder browseLimit(int browseLimit)
      Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option is a: int type. Default: 100 Group: advanced
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder

    • browseLimit

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder browseLimit(String browseLimit)
      Maximum number of messages to keep in memory available for browsing. Use 0 for unlimited. The option will be converted to a int type. Default: 100 Group: advanced
      Parameters:
      browseLimit - the value to set
      Returns:
      the dsl builder

    • queue

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder queue(BlockingQueue<org.apache.camel.Exchange> queue)
      Define the queue instance which will be used by the endpoint. The option is a: java.util.concurrent.BlockingQueue<org.apache.camel.Exchange> type. Group: advanced
      Parameters:
      queue - the value to set
      Returns:
      the dsl builder

    • queue

      default StubEndpointBuilderFactory.AdvancedStubEndpointConsumerBuilder queue(String queue)
      Define the queue instance which will be used by the endpoint. The option will be converted to a java.util.concurrent.BlockingQueue<org.apache.camel.Exchange> type. Group: advanced
      Parameters:
      queue - the value to set
      Returns:
      the dsl builder