Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
entityType | path | java.lang.Class> | true | false | The JPA annotated class to use as entity. | ||
persistenceUnit | parameter | java.lang.String | true | false | camel | The JPA persistence unit used by default. | |
joinTransaction | parameter | boolean | false | true | 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. | ||
sharedEntityManager | parameter | boolean | false | Whether to use Spring's SharedEntityManager for the consumer/producer. Note in most cases joinTransaction should be set to false as this is not an EXTENDED EntityManager. | |||
maximumResults | parameter | int | false | -1 | Set the maximum number of results to retrieve on the Query. | ||
consumeDelete | parameter | boolean | false | true | If true, the entity is deleted after it is consumed; if false, the entity is not deleted. | ||
consumeLockEntity | parameter | boolean | false | true | Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. | ||
maxMessagesPerPoll | parameter | int | false | 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. | |||
flushOnSend | parameter | boolean | false | true | Flushes the EntityManager after the entity bean has been persisted. | ||
usePersist | parameter | boolean | false | Indicates to use entityManager.persist(entity) instead of entityManager.merge(entity). Note: entityManager.persist(entity) doesn't work for detached entities (where the EntityManager has to execute an UPDATE instead of an INSERT query)! | |||
usePassedInEntityManager | parameter | boolean | false | If set to true, then Camel will use the EntityManager from the header JpaConstants.ENTITYMANAGER instead of the configured entity manager on the component/endpoint. This allows end users to control which entity manager will be in use. | |||
remove | parameter | boolean | false | Indicates to use entityManager.remove(entity). | |||
startScheduler | parameter | boolean | false | true | Whether the scheduler should be auto started. | ||
initialDelay | parameter | long | false | 1000 | Milliseconds before the first poll starts. | ||
delay | parameter | long | false | 500 | Milliseconds before the next poll. | ||
timeUnit | parameter | java.util.concurrent.TimeUnit | false | MILLISECONDS | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
useFixedDelay | parameter | boolean | false | true | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | ||
pollStrategy | parameter | org.apache.camel.spi.PollingConsumerPollStrategy | false | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. | |||
runLoggingLevel | parameter | org.apache.camel.LoggingLevel | false | TRACE | TRACE DEBUG INFO WARN ERROR OFF |
The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | |
sendEmptyMessageWhenIdle | parameter | boolean | false | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
greedy | parameter | boolean | false | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
scheduler | parameter | org.apache.camel.spi.ScheduledPollConsumerScheduler | false | spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | ||
schedulerProperties | parameter | java.util.Map |
false | To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
scheduledExecutorService | parameter | java.util.concurrent.ScheduledExecutorService | false | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | |||
backoffMultiplier | parameter | int | false | 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. | |||
backoffIdleThreshold | parameter | int | false | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
backoffErrorThreshold | parameter | int | false | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
exchangePattern | parameter | org.apache.camel.ExchangePattern | false | InOnly | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the default exchange pattern when creating an exchange | |
synchronous | parameter | boolean | false | false | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
Name | Kind | Type | Required | Deprecated | Default Value | Enum Values | Description |
---|---|---|---|---|---|---|---|
maxMessagesPerPoll | parameter | int | false |