camel-jcache-kafka-connector sink configuration

Connector Description: Perform caching operations against JSR107/JCache.

When using camel-jcache-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-jcache-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.jcache.CamelJcacheSinkConnector

The camel-jcache sink connector supports 24 options, which are listed below.

Name Description Default Priority

camel.sink.path.cacheName

Required The name of the cache.

HIGH

camel.sink.endpoint.cacheConfiguration

A Configuration for the Cache.

MEDIUM

camel.sink.endpoint.cacheConfigurationProperties

The Properties for the javax.cache.spi.CachingProvider to create the CacheManager.

MEDIUM

camel.sink.endpoint.cachingProvider

The fully qualified class name of the javax.cache.spi.CachingProvider.

MEDIUM

camel.sink.endpoint.configurationUri

An implementation specific URI for the CacheManager.

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.

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.cacheLoaderFactory

The CacheLoader factory.

MEDIUM

camel.sink.endpoint.cacheWriterFactory

The CacheWriter factory.

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.

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.

MEDIUM

camel.component.jcache.cacheConfigurationProperties

Properties to configure jcache.

MEDIUM

camel.component.jcache.cacheConfigurationPropertiesRef

References to an existing Properties or Map to lookup in the registry to use for configuring jcache.

MEDIUM

camel.component.jcache.cachingProvider

The fully qualified class name of the javax.cache.spi.CachingProvider.

MEDIUM

camel.component.jcache.configurationUri

An implementation specific URI for the CacheManager.

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.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

MEDIUM

The camel-jcache sink connector has no converters out of the box.

The camel-jcache sink connector has no transforms out of the box.

The camel-jcache sink connector has no aggregation strategies out of the box.

Back to top