Caffeine LoadCache
Since Camel 2.20
Only producer is supported
The Caffeine Loadcache component enables you to perform caching operations using the LoadingCache from Caffeine.
Maven users will need to add the following dependency to
their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-caffeine</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>URI format
caffeine-loadcache://cacheName[?options]You can append query options to the URI in the following
format, ?option=value&option=#beanRef&…
Options
The Caffeine LoadCache component supports 18 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
action (producer) |
To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence. |
String |
|
cache (producer) |
To configure an already instantiated cache to be used |
Cache |
|
cacheLoader (producer) |
To configure a CacheLoader in case of a LoadCache use |
CacheLoader |
|
createCacheIfNotExist (producer) |
Configure if a cache need to be created if it does exist or can’t be pre-configured. |
true |
boolean |
evictionType (producer) |
Set the eviction Type for this cache. The value can be one of: size_based, time_based |
SIZE_BASED |
EvictionType |
expireAfterAccessTime (producer) |
Set the expire After Access Time in case of time based Eviction (in seconds) |
300 |
int |
expireAfterWriteTime (producer) |
Set the expire After Access Write in case of time based Eviction (in seconds) |
300 |
int |
initialCapacity (producer) |
Set the initial Capacity for the cache |
10000 |
int |
key (producer) |
To configure the default action key. If a key is set in the message header, then the key from the header takes precedence. |
Object |
|
lazyStartProducer (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 |
maximumSize (producer) |
Set the maximum size for the cache |
10000 |
int |
removalListener (producer) |
Set a specific removal Listener for the cache |
RemovalListener |
|
statsCounter (producer) |
Set a specific Stats Counter for the cache stats |
StatsCounter |
|
statsEnabled (producer) |
To enable stats on the cache |
false |
boolean |
basicPropertyBinding (advanced) |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
configuration (advanced) |
Sets the global component configuration |
CaffeineConfiguration |
|
keyType (advanced) |
The cache key type, default java.lang.Object |
String |
|
valueType (advanced) |
The cache value type, default java.lang.Object |
String |
The Caffeine LoadCache endpoint is configured using URI syntax:
caffeine-loadcache:cacheName
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
cacheName |
Required the cache name |
String |
Query Parameters (18 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
action (producer) |
To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence. |
String |
|
cache (producer) |
To configure an already instantiated cache to be used |
Cache |
|
cacheLoader (producer) |
To configure a CacheLoader in case of a LoadCache use |
CacheLoader |
|
createCacheIfNotExist (producer) |
Configure if a cache need to be created if it does exist or can’t be pre-configured. |
true |
boolean |
evictionType (producer) |
Set the eviction Type for this cache. The value can be one of: size_based, time_based |
SIZE_BASED |
EvictionType |
expireAfterAccessTime (producer) |
Set the expire After Access Time in case of time based Eviction (in seconds) |
300 |
int |
expireAfterWriteTime (producer) |
Set the expire After Access Write in case of time based Eviction (in seconds) |
300 |
int |
initialCapacity (producer) |
Set the initial Capacity for the cache |
10000 |
int |
key (producer) |
To configure the default action key. If a key is set in the message header, then the key from the header takes precedence. |
Object |
|
lazyStartProducer (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 |
maximumSize (producer) |
Set the maximum size for the cache |
10000 |
int |
removalListener (producer) |
Set a specific removal Listener for the cache |
RemovalListener |
|
statsCounter (producer) |
Set a specific Stats Counter for the cache stats |
StatsCounter |
|
statsEnabled (producer) |
To enable stats on the cache |
false |
boolean |
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
keyType (advanced) |
The cache key type, default java.lang.Object |
String |
|
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
valueType (advanced) |
The cache value type, default java.lang.Object |
String |
Spring Boot Auto-Configuration
When using caffeine with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-caffeine-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 38 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.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.caffeine-cache.cache |
To configure an already instantiated cache to be used. The option is a com.github.benmanes.caffeine.cache.Cache type. |
String |
|
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. |
String |
|
camel.component.caffeine-cache.configuration |
Sets the global component configuration. The option is a org.apache.camel.component.caffeine.CaffeineConfiguration type. |
String |
|
camel.component.caffeine-cache.create-cache-if-not-exist |
Configure if a cache need to be created if it does exist or can’t be pre-configured. |
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 |
EvictionType |
|
camel.component.caffeine-cache.expire-after-access-time |
Set the expire After Access Time in case of time based Eviction (in seconds) |
300 |
Integer |
camel.component.caffeine-cache.expire-after-write-time |
Set the expire After Access Write in case of time based Eviction (in seconds) |
300 |
Integer |
camel.component.caffeine-cache.initial-capacity |
Set the initial Capacity for the cache |
10000 |
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. The option is a java.lang.Object type. |
String |
|
camel.component.caffeine-cache.key-type |
The cache key type, default java.lang.Object |
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 |
Set the maximum size for the cache |
10000 |
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. |
String |
|
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. |
String |
|
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.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.caffeine-loadcache.cache |
To configure an already instantiated cache to be used. The option is a com.github.benmanes.caffeine.cache.Cache type. |
String |
|
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. |
String |
|
camel.component.caffeine-loadcache.configuration |
Sets the global component configuration. The option is a org.apache.camel.component.caffeine.CaffeineConfiguration type. |
String |
|
camel.component.caffeine-loadcache.create-cache-if-not-exist |
Configure if a cache need to be created if it does exist or can’t be pre-configured. |
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 |
EvictionType |
|
camel.component.caffeine-loadcache.expire-after-access-time |
Set the expire After Access Time in case of time based Eviction (in seconds) |
300 |
Integer |
camel.component.caffeine-loadcache.expire-after-write-time |
Set the expire After Access Write in case of time based Eviction (in seconds) |
300 |
Integer |
camel.component.caffeine-loadcache.initial-capacity |
Set the initial Capacity for the cache |
10000 |
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. The option is a java.lang.Object type. |
String |
|
camel.component.caffeine-loadcache.key-type |
The cache key type, default java.lang.Object |
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 |
Set the maximum size for the cache |
10000 |
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. |
String |
|
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. |
String |
|
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 |