blob: b5974c5367f9fcce5ca56dba189a8dc4ae2b256e [file] [log] [blame]
// kafka-connector options: START
[[camel-ehcache-kafka-connector-source]]
= camel-ehcache-kafka-connector source configuration
When using camel-ehcache-kafka-connector as source 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-ehcache-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-ehcache source connector supports 25 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.cacheName* | the cache name | null | ConfigDef.Importance.HIGH
| *camel.source.endpoint.cacheManager* | The cache manager | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.cacheManagerConfiguration* | The cache manager configuration | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.configurationUri* | URI pointing to the Ehcache XML configuration file's location | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.createCacheIfNotExist* | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.eventFiring* | Set the delivery mode (synchronous, asynchronous) One of: [ASYNCHRONOUS] [SYNCHRONOUS] | "ASYNCHRONOUS" | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.eventOrdering* | Set the delivery mode (ordered, unordered) One of: [UNORDERED] [ORDERED] | "ORDERED" | ConfigDef.Importance.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 | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.configuration* | The default cache configuration to be used to create caches. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.configurations* | A map of cache configuration to be used to create caches. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.keyType* | The cache key type, default java.lang.Object | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.valueType* | The cache value type, default java.lang.Object | null | ConfigDef.Importance.MEDIUM
| *camel.component.ehcache.cacheConfiguration* | The default cache configuration to be used to create caches. | null | ConfigDef.Importance.MEDIUM
| *camel.component.ehcache.cacheConfigurationUri* | URI pointing to the Ehcache XML configuration file's location | null | ConfigDef.Importance.MEDIUM
| *camel.component.ehcache.cacheManager* | The cache manager | null | ConfigDef.Importance.MEDIUM
| *camel.component.ehcache.cacheManagerConfiguration* | The cache manager configuration | null | ConfigDef.Importance.MEDIUM
| *camel.component.ehcache.cachesConfigurations* | A map of caches configurations to be used to create caches. | null | ConfigDef.Importance.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 | ConfigDef.Importance.MEDIUM
| *camel.component.ehcache.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| *camel.component.ehcache.configuration* | Sets the global component configuration | null | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END