Interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
-
- All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder
,org.apache.camel.EndpointConsumerResolver
- All Known Subinterfaces:
JpaEndpointBuilderFactory.JpaEndpointBuilder
- Enclosing interface:
- JpaEndpointBuilderFactory
public static interface JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint consumers for the JPA component.
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder
advanced()
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
backoffErrorThreshold(int backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
backoffErrorThreshold(String backoffErrorThreshold)
The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
backoffIdleThreshold(int backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
backoffIdleThreshold(String backoffIdleThreshold)
The number of subsequent idle polls that should happen before the backoffMultipler should kick-in.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
backoffMultiplier(int backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
backoffMultiplier(String backoffMultiplier)
To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
consumeDelete(boolean consumeDelete)
If true, the entity is deleted after it is consumed; if false, the entity is not deleted.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
consumeDelete(String consumeDelete)
If true, the entity is deleted after it is consumed; if false, the entity is not deleted.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
consumeLockEntity(boolean consumeLockEntity)
Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
consumeLockEntity(String consumeLockEntity)
Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
delay(long delay)
Milliseconds before the next poll.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
delay(String delay)
Milliseconds before the next poll.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
deleteHandler(String deleteHandler)
To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
deleteHandler(org.apache.camel.component.jpa.DeleteHandler<Object> deleteHandler)
To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
greedy(boolean greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
greedy(String greedy)
If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
initialDelay(long initialDelay)
Milliseconds before the first poll starts.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
initialDelay(String initialDelay)
Milliseconds before the first poll starts.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
joinTransaction(boolean joinTransaction)
The camel-jpa component will join transaction by default.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
joinTransaction(String joinTransaction)
The camel-jpa component will join transaction by default.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
lockModeType(String lockModeType)
To configure the lock mode on the consumer.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
lockModeType(javax.persistence.LockModeType lockModeType)
To configure the lock mode on the consumer.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
maximumResults(int maximumResults)
Set the maximum number of results to retrieve on the Query.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
maximumResults(String maximumResults)
Set the maximum number of results to retrieve on the Query.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
maxMessagesPerPoll(int maxMessagesPerPoll)
An integer value to define the maximum number of messages to gather per poll.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
maxMessagesPerPoll(String maxMessagesPerPoll)
An integer value to define the maximum number of messages to gather per poll.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
namedQuery(String namedQuery)
To use a named query.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
nativeQuery(String nativeQuery)
To use a custom native query.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
persistenceUnit(String persistenceUnit)
The JPA persistence unit used by default.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
preDeleteHandler(String preDeleteHandler)
To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
preDeleteHandler(org.apache.camel.component.jpa.DeleteHandler<Object> preDeleteHandler)
To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
query(String query)
To use a custom query.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
repeatCount(long repeatCount)
Specifies a maximum limit of number of fires.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
repeatCount(String repeatCount)
Specifies a maximum limit of number of fires.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
resultClass(Class<Object> resultClass)
Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)).default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
resultClass(String resultClass)
Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)).default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
runLoggingLevel(String runLoggingLevel)
The consumer logs a start/complete log line when it polls.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
runLoggingLevel(org.apache.camel.LoggingLevel runLoggingLevel)
The consumer logs a start/complete log line when it polls.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
scheduledExecutorService(String scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
scheduledExecutorService(ScheduledExecutorService scheduledExecutorService)
Allows for configuring a custom/shared thread pool to use for the consumer.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
scheduler(Object scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
scheduler(String scheduler)
To use a cron scheduler from either camel-spring or camel-quartz component.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
schedulerProperties(String key, Object value)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
schedulerProperties(Map values)
To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
skipLockedEntity(boolean skipLockedEntity)
To configure whether to use NOWAIT on lock and silently skip the entity.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
skipLockedEntity(String skipLockedEntity)
To configure whether to use NOWAIT on lock and silently skip the entity.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
startScheduler(boolean startScheduler)
Whether the scheduler should be auto started.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
startScheduler(String startScheduler)
Whether the scheduler should be auto started.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
timeUnit(String timeUnit)
Time unit for initialDelay and delay options.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
timeUnit(TimeUnit timeUnit)
Time unit for initialDelay and delay options.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
transacted(boolean transacted)
Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
transacted(String transacted)
Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
useFixedDelay(boolean useFixedDelay)
Controls if fixed delay or fixed rate is used.default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder
useFixedDelay(String useFixedDelay)
Controls if fixed delay or fixed rate is used.
-
-
-
Method Detail
-
advanced
default JpaEndpointBuilderFactory.AdvancedJpaEndpointConsumerBuilder advanced()
-
joinTransaction
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder joinTransaction(boolean joinTransaction)
The camel-jpa component will join transaction by default. You can use this option to turn this off, for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints. The option is a: <code>boolean</code> type. Default: true Group: common- Parameters:
joinTransaction
- the value to set- Returns:
- the dsl builder
-
joinTransaction
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder joinTransaction(String joinTransaction)
The camel-jpa component will join transaction by default. You can use this option to turn this off, for example if you use LOCAL_RESOURCE and join transaction doesn't work with your JPA provider. This option can also be set globally on the JpaComponent, instead of having to set it on all endpoints. The option will be converted to a <code>boolean</code> type. Default: true Group: common- Parameters:
joinTransaction
- the value to set- Returns:
- the dsl builder
-
maximumResults
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder maximumResults(int maximumResults)
Set the maximum number of results to retrieve on the Query. The option is a: <code>int</code> type. Default: -1 Group: common- Parameters:
maximumResults
- the value to set- Returns:
- the dsl builder
-
maximumResults
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder maximumResults(String maximumResults)
Set the maximum number of results to retrieve on the Query. The option will be converted to a <code>int</code> type. Default: -1 Group: common- Parameters:
maximumResults
- the value to set- Returns:
- the dsl builder
-
namedQuery
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder namedQuery(String namedQuery)
To use a named query. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
namedQuery
- the value to set- Returns:
- the dsl builder
-
nativeQuery
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder nativeQuery(String nativeQuery)
To use a custom native query. You may want to use the option resultClass also when using native queries. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
nativeQuery
- the value to set- Returns:
- the dsl builder
-
persistenceUnit
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder persistenceUnit(String persistenceUnit)
The JPA persistence unit used by default. The option is a: <code>java.lang.String</code> type. Required: true Default: camel Group: common- Parameters:
persistenceUnit
- the value to set- Returns:
- the dsl builder
-
query
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder query(String query)
To use a custom query. The option is a: <code>java.lang.String</code> type. Group: common- Parameters:
query
- the value to set- Returns:
- the dsl builder
-
resultClass
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder resultClass(Class<Object> resultClass)
Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an affect when using in conjunction with native query when consuming data. The option is a: <code>java.lang.Class<java.lang.Object></code> type. Group: common- Parameters:
resultClass
- the value to set- Returns:
- the dsl builder
-
resultClass
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder resultClass(String resultClass)
Defines the type of the returned payload (we will call entityManager.createNativeQuery(nativeQuery, resultClass) instead of entityManager.createNativeQuery(nativeQuery)). Without this option, we will return an object array. Only has an affect when using in conjunction with native query when consuming data. The option will be converted to a <code>java.lang.Class<java.lang.Object></code> type. Group: common- Parameters:
resultClass
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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
-
consumeDelete
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder consumeDelete(boolean consumeDelete)
If true, the entity is deleted after it is consumed; if false, the entity is not deleted. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
consumeDelete
- the value to set- Returns:
- the dsl builder
-
consumeDelete
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder consumeDelete(String consumeDelete)
If true, the entity is deleted after it is consumed; if false, the entity is not deleted. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
consumeDelete
- the value to set- Returns:
- the dsl builder
-
consumeLockEntity
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder consumeLockEntity(boolean consumeLockEntity)
Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. The option is a: <code>boolean</code> type. Default: true Group: consumer- Parameters:
consumeLockEntity
- the value to set- Returns:
- the dsl builder
-
consumeLockEntity
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder consumeLockEntity(String consumeLockEntity)
Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. The option will be converted to a <code>boolean</code> type. Default: true Group: consumer- Parameters:
consumeLockEntity
- the value to set- Returns:
- the dsl builder
-
deleteHandler
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder deleteHandler(org.apache.camel.component.jpa.DeleteHandler<Object> deleteHandler)
To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange. The option is a: <code>org.apache.camel.component.jpa.DeleteHandler<java.lang.Object></code> type. Group: consumer- Parameters:
deleteHandler
- the value to set- Returns:
- the dsl builder
-
deleteHandler
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder deleteHandler(String deleteHandler)
To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange. The option will be converted to a <code>org.apache.camel.component.jpa.DeleteHandler<java.lang.Object></code> type. Group: consumer- Parameters:
deleteHandler
- the value to set- Returns:
- the dsl builder
-
lockModeType
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder lockModeType(javax.persistence.LockModeType lockModeType)
To configure the lock mode on the consumer. The option is a: <code>javax.persistence.LockModeType</code> type. Default: PESSIMISTIC_WRITE Group: consumer- Parameters:
lockModeType
- the value to set- Returns:
- the dsl builder
-
lockModeType
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder lockModeType(String lockModeType)
To configure the lock mode on the consumer. The option will be converted to a <code>javax.persistence.LockModeType</code> type. Default: PESSIMISTIC_WRITE Group: consumer- Parameters:
lockModeType
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder maxMessagesPerPoll(int maxMessagesPerPoll)
An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable. The option is a: <code>int</code> type. Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
maxMessagesPerPoll
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder maxMessagesPerPoll(String maxMessagesPerPoll)
An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to avoid polling many thousands of messages when starting up the server. Set a value of 0 or negative to disable. The option will be converted to a <code>int</code> type. Group: consumer- Parameters:
maxMessagesPerPoll
- the value to set- Returns:
- the dsl builder
-
preDeleteHandler
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder preDeleteHandler(org.apache.camel.component.jpa.DeleteHandler<Object> preDeleteHandler)
To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. The option is a: <code>org.apache.camel.component.jpa.DeleteHandler<java.lang.Object></code> type. Group: consumer- Parameters:
preDeleteHandler
- the value to set- Returns:
- the dsl builder
-
preDeleteHandler
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder preDeleteHandler(String preDeleteHandler)
To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. The option will be converted to a <code>org.apache.camel.component.jpa.DeleteHandler<java.lang.Object></code> type. Group: consumer- Parameters:
preDeleteHandler
- the value to set- Returns:
- the dsl builder
-
sendEmptyMessageWhenIdle
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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
-
skipLockedEntity
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder skipLockedEntity(boolean skipLockedEntity)
To configure whether to use NOWAIT on lock and silently skip the entity. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
skipLockedEntity
- the value to set- Returns:
- the dsl builder
-
skipLockedEntity
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder skipLockedEntity(String skipLockedEntity)
To configure whether to use NOWAIT on lock and silently skip the entity. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
skipLockedEntity
- the value to set- Returns:
- the dsl builder
-
transacted
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder transacted(boolean transacted)
Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only rollback the last failed message. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
transacted
- the value to set- Returns:
- the dsl builder
-
transacted
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder transacted(String transacted)
Whether to run the consumer in transacted mode, by which all messages will either commit or rollback, when the entire batch has been processed. The default behavior (false) is to commit all the previously successfully processed messages, and only rollback the last failed message. The option will be converted to a <code>boolean</code> type. Default: false Group: consumer- Parameters:
transacted
- the value to set- Returns:
- the dsl builder
-
backoffErrorThreshold
default JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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 JpaEndpointBuilderFactory.JpaEndpointConsumerBuilder 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
-
-