blob: 10ed53c81fb64770741b2f9b356e5315bda8854c [file] [log] [blame]
// kafka-connector options: START
[[camel-jcache-kafka-connector-sink]]
= camel-jcache-kafka-connector sink configuration
When using camel-jcache-kafka-connector as sink 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 sink connector supports 25 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.cacheName* | The name of the cache | null | HIGH
| *camel.sink.endpoint.cacheConfiguration* | A Configuration for the Cache | null | MEDIUM
| *camel.sink.endpoint.cacheConfigurationProperties* | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | null | MEDIUM
| *camel.sink.endpoint.cachingProvider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | MEDIUM
| *camel.sink.endpoint.configurationUri* | An implementation specific URI for the CacheManager | null | MEDIUM
| *camel.sink.endpoint.managementEnabled* | Whether management gathering is enabled | false | MEDIUM
| *camel.sink.endpoint.readThrough* | If read-through caching should be used | false | MEDIUM
| *camel.sink.endpoint.statisticsEnabled* | Whether statistics gathering is enabled | false | MEDIUM
| *camel.sink.endpoint.storeByValue* | If cache should use store-by-value or store-by-reference semantics | true | MEDIUM
| *camel.sink.endpoint.writeThrough* | If write-through caching should be used | false | MEDIUM
| *camel.sink.endpoint.action* | To configure using a cache operation by default. If an operation in the message header, then the operation from the header takes precedence. | null | MEDIUM
| *camel.sink.endpoint.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.sink.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.cacheLoaderFactory* | The CacheLoader factory | null | MEDIUM
| *camel.sink.endpoint.cacheWriterFactory* | The CacheWriter factory | null | MEDIUM
| *camel.sink.endpoint.createCacheIfNotExists* | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | MEDIUM
| *camel.sink.endpoint.expiryPolicyFactory* | The ExpiryPolicy factory | null | MEDIUM
| *camel.sink.endpoint.lookupProviders* | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. | false | MEDIUM
| *camel.component.jcache.cacheConfiguration* | A Configuration for the Cache | null | MEDIUM
| *camel.component.jcache.cacheConfiguration Properties* | Properties to configure jcache | null | MEDIUM
| *camel.component.jcache.cacheConfiguration PropertiesRef* | References to an existing Properties or Map to lookup in the registry to use for configuring jcache. | null | MEDIUM
| *camel.component.jcache.cachingProvider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | MEDIUM
| *camel.component.jcache.configurationUri* | An implementation specific URI for the CacheManager | null | MEDIUM
| *camel.component.jcache.lazyStartProducer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | MEDIUM
| *camel.component.jcache.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END