| // kafka-connector options: START |
| [[camel-jcache-kafka-connector-source]] |
| = camel-jcache-kafka-connector source configuration |
| |
| When using camel-jcache-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-jcache-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-jcache source connector supports 30 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.cacheName* | The name of the cache | null | HIGH |
| | *camel.source.endpoint.cacheConfiguration* | A Configuration for the Cache | null | MEDIUM |
| | *camel.source.endpoint.cacheConfigurationProperties* | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | null | MEDIUM |
| | *camel.source.endpoint.cachingProvider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | MEDIUM |
| | *camel.source.endpoint.configurationUri* | An implementation specific URI for the CacheManager | null | MEDIUM |
| | *camel.source.endpoint.managementEnabled* | Whether management gathering is enabled | false | MEDIUM |
| | *camel.source.endpoint.readThrough* | If read-through caching should be used | false | MEDIUM |
| | *camel.source.endpoint.statisticsEnabled* | Whether statistics gathering is enabled | false | MEDIUM |
| | *camel.source.endpoint.storeByValue* | If cache should use store-by-value or store-by-reference semantics | true | MEDIUM |
| | *camel.source.endpoint.writeThrough* | If write-through caching should be used | 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 | MEDIUM |
| | *camel.source.endpoint.filteredEvents* | Events a consumer should filter (multiple events can be separated by comma). If using filteredEvents option, then eventFilters one will be ignored One of: [CREATED] [UPDATED] [REMOVED] [EXPIRED] | null | MEDIUM |
| | *camel.source.endpoint.oldValueRequired* | if the old value is required for events | false | MEDIUM |
| | *camel.source.endpoint.synchronous* | if the event listener should block the thread causing the event | false | MEDIUM |
| | *camel.source.endpoint.eventFilters* | The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored | null | 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 | MEDIUM |
| | *camel.source.endpoint.exchangePattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | 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 | MEDIUM |
| | *camel.source.endpoint.cacheLoaderFactory* | The CacheLoader factory | null | MEDIUM |
| | *camel.source.endpoint.cacheWriterFactory* | The CacheWriter factory | null | MEDIUM |
| | *camel.source.endpoint.createCacheIfNotExists* | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | MEDIUM |
| | *camel.source.endpoint.expiryPolicyFactory* | The ExpiryPolicy factory | null | MEDIUM |
| | *camel.source.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 | null | MEDIUM |
| | *camel.component.jcache.cacheConfiguration Properties* | Properties to configure jcache | null | MEDIUM |
| | *camel.component.jcache.cacheConfiguration PropertiesRef* | References to an existing Properties or Map to lookup in the registry to use for configuring jcache. | null | MEDIUM |
| | *camel.component.jcache.cachingProvider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | MEDIUM |
| | *camel.component.jcache.configurationUri* | An implementation specific URI for the CacheManager | null | MEDIUM |
| | *camel.component.jcache.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 | MEDIUM |
| | *camel.component.jcache.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM |
| |=== |
| // kafka-connector options: END |
