The jpa component enables you to store and retrieve Java objects from databases using JPA.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| entityType | path | common | true | java.lang.Class | The JPA annotated class to use as entity. | ||
| joinTransaction | parameter | common | true | boolean | 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. | ||
| persistenceUnit | parameter | common | true | camel | java.lang.String | The JPA persistence unit used by default. | |
| sharedEntityManager | parameter | common | boolean | 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. | |||
| bridgeErrorHandler | parameter | consumer | boolean | 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/ERROR level and ignored. | |||
| consumeDelete | parameter | consumer | true | boolean | If true, the entity is deleted after it is consumed; if false, the entity is not deleted. | ||
| consumeLockEntity | parameter | consumer | true | boolean | Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. | ||
| deleteHandler | parameter | consumer | org.apache.camel.component.jpa.DeleteHandler |
To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange | |||
| lockModeType | parameter | consumer | PESSIMISTIC_WRITE | javax.persistence.LockModeType | READ WRITE OPTIMISTIC OPTIMISTIC_FORCE_INCREMENT PESSIMISTIC_READ PESSIMISTIC_WRITE PESSIMISTIC_FORCE_INCREMENT NONE |
To configure the lock mode on the consumer. | |
| maximumResults | parameter | consumer | -1 | int | Set the maximum number of results to retrieve on the Query. | ||
| maxMessagesPerPoll | parameter | consumer | int | 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. | |||
| namedQuery | parameter | consumer | java.lang.String | To use a named query when consuming data. | |||
| nativeQuery | parameter | consumer | java.lang.String | To use a custom native query when consuming data. You may want to use the option consumer.resultClass also when using native queries. | |||
| parameters | parameter | consumer | java.util.Map |
This key/value mapping is used for building the query parameters.
It's is expected to be of the generic type java.util.Map |
|||
| preDeleteHandler | parameter | consumer | org.apache.camel.component.jpa.DeleteHandler |
To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. | |||
| query | parameter | consumer | java.lang.String | To use a custom query when consuming data. | |||
| resultClass | parameter | consumer | java.lang.Class | 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. | |||
| sendEmptyMessageWhenIdle | parameter | consumer | boolean | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | |||
| skipLockedEntity | parameter | consumer | boolean | To configure whether to use NOWAIT on lock and silently skip the entity. | |||
| transacted | parameter | consumer | boolean | 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. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| pollStrategy | parameter | consumer (advanced) | org.apache.camel.spi.PollingConsumerPollStrategy | 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. | |||
| flushOnSend | parameter | producer | true | boolean | Flushes the EntityManager after the entity bean has been persisted. | ||
| remove | parameter | producer | boolean | Indicates to use entityManager.remove(entity). | |||
| usePassedInEntityManager | parameter | producer | boolean | 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. | |||
| usePersist | parameter | producer | boolean | 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)! | |||
| entityManagerProperties | parameter | advanced | java.util.Map |
Additional properties for the entity manager to use. | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| backoffErrorThreshold | parameter | scheduler | int | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | |||
| backoffIdleThreshold | parameter | scheduler | int | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | |||
| backoffMultiplier | parameter | scheduler | int | 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. | |||
| delay | parameter | scheduler | 500 | long | Milliseconds before the next poll. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). | ||
| greedy | parameter | scheduler | boolean | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | |||
| initialDelay | parameter | scheduler | 1000 | long | Milliseconds before the first poll starts. You can also specify time values using units, such as 60s (60 seconds), 5m30s (5 minutes and 30 seconds), and 1h (1 hour). | ||
| runLoggingLevel | parameter | scheduler | TRACE | org.apache.camel.LoggingLevel | 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. | |
| scheduledExecutorService | parameter | scheduler | java.util.concurrent.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. | |||
| scheduler | parameter | scheduler | none | org.apache.camel.spi.ScheduledPollConsumerScheduler | none spring quartz2 |
To use a cron scheduler from either camel-spring or camel-quartz2 component | |
| schedulerProperties | parameter | scheduler | java.util.Map |
To configure additional properties when using a custom scheduler or any of the Quartz2, Spring based scheduler. | |||
| startScheduler | parameter | scheduler | true | boolean | Whether the scheduler should be auto started. | ||
| timeUnit | parameter | scheduler | MILLISECONDS | java.util.concurrent.TimeUnit | NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS |
Time unit for initialDelay and delay options. | |
| useFixedDelay | parameter | scheduler | true | boolean | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |