blob: 52932744a3ec91dbbabb13db98f710e05e454516 [file] [log] [blame]
// kafka-connector options: START
[[camel-jcache-kafka-connector-source]]
= camel-jcache-kafka-connector source configuration
When using camel-jcache-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-jcache-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-jcache source connector supports 30 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.cacheName* | The name of the cache | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.cache Configuration* | A Configuration for the Cache | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.cache ConfigurationProperties* | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.caching Provider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.configuration Uri* | An implementation specific URI for the CacheManager | null | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.management Enabled* | Whether management gathering is enabled | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.read Through* | If read-through caching should be used | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.statistics Enabled* | Whether statistics gathering is enabled | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.storeBy Value* | If cache should use store-by-value or store-by-reference semantics | true | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.write Through* | If write-through caching should be used | false | 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.filtered Events* | Events a consumer should filter (multiple events can be separated by comma). If using filteredEvents option, then eventFilters one will be ignored One of: [CREATED] [UPDATED] [REMOVED] [EXPIRED] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.oldValue Required* | if the old value is required for events | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.synchronous* | if the event listener should block the thread causing the event | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.event Filters* | The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored | null | 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.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.cache LoaderFactory* | The CacheLoader factory | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.cache WriterFactory* | The CacheWriter factory | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.create CacheIfNotExists* | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.expiry PolicyFactory* | The ExpiryPolicy factory | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.lookup Providers* | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. | false | ConfigDef.Importance.MEDIUM
| *camel.component.jcache.cache Configuration* | A Configuration for the Cache | null | ConfigDef.Importance.MEDIUM
| *camel.component.jcache.cache ConfigurationProperties* | Properties to configure jcache | null | ConfigDef.Importance.MEDIUM
| *camel.component.jcache.cache ConfigurationPropertiesRef* | References to an existing Properties or Map to lookup in the registry to use for configuring jcache. | null | ConfigDef.Importance.MEDIUM
| *camel.component.jcache.caching Provider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | ConfigDef.Importance.MEDIUM
| * camel.component.jcache.configuration Uri* | An implementation specific URI for the CacheManager | null | ConfigDef.Importance.MEDIUM
| *camel.component.jcache.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.jcache.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