| // kafka-connector options: START |
| [[camel-jpa-kafka-connector-source]] |
| = camel-jpa-kafka-connector source configuration |
| |
| When using camel-jpa-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-jpa-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-jpa source connector supports 46 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.entityType* | Entity class name | null | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.join Transaction* | 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. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.maximum Results* | Set the maximum number of results to retrieve on the Query. | -1 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.named Query* | To use a named query. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.native Query* | To use a custom native query. You may want to use the option resultClass also when using native queries. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.persistence Unit* | The JPA persistence unit used by default. | "camel" | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.query* | To use a custom query. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.result 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.bridge ErrorHandler* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consume Delete* | If true, the entity is deleted after it is consumed; if false, the entity is not deleted. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.consume LockEntity* | Specifies whether or not to set an exclusive lock on each entity bean while processing the results from polling. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.delete Handler* | To use a custom DeleteHandler to delete the row after the consumer is done processing the exchange | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.lockMode Type* | To configure the lock mode on the consumer. One of: [READ] [WRITE] [OPTIMISTIC] [OPTIMISTIC_FORCE_INCREMENT] [PESSIMISTIC_READ] [PESSIMISTIC_WRITE] [PESSIMISTIC_FORCE_INCREMENT] [NONE] | "PESSIMISTIC_WRITE" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.max MessagesPerPoll* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.pre DeleteHandler* | To use a custom Pre-DeleteHandler to delete the row after the consumer has read the entity. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.send EmptyMessageWhenIdle* | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.skip LockedEntity* | To configure whether to use NOWAIT on lock and silently skip the entity. | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.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. | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Handler* | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.parameters* | This key/value mapping is used for building the query parameters. It is expected to be of the generic type java.util.Map where the keys are the named parameters of a given JPA query and the values are their corresponding effective values you want to select for. When it's used for producer, Simple expression can be used as a parameter value. It allows you to retrieve parameter values from the message body, header and etc. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.poll Strategy* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.entity ManagerProperties* | Additional properties for the entity manager to use. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.shared EntityManager* | 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. | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.backoff ErrorThreshold* | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.backoff IdleThreshold* | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.backoff Multiplier* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.delay* | 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). | 500L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.greedy* | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.initial Delay* | 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). | 1000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.repeat Count* | 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. | 0L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.run LoggingLevel* | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF] | "TRACE" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.scheduled ExecutorService* | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.scheduler* | To use a cron scheduler from either camel-spring or camel-quartz component One of: [none] [spring] [quartz] | "none" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.scheduler Properties* | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.start Scheduler* | Whether the scheduler should be auto started. | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.timeUnit* | Time unit for initialDelay and delay options. One of: [NANOSECONDS] [MICROSECONDS] [MILLISECONDS] [SECONDS] [MINUTES] [HOURS] [DAYS] | "MILLISECONDS" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.useFixed Delay* | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | ConfigDef.Importance.MEDIUM |
| | *camel.component.jpa.entity ManagerFactory* | To use the EntityManagerFactory. This is strongly recommended to configure. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.jpa.join Transaction* | 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. | true | ConfigDef.Importance.MEDIUM |
| | *camel.component.jpa.shared EntityManager* | 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. | false | ConfigDef.Importance.MEDIUM |
| | * camel.component.jpa.transaction Manager* | To use the PlatformTransactionManager for managing transactions. | null | ConfigDef.Importance.MEDIUM |
| | *camel.component.jpa.bridge ErrorHandler* | 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. | false | ConfigDef.Importance.MEDIUM |
| | *camel.component.jpa.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
