Caffeine Cache
Perform caching operations using Caffeine Cache.
What’s inside
-
Caffeine Cache component, URI syntax:
caffeine-cache:cacheName -
Caffeine LoadCache component, URI syntax:
caffeine-loadcache:cacheName
Please refer to the above links for usage and configuration details.
Maven coordinates
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-caffeine-starter</artifactId>
</dependency>Spring Boot Auto-Configuration
The starter supports 34 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.caffeine-cache.action | To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence. | String | |
camel.component.caffeine-cache.autowired-enabled | 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 | Boolean |
camel.component.caffeine-cache.cache-loader | To configure a CacheLoader in case of a LoadCache use. The option is a com.github.benmanes.caffeine.cache.CacheLoader type. | CacheLoader | |
camel.component.caffeine-cache.configuration | Sets the global component configuration. The option is a org.apache.camel.component.caffeine.CaffeineConfiguration type. | CaffeineConfiguration | |
camel.component.caffeine-cache.create-cache-if-not-exist | Automatic create the Caffeine cache if none has been configured or exists in the registry. | true | Boolean |
camel.component.caffeine-cache.enabled | Whether to enable auto configuration of the caffeine-cache component. This is enabled by default. | Boolean | |
camel.component.caffeine-cache.eviction-type | Set the eviction Type for this cache | size-based | EvictionType |
camel.component.caffeine-cache.expire-after-access-time | Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds. | 300 | Integer |
camel.component.caffeine-cache.expire-after-write-time | Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value. The unit is in seconds. | 300 | Integer |
camel.component.caffeine-cache.initial-capacity | Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory. | Integer | |
camel.component.caffeine-cache.key | To configure the default action key. If a key is set in the message header, then the key from the header takes precedence. | String | |
camel.component.caffeine-cache.lazy-start-producer | 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 | Boolean |
camel.component.caffeine-cache.maximum-size | Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often. When size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may instead prefer to configure the cache to execute tasks directly on the same thread. | Integer | |
camel.component.caffeine-cache.removal-listener | Set a specific removal Listener for the cache. The option is a com.github.benmanes.caffeine.cache.RemovalListener type. | RemovalListener | |
camel.component.caffeine-cache.stats-counter | Set a specific Stats Counter for the cache stats. The option is a com.github.benmanes.caffeine.cache.stats.StatsCounter type. | StatsCounter | |
camel.component.caffeine-cache.stats-enabled | To enable stats on the cache | false | Boolean |
camel.component.caffeine-cache.value-type | The cache value type, default java.lang.Object | String | |
camel.component.caffeine-loadcache.action | To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence. | String | |
camel.component.caffeine-loadcache.autowired-enabled | 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 | Boolean |
camel.component.caffeine-loadcache.cache-loader | To configure a CacheLoader in case of a LoadCache use. The option is a com.github.benmanes.caffeine.cache.CacheLoader type. | CacheLoader | |
camel.component.caffeine-loadcache.configuration | Sets the global component configuration. The option is a org.apache.camel.component.caffeine.CaffeineConfiguration type. | CaffeineConfiguration | |
camel.component.caffeine-loadcache.create-cache-if-not-exist | Automatic create the Caffeine cache if none has been configured or exists in the registry. | true | Boolean |
camel.component.caffeine-loadcache.enabled | Whether to enable auto configuration of the caffeine-loadcache component. This is enabled by default. | Boolean | |
camel.component.caffeine-loadcache.eviction-type | Set the eviction Type for this cache | size-based | EvictionType |
camel.component.caffeine-loadcache.expire-after-access-time | Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds. | 300 | Integer |
camel.component.caffeine-loadcache.expire-after-write-time | Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, or the most recent replacement of its value. The unit is in seconds. | 300 | Integer |
camel.component.caffeine-loadcache.initial-capacity | Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory. | Integer | |
camel.component.caffeine-loadcache.key | To configure the default action key. If a key is set in the message header, then the key from the header takes precedence. | String | |
camel.component.caffeine-loadcache.lazy-start-producer | 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 | Boolean |
camel.component.caffeine-loadcache.maximum-size | Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often. When size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may instead prefer to configure the cache to execute tasks directly on the same thread. | Integer | |
camel.component.caffeine-loadcache.removal-listener | Set a specific removal Listener for the cache. The option is a com.github.benmanes.caffeine.cache.RemovalListener type. | RemovalListener | |
camel.component.caffeine-loadcache.stats-counter | Set a specific Stats Counter for the cache stats. The option is a com.github.benmanes.caffeine.cache.stats.StatsCounter type. | StatsCounter | |
camel.component.caffeine-loadcache.stats-enabled | To enable stats on the cache | false | Boolean |
camel.component.caffeine-loadcache.value-type | The cache value type, default java.lang.Object | String |