Interface AtomEndpointBuilderFactory.AtomEndpointBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- Enclosing interface:
- AtomEndpointBuilderFactory
public static interface AtomEndpointBuilderFactory.AtomEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Atom component.
-
-
Method Summary
All Methods Instance Methods Default Methods Deprecated Methods Modifier and Type Method Description default AtomEndpointBuilderFactory.AdvancedAtomEndpointBuilder
advanced()
default AtomEndpointBuilderFactory.AtomEndpointBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default AtomEndpointBuilderFactory.AtomEndpointBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default AtomEndpointBuilderFactory.AtomEndpointBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default AtomEndpointBuilderFactory.AtomEndpointBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default AtomEndpointBuilderFactory.AtomEndpointBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default AtomEndpointBuilderFactory.AtomEndpointBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default AtomEndpointBuilderFactory.AtomEndpointBuilder
delay(long delay)
Milliseconds before the next poll.default AtomEndpointBuilderFactory.AtomEndpointBuilder
delay(String delay)
Milliseconds before the next poll.default AtomEndpointBuilderFactory.AtomEndpointBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default AtomEndpointBuilderFactory.AtomEndpointBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default AtomEndpointBuilderFactory.AtomEndpointBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default AtomEndpointBuilderFactory.AtomEndpointBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default AtomEndpointBuilderFactory.AtomEndpointBuilder
password(String password)
Deprecated.default AtomEndpointBuilderFactory.AtomEndpointBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default AtomEndpointBuilderFactory.AtomEndpointBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default AtomEndpointBuilderFactory.AtomEndpointBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default AtomEndpointBuilderFactory.AtomEndpointBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default AtomEndpointBuilderFactory.AtomEndpointBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default AtomEndpointBuilderFactory.AtomEndpointBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default AtomEndpointBuilderFactory.AtomEndpointBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default AtomEndpointBuilderFactory.AtomEndpointBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default AtomEndpointBuilderFactory.AtomEndpointBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default AtomEndpointBuilderFactory.AtomEndpointBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default AtomEndpointBuilderFactory.AtomEndpointBuilder
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 AtomEndpointBuilderFactory.AtomEndpointBuilder
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 AtomEndpointBuilderFactory.AtomEndpointBuilder
sortEntries(boolean sortEntries)
Sets whether to sort entries by published date.default AtomEndpointBuilderFactory.AtomEndpointBuilder
sortEntries(String sortEntries)
Sets whether to sort entries by published date.default AtomEndpointBuilderFactory.AtomEndpointBuilder
splitEntries(boolean splitEntries)
Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message.default AtomEndpointBuilderFactory.AtomEndpointBuilder
splitEntries(String splitEntries)
Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message.default AtomEndpointBuilderFactory.AtomEndpointBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default AtomEndpointBuilderFactory.AtomEndpointBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default AtomEndpointBuilderFactory.AtomEndpointBuilder
throttleEntries(boolean throttleEntries)
Sets whether all entries identified in a single feed poll should be delivered immediately.default AtomEndpointBuilderFactory.AtomEndpointBuilder
throttleEntries(String throttleEntries)
Sets whether all entries identified in a single feed poll should be delivered immediately.default AtomEndpointBuilderFactory.AtomEndpointBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default AtomEndpointBuilderFactory.AtomEndpointBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default AtomEndpointBuilderFactory.AtomEndpointBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default AtomEndpointBuilderFactory.AtomEndpointBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.default AtomEndpointBuilderFactory.AtomEndpointBuilder
username(String username)
Deprecated.
-
-
-
Method Detail
-
advanced
default AtomEndpointBuilderFactory.AdvancedAtomEndpointBuilder advanced()
-
sendEmptyMessageWhenIdle
default AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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
-
sortEntries
default AtomEndpointBuilderFactory.AtomEndpointBuilder sortEntries(boolean sortEntries)
Sets whether to sort entries by published date. Only works when splitEntries = true. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
sortEntries
- the value to set- Returns:
- the dsl builder
-
sortEntries
default AtomEndpointBuilderFactory.AtomEndpointBuilder sortEntries(String sortEntries)
Sets whether to sort entries by published date. Only works when splitEntries = true. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
sortEntries
- the value to set- Returns:
- the dsl builder
-
splitEntries
default AtomEndpointBuilderFactory.AtomEndpointBuilder splitEntries(boolean splitEntries)
Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
splitEntries
- the value to set- Returns:
- the dsl builder
-
splitEntries
default AtomEndpointBuilderFactory.AtomEndpointBuilder splitEntries(String splitEntries)
Sets whether or not entries should be sent individually or whether the entire feed should be sent as a single message. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
splitEntries
- the value to set- Returns:
- the dsl builder
-
throttleEntries
default AtomEndpointBuilderFactory.AtomEndpointBuilder throttleEntries(boolean throttleEntries)
Sets whether all entries identified in a single feed poll should be delivered immediately. If true, only one entry is processed per delay. Only applicable when splitEntries = true. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
throttleEntries
- the value to set- Returns:
- the dsl builder
-
throttleEntries
default AtomEndpointBuilderFactory.AtomEndpointBuilder throttleEntries(String throttleEntries)
Sets whether all entries identified in a single feed poll should be delivered immediately. If true, only one entry is processed per delay. Only applicable when splitEntries = true. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
throttleEntries
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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
default AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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 AtomEndpointBuilderFactory.AtomEndpointBuilder 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
-
password
@Deprecated default AtomEndpointBuilderFactory.AtomEndpointBuilder password(String password)
Deprecated.Sets the password to be used for basic authentication when polling from a HTTP feed.Notice: Basic authentication is not a secured method, and is not recommended to be used. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
password
- the value to set- Returns:
- the dsl builder
-
username
@Deprecated default AtomEndpointBuilderFactory.AtomEndpointBuilder username(String username)
Deprecated.Sets the username to be used for basic authentication when polling from a HTTP feed. Notice: Basic authentication is not a secured method, and is not recommended to be used. The option is a: <code>java.lang.String</code> type. Group: security- Parameters:
username
- the value to set- Returns:
- the dsl builder
-
-