camel-caffeine-cache-kafka-connector sink configuration
Connector Description: Perform caching operations using Caffeine Cache.
When using camel-caffeine-cache-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
<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>To use this Sink connector in Kafka connect you’ll need to set the following connector.class
connector.class=org.apache.camel.kafkaconnector.caffeinecache.CamelCaffeinecacheSinkConnectorThe camel-caffeine-cache sink connector supports 33 options, which are listed below.
| Name | Description | Default | Required | Priority |
|---|---|---|---|---|
camel.sink.path.cacheName |
the cache name |
null |
true |
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 |
false |
MEDIUM |
camel.sink.endpoint.cacheLoader |
To configure a CacheLoader in case of a LoadCache use |
null |
false |
MEDIUM |
camel.sink.endpoint.createCacheIfNotExist |
Configure if a cache need to be created if it does exist or can’t be pre-configured. |
true |
false |
MEDIUM |
camel.sink.endpoint.evictionType |
Set the eviction Type for this cache One of: [size_based] [time_based] |
"SIZE_BASED" |
false |
MEDIUM |
camel.sink.endpoint.expireAfterAccessTime |
Set the expire After Access Time in case of time based Eviction (in seconds) |
300 |
false |
MEDIUM |
camel.sink.endpoint.expireAfterWriteTime |
Set the expire After Access Write in case of time based Eviction (in seconds) |
300 |
false |
MEDIUM |
camel.sink.endpoint.initialCapacity |
Set the initial Capacity for the cache |
10000 |
false |
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 |
false |
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 |
false |
MEDIUM |
camel.sink.endpoint.maximumSize |
Set the maximum size for the cache |
10000 |
false |
MEDIUM |
camel.sink.endpoint.removalListener |
Set a specific removal Listener for the cache |
null |
false |
MEDIUM |
camel.sink.endpoint.statsCounter |
Set a specific Stats Counter for the cache stats |
null |
false |
MEDIUM |
camel.sink.endpoint.statsEnabled |
To enable stats on the cache |
false |
false |
MEDIUM |
camel.sink.endpoint.keyType |
The cache key type, default java.lang.Object |
null |
false |
MEDIUM |
camel.sink.endpoint.valueType |
The cache value type, default java.lang.Object |
null |
false |
MEDIUM |
camel.component.caffeine-cache.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 |
false |
MEDIUM |
camel.component.caffeine-cache.cacheLoader |
To configure a CacheLoader in case of a LoadCache use |
null |
false |
MEDIUM |
camel.component.caffeine-cache.createCacheIfNot Exist |
Configure if a cache need to be created if it does exist or can’t be pre-configured. |
true |
false |
MEDIUM |
camel.component.caffeine-cache.evictionType |
Set the eviction Type for this cache One of: [size_based] [time_based] |
"SIZE_BASED" |
false |
MEDIUM |
camel.component.caffeine-cache.expireAfterAccess Time |
Set the expire After Access Time in case of time based Eviction (in seconds) |
300 |
false |
MEDIUM |
camel.component.caffeine-cache.expireAfterWrite Time |
Set the expire After Access Write in case of time based Eviction (in seconds) |
300 |
false |
MEDIUM |
camel.component.caffeine-cache.initialCapacity |
Set the initial Capacity for the cache |
10000 |
false |
MEDIUM |
camel.component.caffeine-cache.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 |
false |
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 |
false |
MEDIUM |
camel.component.caffeine-cache.maximumSize |
Set the maximum size for the cache |
10000 |
false |
MEDIUM |
camel.component.caffeine-cache.removalListener |
Set a specific removal Listener for the cache |
null |
false |
MEDIUM |
camel.component.caffeine-cache.statsCounter |
Set a specific Stats Counter for the cache stats |
null |
false |
MEDIUM |
camel.component.caffeine-cache.statsEnabled |
To enable stats on the cache |
false |
false |
MEDIUM |
camel.component.caffeine-cache.autowiredEnabled |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
false |
MEDIUM |
camel.component.caffeine-cache.configuration |
Sets the global component configuration |
null |
false |
MEDIUM |
camel.component.caffeine-cache.keyType |
The cache key type, default java.lang.Object |
null |
false |
MEDIUM |
camel.component.caffeine-cache.valueType |
The cache value type, default java.lang.Object |
null |
false |
MEDIUM |
The camel-caffeine-cache sink connector has no converters out of the box.
The camel-caffeine-cache sink connector has no transforms out of the box.
The camel-caffeine-cache sink connector has no aggregation strategies out of the box.