camel-ehcache-kafka-connector sink configuration
Connector Description: Perform caching operations using Ehcache.
When using camel-ehcache-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-ehcache-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.ehcache.CamelEhcacheSinkConnector
The camel-ehcache sink connector supports 24 options, which are listed below.
Name | Description | Default | Required | Priority |
---|---|---|---|---|
camel.sink.path.cacheName |
the cache name |
null |
true |
HIGH |
camel.sink.endpoint.cacheManager |
The cache manager |
null |
false |
MEDIUM |
camel.sink.endpoint.cacheManagerConfiguration |
The cache manager configuration |
null |
false |
MEDIUM |
camel.sink.endpoint.configurationUri |
URI pointing to the Ehcache XML configuration file’s location |
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.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.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.configuration |
The default cache configuration to be used to create caches. |
null |
false |
MEDIUM |
camel.sink.endpoint.configurations |
A map of cache configuration to be used to create caches. |
null |
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.ehcache.cacheManager |
The cache manager |
null |
false |
MEDIUM |
camel.component.ehcache.cacheManagerConfiguration |
The cache manager configuration |
null |
false |
MEDIUM |
camel.component.ehcache.configurationUri |
URI pointing to the Ehcache XML configuration file’s location |
null |
false |
MEDIUM |
camel.component.ehcache.createCacheIfNotExist |
Configure if a cache need to be created if it does exist or can’t be pre-configured. |
true |
false |
MEDIUM |
camel.component.ehcache.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.ehcache.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.ehcache.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.ehcache.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.ehcache.configuration |
The default cache configuration to be used to create caches. |
null |
false |
MEDIUM |
camel.component.ehcache.configurations |
A map of cache configuration to be used to create caches. |
null |
false |
MEDIUM |
camel.component.ehcache.keyType |
The cache key type, default java.lang.Object |
null |
false |
MEDIUM |
camel.component.ehcache.valueType |
The cache value type, default java.lang.Object |
null |
false |
MEDIUM |
The camel-ehcache sink connector has no converters out of the box.
The camel-ehcache sink connector has no transforms out of the box.
The camel-ehcache sink connector has no aggregation strategies out of the box.