| // kafka-connector options: START |
| [[camel-jcache-kafka-connector-source]] |
| = camel-jcache-kafka-connector source configuration |
| |
| Connector description: Perform caching operations against JSR107/JCache. |
| |
| 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> |
| ---- |
| |
| To use this Source connector in Kafka connect you'll need to set the following connector.class |
| |
| [source,java] |
| ---- |
| connector.class=org.apache.camel.kafkaconnector.jcache.CamelJcacheSourceConnector |
| ---- |
| |
| |
| The camel-jcache source connector supports 29 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,1,1",options="header"] |
| |=== |
| | Name | Description | Default | Required | Priority |
| | *camel.source.path.cacheName* | The name of the cache | null | true | HIGH |
| | *camel.source.endpoint.cacheConfiguration* | A Configuration for the Cache | null | false | MEDIUM |
| | *camel.source.endpoint.cacheConfigurationProperties* | The Properties for the javax.cache.spi.CachingProvider to create the CacheManager | null | false | MEDIUM |
| | *camel.source.endpoint.cachingProvider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | false | MEDIUM |
| | *camel.source.endpoint.configurationUri* | An implementation specific URI for the CacheManager | null | false | MEDIUM |
| | *camel.source.endpoint.managementEnabled* | Whether management gathering is enabled | false | false | MEDIUM |
| | *camel.source.endpoint.readThrough* | If read-through caching should be used | false | false | MEDIUM |
| | *camel.source.endpoint.statisticsEnabled* | Whether statistics gathering is enabled | false | false | MEDIUM |
| | *camel.source.endpoint.storeByValue* | If cache should use store-by-value or store-by-reference semantics | true | false | MEDIUM |
| | *camel.source.endpoint.writeThrough* | If write-through caching should be used | false | 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.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 | false | MEDIUM |
| | *camel.source.endpoint.oldValueRequired* | if the old value is required for events | false | false | MEDIUM |
| | *camel.source.endpoint.synchronous* | if the event listener should block the thread causing the event | false | false | MEDIUM |
| | *camel.source.endpoint.eventFilters* | The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored | 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.cacheLoaderFactory* | The CacheLoader factory | null | false | MEDIUM |
| | *camel.source.endpoint.cacheWriterFactory* | The CacheWriter factory | null | false | MEDIUM |
| | *camel.source.endpoint.createCacheIfNotExists* | Configure if a cache need to be created if it does exist or can't be pre-configured. | true | false | MEDIUM |
| | *camel.source.endpoint.expiryPolicyFactory* | The ExpiryPolicy factory | null | false | MEDIUM |
| | *camel.source.endpoint.lookupProviders* | Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi. | false | false | MEDIUM |
| | *camel.component.jcache.cacheConfiguration* | A Configuration for the Cache | null | false | MEDIUM |
| | *camel.component.jcache.cacheConfiguration Properties* | Properties to configure jcache | null | false | MEDIUM |
| | *camel.component.jcache.cacheConfiguration PropertiesRef* | References to an existing Properties or Map to lookup in the registry to use for configuring jcache. | null | false | MEDIUM |
| | *camel.component.jcache.cachingProvider* | The fully qualified class name of the javax.cache.spi.CachingProvider | null | false | MEDIUM |
| | *camel.component.jcache.configurationUri* | An implementation specific URI for the CacheManager | null | false | 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 | 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 | false | MEDIUM |
| |=== |
| |
| |
| |
| The camel-jcache source connector has no converters out of the box. |
| |
| |
| |
| |
| |
| The camel-jcache source connector has no transforms out of the box. |
| |
| |
| |
| |
| |
| The camel-jcache source connector has no aggregation strategies out of the box. |
| |
| |
| |
| |
| // kafka-connector options: END |
