camel-ehcache-kafka-connector source configuration

Connector description: Perform caching operations using Ehcache.

When using camel-ehcache-kafka-connector as source 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 Source connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.ehcache.CamelEhcacheSourceConnector

The camel-ehcache source connector supports 28 options, which are listed below.

Name Description Default Required Priority

camel.source.path.cacheName

the cache name

null

true

HIGH

camel.source.endpoint.cacheManager

The cache manager

null

false

MEDIUM

camel.source.endpoint.cacheManagerConfiguration

The cache manager configuration

null

false

MEDIUM

camel.source.endpoint.configurationUri

URI pointing to the Ehcache XML configuration file’s location

null

false

MEDIUM

camel.source.endpoint.createCacheIfNotExist

Configure if a cache need to be created if it does exist or can’t be pre-configured.

true

false

MEDIUM

camel.source.endpoint.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

false

MEDIUM

camel.source.endpoint.eventFiring

Set the delivery mode (synchronous, asynchronous) One of: [ASYNCHRONOUS] [SYNCHRONOUS]

"ASYNCHRONOUS"

false

MEDIUM

camel.source.endpoint.eventOrdering

Set the delivery mode (ordered, unordered) One of: [UNORDERED] [ORDERED]

"ORDERED"

false

MEDIUM

camel.source.endpoint.eventTypes

Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED). You can specify multiple entries separated by comma. One of: [EVICTED] [EXPIRED] [REMOVED] [CREATED] [UPDATED]

null

false

MEDIUM

camel.source.endpoint.exceptionHandler

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

null

false

MEDIUM

camel.source.endpoint.exchangePattern

Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut]

null

false

MEDIUM

camel.source.endpoint.configuration

The default cache configuration to be used to create caches.

null

false

MEDIUM

camel.source.endpoint.configurations

A map of cache configuration to be used to create caches.

null

false

MEDIUM

camel.source.endpoint.keyType

The cache key type, default java.lang.Object

null

false

MEDIUM

camel.source.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.bridgeErrorHandler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.

false

false

MEDIUM

camel.component.ehcache.eventFiring

Set the delivery mode (synchronous, asynchronous) One of: [ASYNCHRONOUS] [SYNCHRONOUS]

"ASYNCHRONOUS"

false

MEDIUM

camel.component.ehcache.eventOrdering

Set the delivery mode (ordered, unordered) One of: [UNORDERED] [ORDERED]

"ORDERED"

false

MEDIUM

camel.component.ehcache.eventTypes

Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED). You can specify multiple entries separated by comma. One of: [EVICTED] [EXPIRED] [REMOVED] [CREATED] [UPDATED]

null

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 source connector has no converters out of the box.

The camel-ehcache source connector has no transforms out of the box.

The camel-ehcache source connector has no aggregation strategies out of the box.