Interface OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
OAIPMHEndpointBuilderFactory.OAIPMHEndpointBuilder
- Enclosing interface:
- OAIPMHEndpointBuilderFactory
public static interface OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the OAI-PMH component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default OAIPMHEndpointBuilderFactory.AdvancedOAIPMHEndpointConsumerBuilder
advanced()
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
delay(long delay)
Milliseconds before the next poll.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
delay(String delay)
Milliseconds before the next poll.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
from(String from)
Specifies a lower bound for datestamp-based selective harvesting.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
identifier(String identifier)
Identifier of the requested resources.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
ignoreSSLWarnings(boolean ignoreSSLWarnings)
Ignore SSL certificate warnings.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
ignoreSSLWarnings(String ignoreSSLWarnings)
Ignore SSL certificate warnings.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
metadataPrefix(String metadataPrefix)
Specifies the metadataPrefix of the format that should be included in the metadata part of the returned records.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
set(String set)
Specifies membership as a criteria for set-based selective harvesting.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
ssl(boolean ssl)
Causes the defined url to make an https request.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
ssl(String ssl)
Causes the defined url to make an https request.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
until(String until)
Specifies an upper bound for datestamp-based selective harvesting.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder
verb(String verb)
Request name supported by OAI-PMh protocol.
-
-
-
Method Detail
-
advanced
default OAIPMHEndpointBuilderFactory.AdvancedOAIPMHEndpointConsumerBuilder advanced()
-
from
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder from(String from)
Specifies a lower bound for datestamp-based selective harvesting. UTC DateTime value. The option is a:java.lang.String
type. Group: common
-
identifier
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder identifier(String identifier)
Identifier of the requested resources. Applicable only with certain verbs. The option is a:java.lang.String
type. Group: common
-
metadataPrefix
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder metadataPrefix(String metadataPrefix)
Specifies the metadataPrefix of the format that should be included in the metadata part of the returned records. The option is a:java.lang.String
type. Default: oai_dc Group: common
-
set
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder set(String set)
Specifies membership as a criteria for set-based selective harvesting. The option is a:java.lang.String
type. Group: common
-
until
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder until(String until)
Specifies an upper bound for datestamp-based selective harvesting. UTC DateTime value. The option is a:java.lang.String
type. Group: common
-
verb
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder verb(String verb)
Request name supported by OAI-PMh protocol. The option is a:java.lang.String
type. Default: ListRecords Group: common
-
bridgeErrorHandler
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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
-
sendEmptyMessageWhenIdle
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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
-
backoffErrorThreshold
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder delay(long delay)
Milliseconds before the next poll. The option is a:long
type. Default: 500 Group: scheduler
-
delay
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder delay(String delay)
Milliseconds before the next poll. The option will be converted to along
type. Default: 500 Group: scheduler
-
greedy
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder initialDelay(long initialDelay)
Milliseconds before the first poll starts. The option is a:long
type. Default: 1000 Group: scheduler
-
initialDelay
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder initialDelay(String initialDelay)
Milliseconds before the first poll starts. The option will be converted to along
type. Default: 1000 Group: scheduler
-
repeatCount
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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:java.lang.Object
type. Default: none Group: scheduler
-
scheduler
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 ajava.lang.Object
type. Default: none Group: scheduler
-
schedulerProperties
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder startScheduler(boolean startScheduler)
Whether the scheduler should be auto started. The option is a:boolean
type. Default: true Group: scheduler
-
startScheduler
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder startScheduler(String startScheduler)
Whether the scheduler should be auto started. The option will be converted to aboolean
type. Default: true Group: scheduler
-
timeUnit
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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 OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder 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
-
ignoreSSLWarnings
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder ignoreSSLWarnings(boolean ignoreSSLWarnings)
Ignore SSL certificate warnings. The option is a:boolean
type. Default: false Group: security
-
ignoreSSLWarnings
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder ignoreSSLWarnings(String ignoreSSLWarnings)
Ignore SSL certificate warnings. The option will be converted to aboolean
type. Default: false Group: security
-
ssl
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder ssl(boolean ssl)
Causes the defined url to make an https request. The option is a:boolean
type. Default: false Group: security
-
ssl
default OAIPMHEndpointBuilderFactory.OAIPMHEndpointConsumerBuilder ssl(String ssl)
Causes the defined url to make an https request. The option will be converted to aboolean
type. Default: false Group: security
-
-