Interface SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
SedaEndpointBuilderFactory.AdvancedSedaEndpointBuilder
- Enclosing interface:
- SedaEndpointBuilderFactory
public static interface SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Advanced builder for endpoint consumers for the SEDA component.
-
Method Summary
Modifier and TypeMethodDescriptionbasic()
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.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.exceptionHandler
(String exceptionHandler) To let the consumer use a custom ExceptionHandler.exceptionHandler
(org.apache.camel.spi.ExceptionHandler exceptionHandler) To let the consumer use a custom ExceptionHandler.exchangePattern
(String exchangePattern) Sets the exchange pattern when the consumer creates an exchange.exchangePattern
(org.apache.camel.ExchangePattern exchangePattern) Sets the exchange pattern when the consumer creates an exchange.limitConcurrentConsumers
(boolean limitConcurrentConsumers) Whether to limit the number of concurrentConsumers to the maximum of 500.limitConcurrentConsumers
(String limitConcurrentConsumers) Whether to limit the number of concurrentConsumers to the maximum of 500.multipleConsumers
(boolean multipleConsumers) Specifies whether multiple consumers are allowed.multipleConsumers
(String multipleConsumers) Specifies whether multiple consumers are allowed.pollTimeout
(int pollTimeout) The timeout (in milliseconds) used when polling.pollTimeout
(String pollTimeout) The timeout (in milliseconds) used when polling.purgeWhenStopping
(boolean purgeWhenStopping) Whether to purge the task queue when stopping the consumer/route.purgeWhenStopping
(String purgeWhenStopping) Whether to purge the task queue when stopping the consumer/route.Define the queue instance which will be used by the endpoint.queue
(BlockingQueue<org.apache.camel.Exchange> queue) Define the queue instance which will be used by the endpoint.Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder
doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri
Methods inherited from interface org.apache.camel.EndpointConsumerResolver
resolve, resolve
-
Method Details
-
basic
-
bridgeErrorHandler
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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
-
limitConcurrentConsumers
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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: <code>boolean</code> type. Default: true Group: consumer (advanced)- Parameters:
limitConcurrentConsumers
- the value to set- Returns:
- the dsl builder
-
limitConcurrentConsumers
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 <code>boolean</code> type. Default: true Group: consumer (advanced)- Parameters:
limitConcurrentConsumers
- the value to set- Returns:
- the dsl builder
-
multipleConsumers
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer (advanced)- Parameters:
multipleConsumers
- the value to set- Returns:
- the dsl builder
-
multipleConsumers
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer (advanced)- Parameters:
multipleConsumers
- the value to set- Returns:
- the dsl builder
-
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: <code>int</code> type. Default: 1000 Group: consumer (advanced)- Parameters:
pollTimeout
- the value to set- Returns:
- the dsl builder
-
pollTimeout
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 <code>int</code> type. Default: 1000 Group: consumer (advanced)- Parameters:
pollTimeout
- the value to set- Returns:
- the dsl builder
-
purgeWhenStopping
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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: <code>boolean</code> type. Default: false Group: consumer (advanced)- Parameters:
purgeWhenStopping
- the value to set- Returns:
- the dsl builder
-
purgeWhenStopping
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder 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 <code>boolean</code> type. Default: false Group: consumer (advanced)- Parameters:
purgeWhenStopping
- the value to set- Returns:
- the dsl builder
-
queue
default SedaEndpointBuilderFactory.AdvancedSedaEndpointConsumerBuilder queue(BlockingQueue<org.apache.camel.Exchange> queue) Define the queue instance which will be used by the endpoint. The option is a: <code>java.util.concurrent.BlockingQueue<org.apache.camel.Exchange></code> type. Group: advanced- Parameters:
queue
- the value to set- Returns:
- the dsl builder
-
queue
Define the queue instance which will be used by the endpoint. The option will be converted to a <code>java.util.concurrent.BlockingQueue<org.apache.camel.Exchange></code> type. Group: advanced- Parameters:
queue
- the value to set- Returns:
- the dsl builder
-