Interface IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
IronMQEndpointBuilderFactory.IronMQEndpointBuilder
- Enclosing interface:
- IronMQEndpointBuilderFactory
public static interface IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder
extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the IronMQ component.
-
Method Summary
Modifier and TypeMethodDescriptionadvanced()
backoffErrorThreshold
(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffErrorThreshold
(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffIdleThreshold
(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.backoffMultiplier
(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.backoffMultiplier
(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.batchDelete
(boolean batchDelete) Should messages be deleted in one batch.batchDelete
(String batchDelete) Should messages be deleted in one batch.client
(io.iron.ironmq.Client client) Reference to a io.iron.ironmq.Client in the Registry.Reference to a io.iron.ironmq.Client in the Registry.concurrentConsumers
(int concurrentConsumers) The number of concurrent consumers.concurrentConsumers
(String concurrentConsumers) The number of concurrent consumers.delay
(long delay) Milliseconds before the next poll.Milliseconds before the next poll.greedy
(boolean greedy) If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.initialDelay
(long initialDelay) Milliseconds before the first poll starts.initialDelay
(String initialDelay) Milliseconds before the first poll starts.ironMQCloud
(String ironMQCloud) IronMq Cloud url.maxMessagesPerPoll
(int maxMessagesPerPoll) Number of messages to poll pr.maxMessagesPerPoll
(String maxMessagesPerPoll) Number of messages to poll pr.preserveHeaders
(boolean preserveHeaders) Should message headers be preserved when publishing messages.preserveHeaders
(String preserveHeaders) Should message headers be preserved when publishing messages.IronMQ projectId.repeatCount
(long repeatCount) Specifies a maximum limit of number of fires.repeatCount
(String repeatCount) Specifies a maximum limit of number of fires.runLoggingLevel
(String runLoggingLevel) The consumer logs a start/complete log line when it polls.runLoggingLevel
(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls.scheduledExecutorService
(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.scheduledExecutorService
(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer.To use a cron scheduler from either camel-spring or camel-quartz component.To use a cron scheduler from either camel-spring or camel-quartz component.schedulerProperties
(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.schedulerProperties
(Map values) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.sendEmptyMessageWhenIdle
(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.sendEmptyMessageWhenIdle
(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead.startScheduler
(boolean startScheduler) Whether the scheduler should be auto started.startScheduler
(String startScheduler) Whether the scheduler should be auto started.timeout
(int timeout) After timeout (in seconds), item will be placed back onto the queue.After timeout (in seconds), item will be placed back onto the queue.Time unit for initialDelay and delay options.Time unit for initialDelay and delay options.IronMQ token.useFixedDelay
(boolean useFixedDelay) Controls if fixed delay or fixed rate is used.useFixedDelay
(String useFixedDelay) Controls if fixed delay or fixed rate is used.wait
(int wait) Time in seconds to wait for a message to become available.Time in seconds to wait for a message to become available.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
-
advanced
-
client
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder client(io.iron.ironmq.Client client) Reference to a io.iron.ironmq.Client in the Registry. The option is a: <code>io.iron.ironmq.Client</code> type. Group: common- Parameters:
client
- the value to set- Returns:
- the dsl builder
-
client
Reference to a io.iron.ironmq.Client in the Registry. The option will be converted to a <code>io.iron.ironmq.Client</code> type. Group: common- Parameters:
client
- the value to set- Returns:
- the dsl builder
-
ironMQCloud
IronMq Cloud url. Urls for public clusters: https://mq-aws-us-east-1-1.iron.io (US) and https://mq-aws-eu-west-1-1.iron.io (EU). The option is a: <code>java.lang.String</code> type. Default: https://mq-aws-us-east-1-1.iron.io Group: common- Parameters:
ironMQCloud
- the value to set- Returns:
- the dsl builder
-
preserveHeaders
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder preserveHeaders(boolean preserveHeaders) Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer. The option is a: <code>boolean</code> type. Default: false Group: common- Parameters:
preserveHeaders
- the value to set- Returns:
- the dsl builder
-
preserveHeaders
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder preserveHeaders(String preserveHeaders) Should message headers be preserved when publishing messages. This will add the Camel headers to the Iron MQ message as a json payload with a header list, and a message body. Useful when Camel is both consumer and producer. The option will be converted to a <code>boolean</code> type. Default: false Group: common- Parameters:
preserveHeaders
- the value to set- Returns:
- the dsl builder
-
projectId
IronMQ projectId. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
projectId
- the value to set- Returns:
- the dsl builder
-
token
IronMQ token. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
token
- the value to set- Returns:
- the dsl builder
-
batchDelete
Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one pr. exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
batchDelete
- the value to set- Returns:
- the dsl builder
-
batchDelete
Should messages be deleted in one batch. This will limit the number of api requests since messages are deleted in one request, instead of one pr. exchange. If enabled care should be taken that the consumer is idempotent when processing exchanges. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
batchDelete
- the value to set- Returns:
- the dsl builder
-
concurrentConsumers
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder concurrentConsumers(int concurrentConsumers) The number of concurrent consumers. The option is a: <code>int</code> type. Default: 1 Group: consumer- Parameters:
concurrentConsumers
- the value to set- Returns:
- the dsl builder
-
concurrentConsumers
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder concurrentConsumers(String concurrentConsumers) The number of concurrent consumers. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer- Parameters:
concurrentConsumers
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll) Number of messages to poll pr. call. Maximum is 100. The option is a: <code>int</code> type. Default: 1 Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll) Number of messages to poll pr. call. Maximum is 100. The option will be converted to a <code>int</code> type. Default: 1 Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder sendEmptyMessageWhenIdle(boolean sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder sendEmptyMessageWhenIdle(String sendEmptyMessageWhenIdle) If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sendEmptyMessageWhenIdle
- the value to set- Returns:
- the dsl builder
-
timeout
After timeout (in seconds), item will be placed back onto the queue. The option is a: <code>int</code> type. Default: 60 Group: consumer- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
timeout
After timeout (in seconds), item will be placed back onto the queue. The option will be converted to a <code>int</code> type. Default: 60 Group: consumer- Parameters:
timeout
- the value to set- Returns:
- the dsl builder
-
wait
Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30. The option is a: <code>int</code> type. Group: consumer- Parameters:
wait
- the value to set- Returns:
- the dsl builder
-
wait
Time in seconds to wait for a message to become available. This enables long polling. Default is 0 (does not wait), maximum is 30. The option will be converted to a <code>int</code> type. Group: consumer- Parameters:
wait
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffErrorThreshold(int backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffErrorThreshold(String backoffErrorThreshold) The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffErrorThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffIdleThreshold(int backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffIdleThreshold
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffIdleThreshold(String backoffIdleThreshold) The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffIdleThreshold
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffMultiplier(int backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option is a: <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
backoffMultiplier
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder backoffMultiplier(String backoffMultiplier) To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. The option will be converted to a <code>int</code> type. Group: scheduler- Parameters:
backoffMultiplier
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option is a: <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
delay
Milliseconds before the next poll. The option will be converted to a <code>long</code> type. Default: 500 Group: scheduler- Parameters:
delay
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option is a: <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
greedy
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. The option will be converted to a <code>boolean</code> type. Default: false Group: scheduler- Parameters:
greedy
- the value to set- Returns:
- the dsl builder
-
initialDelay
Milliseconds before the first poll starts. The option is a: <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
initialDelay
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder initialDelay(String initialDelay) Milliseconds before the first poll starts. The option will be converted to a <code>long</code> type. Default: 1000 Group: scheduler- Parameters:
initialDelay
- the value to set- Returns:
- the dsl builder
-
repeatCount
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option is a: <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
repeatCount
Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. The option will be converted to a <code>long</code> type. Default: 0 Group: scheduler- Parameters:
repeatCount
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option is a: <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
runLoggingLevel
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder runLoggingLevel(String runLoggingLevel) The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. The option will be converted to a <code>org.apache.camel.LoggingLevel</code> type. Default: TRACE Group: scheduler- Parameters:
runLoggingLevel
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder scheduledExecutorService(ScheduledExecutorService scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option is a: <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduledExecutorService
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder scheduledExecutorService(String scheduledExecutorService) Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. The option will be converted to a <code>java.util.concurrent.ScheduledExecutorService</code> type. Group: scheduler- Parameters:
scheduledExecutorService
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option is a: <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
scheduler
To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler. The option will be converted to a <code>java.lang.Object</code> type. Default: none Group: scheduler- Parameters:
scheduler
- the value to set- Returns:
- the dsl builder
-
schedulerProperties
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder schedulerProperties(String key, Object value) To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
key
- the option keyvalue
- the option value- Returns:
- the dsl builder
-
schedulerProperties
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. The option is multivalued, and you can use the schedulerProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: scheduler- Parameters:
values
- the values- Returns:
- the dsl builder
-
startScheduler
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder startScheduler(boolean startScheduler) Whether the scheduler should be auto started. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
startScheduler
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder startScheduler(String startScheduler) Whether the scheduler should be auto started. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
startScheduler
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option is a: <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
timeUnit
Time unit for initialDelay and delay options. The option will be converted to a <code>java.util.concurrent.TimeUnit</code> type. Default: MILLISECONDS Group: scheduler- Parameters:
timeUnit
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder useFixedDelay(boolean useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option is a: <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-
useFixedDelay
default IronMQEndpointBuilderFactory.IronMQEndpointConsumerBuilder useFixedDelay(String useFixedDelay) Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. The option will be converted to a <code>boolean</code> type. Default: true Group: scheduler- Parameters:
useFixedDelay
- the value to set- Returns:
- the dsl builder
-