blob: be34aa5e21abbaf61c28e0e7eb282aaf2efed0fb [file] [log] [blame]
// kafka-connector options: START
[[camel-caffeine-cache-kafka-connector-sink]]
= camel-caffeine-cache-kafka-connector sink configuration
When using camel-caffeine-cache-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-caffeine-cache-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-caffeine-cache sink connector supports 22 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.cacheName* | the cache name | null | HIGH
| *camel.sink.endpoint.action* | To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence. | null | MEDIUM
| *camel.sink.endpoint.cache* | To configure an already instantiated cache to be used | null | MEDIUM
| *camel.sink.endpoint.cacheLoader* | To configure a CacheLoader in case of a LoadCache use | null | MEDIUM
| *camel.sink.endpoint.createCacheIfNotExist* | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | MEDIUM
| *camel.sink.endpoint.evictionType* | Set the eviction Type for this cache One of: [size_based] [time_based] | "SIZE_BASED" | MEDIUM
| *camel.sink.endpoint.expireAfterAccessTime* | Set the expire After Access Time in case of time based Eviction (in seconds) | 300 | MEDIUM
| *camel.sink.endpoint.expireAfterWriteTime* | Set the expire After Access Write in case of time based Eviction (in seconds) | 300 | MEDIUM
| *camel.sink.endpoint.initialCapacity* | Set the initial Capacity for the cache | 10000 | MEDIUM
| *camel.sink.endpoint.key* | To configure the default action key. If a key is set in the message header, then the key 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.maximumSize* | Set the maximum size for the cache | 10000 | MEDIUM
| *camel.sink.endpoint.removalListener* | Set a specific removal Listener for the cache | null | MEDIUM
| *camel.sink.endpoint.statsCounter* | Set a specific Stats Counter for the cache stats | null | MEDIUM
| *camel.sink.endpoint.statsEnabled* | To enable stats on the cache | 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.keyType* | The cache key type, default java.lang.Object | null | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.valueType* | The cache value type, default java.lang.Object | null | MEDIUM
| *camel.component.caffeine-cache.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.caffeine-cache.basicProperty Binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.component.caffeine-cache.configuration* | Sets the global component configuration | null | MEDIUM
|===
// kafka-connector options: END