Interface SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- Enclosing interface:
- SchedulerEndpointBuilderFactory
public static interface SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Scheduler component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default SchedulerEndpointBuilderFactory.AdvancedSchedulerEndpointBuilder
advanced()
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
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.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
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.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
delay(long delay)
Milliseconds before the next poll.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
delay(String delay)
Milliseconds before the next poll.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
poolSize(int poolSize)
Number of core threads in the thread pool used by the scheduling thread pool.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
poolSize(String poolSize)
Number of core threads in the thread pool used by the scheduling thread pool.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
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.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
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.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.
-
-
-
Method Detail
-
advanced
default SchedulerEndpointBuilderFactory.AdvancedSchedulerEndpointBuilder advanced()
-
bridgeErrorHandler
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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
-
backoffErrorThreshold
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder delay(long 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder delay(String 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder greedy(boolean 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder greedy(String 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder initialDelay(long 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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
-
poolSize
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder poolSize(int poolSize)
Number of core threads in the thread pool used by the scheduling thread pool. Is by default using a single thread. The option is a: <code>int</code> type. Default: 1 Group: scheduler- Parameters:
poolSize
- the value to set- Returns:
- the dsl builder
-
poolSize
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder poolSize(String poolSize)
Number of core threads in the thread pool used by the scheduling thread pool. Is by default using a single thread. The option will be converted to a <code>int</code> type. Default: 1 Group: scheduler- Parameters:
poolSize
- the value to set- Returns:
- the dsl builder
-
repeatCount
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder repeatCount(long 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder repeatCount(String 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder scheduler(Object 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder scheduler(String 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder schedulerProperties(Map values)
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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder timeUnit(TimeUnit 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
default SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder timeUnit(String 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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 SchedulerEndpointBuilderFactory.SchedulerEndpointBuilder 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
-
-