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 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
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 AtomEndpointBuilderFactory.AtomEndpointBuilder
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 AtomEndpointBuilderFactory.AtomEndpointBuilder
delay(long delay)
Milliseconds before the next poll.default AtomEndpointBuilderFactory.AtomEndpointBuilder
delay(String delay)
Milliseconds before the next poll.default AtomEndpointBuilderFactory.AtomEndpointBuilder
feedHeader(boolean feedHeader)
Sets whether to add the feed object as a header.default AtomEndpointBuilderFactory.AtomEndpointBuilder
feedHeader(String feedHeader)
Sets whether to add the feed object as a header.default AtomEndpointBuilderFactory.AtomEndpointBuilder
filter(boolean filter)
Sets whether to use filtering or not of the entries.default AtomEndpointBuilderFactory.AtomEndpointBuilder
filter(String filter)
Sets whether to use filtering or not of the entries.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
lastUpdate(String lastUpdate)
Sets the timestamp to be used for filtering entries from the atom feeds.default AtomEndpointBuilderFactory.AtomEndpointBuilder
lastUpdate(Date lastUpdate)
Sets the timestamp to be used for filtering entries from the atom feeds.default AtomEndpointBuilderFactory.AtomEndpointBuilder
password(String password)
Sets the password to be used for basic authentication when polling from a HTTP feed.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(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)
Sets the username to be used for basic authentication when polling from a HTTP feed.
-
-
-
Method Detail
-
advanced
default AtomEndpointBuilderFactory.AdvancedAtomEndpointBuilder advanced()
-
bridgeErrorHandler
default AtomEndpointBuilderFactory.AtomEndpointBuilder 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:boolean
type. Default: false Group: consumer
-
bridgeErrorHandler
default AtomEndpointBuilderFactory.AtomEndpointBuilder 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 aboolean
type. Default: false Group: consumer
-
feedHeader
default AtomEndpointBuilderFactory.AtomEndpointBuilder feedHeader(boolean feedHeader)
Sets whether to add the feed object as a header. The option is a:boolean
type. Default: true Group: consumer
-
feedHeader
default AtomEndpointBuilderFactory.AtomEndpointBuilder feedHeader(String feedHeader)
Sets whether to add the feed object as a header. The option will be converted to aboolean
type. Default: true Group: consumer
-
filter
default AtomEndpointBuilderFactory.AtomEndpointBuilder filter(boolean filter)
Sets whether to use filtering or not of the entries. The option is a:boolean
type. Default: true Group: consumer
-
filter
default AtomEndpointBuilderFactory.AtomEndpointBuilder filter(String filter)
Sets whether to use filtering or not of the entries. The option will be converted to aboolean
type. Default: true Group: consumer
-
lastUpdate
default AtomEndpointBuilderFactory.AtomEndpointBuilder lastUpdate(Date lastUpdate)
Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. The option is a:java.util.Date
type. Group: consumer
-
lastUpdate
default AtomEndpointBuilderFactory.AtomEndpointBuilder lastUpdate(String lastUpdate)
Sets the timestamp to be used for filtering entries from the atom feeds. This options is only in conjunction with the splitEntries. The option will be converted to ajava.util.Date
type. Group: consumer
-
password
default AtomEndpointBuilderFactory.AtomEndpointBuilder password(String password)
Sets the password to be used for basic authentication when polling from a HTTP feed. The option is a:java.lang.String
type. Group: consumer
-
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:boolean
type. Default: false Group: consumer
-
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 aboolean
type. Default: false Group: consumer
-
sortEntries
default AtomEndpointBuilderFactory.AtomEndpointBuilder sortEntries(boolean sortEntries)
Sets whether to sort entries by published date. Only works when splitEntries = true. The option is a:boolean
type. Default: false Group: consumer
-
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 aboolean
type. Default: false Group: consumer
-
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:boolean
type. Default: true Group: consumer
-
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 aboolean
type. Default: true Group: consumer
-
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:boolean
type. Default: true Group: consumer
-
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 aboolean
type. Default: true Group: consumer
-
username
default AtomEndpointBuilderFactory.AtomEndpointBuilder username(String username)
Sets the username to be used for basic authentication when polling from a HTTP feed. The option is a:java.lang.String
type. Group: consumer
-
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:int
type. Group: scheduler
-
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 aint
type. Group: scheduler
-
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:int
type. Group: scheduler
-
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 aint
type. Group: scheduler
-
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:int
type. Group: scheduler
-
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 aint
type. Group: scheduler
-
delay
default AtomEndpointBuilderFactory.AtomEndpointBuilder delay(long delay)
Milliseconds before the next poll. The option is a:long
type. Default: 500 Group: scheduler
-
delay
default AtomEndpointBuilderFactory.AtomEndpointBuilder delay(String delay)
Milliseconds before the next poll. The option will be converted to along
type. Default: 500 Group: scheduler
-
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:boolean
type. Default: false Group: scheduler
-
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 aboolean
type. Default: false Group: scheduler
-
initialDelay
default AtomEndpointBuilderFactory.AtomEndpointBuilder initialDelay(long initialDelay)
Milliseconds before the first poll starts. The option is a:long
type. Default: 1000 Group: scheduler
-
initialDelay
default AtomEndpointBuilderFactory.AtomEndpointBuilder initialDelay(String initialDelay)
Milliseconds before the first poll starts. The option will be converted to along
type. Default: 1000 Group: scheduler
-
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:long
type. Default: 0 Group: scheduler
-
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 along
type. Default: 0 Group: scheduler
-
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:org.apache.camel.LoggingLevel
type. Default: TRACE Group: scheduler
-
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 aorg.apache.camel.LoggingLevel
type. Default: TRACE Group: scheduler
-
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:java.util.concurrent.ScheduledExecutorService
type. Group: scheduler
-
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 ajava.util.concurrent.ScheduledExecutorService
type. Group: scheduler
-
scheduler
default AtomEndpointBuilderFactory.AtomEndpointBuilder scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component. The option is a:java.lang.String
type. Default: none Group: scheduler
-
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:java.util.Map<java.lang.String, java.lang.Object>
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
-
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:java.util.Map<java.lang.String, java.lang.Object>
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
-
startScheduler
default AtomEndpointBuilderFactory.AtomEndpointBuilder startScheduler(boolean startScheduler)
Whether the scheduler should be auto started. The option is a:boolean
type. Default: true Group: scheduler
-
startScheduler
default AtomEndpointBuilderFactory.AtomEndpointBuilder startScheduler(String startScheduler)
Whether the scheduler should be auto started. The option will be converted to aboolean
type. Default: true Group: scheduler
-
timeUnit
default AtomEndpointBuilderFactory.AtomEndpointBuilder timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options. The option is a:java.util.concurrent.TimeUnit
type. Default: MILLISECONDS Group: scheduler
-
timeUnit
default AtomEndpointBuilderFactory.AtomEndpointBuilder timeUnit(String timeUnit)
Time unit for initialDelay and delay options. The option will be converted to ajava.util.concurrent.TimeUnit
type. Default: MILLISECONDS Group: scheduler
-
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:boolean
type. Default: true Group: scheduler
-
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 aboolean
type. Default: true Group: scheduler
-
-