Ehcache

Perform caching operations using Ehcache.

What’s inside

Ehcache component, URI syntax: ehcache:cacheName

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-ehcache-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 20 options, which are listed below.

Name	Description	Default	Type
camel.component.ehcache.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.ehcache.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.ehcache.bridge-error-handler	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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	Boolean
camel.component.ehcache.cache-manager	The cache manager. The option is a org.ehcache.CacheManager type.		CacheManager
camel.component.ehcache.cache-manager-configuration	The cache manager configuration. The option is a org.ehcache.config.Configuration type.		Configuration
camel.component.ehcache.configuration	The default cache configuration to be used to create caches. The option is a org.ehcache.config.CacheConfiguration type.		CacheConfiguration
camel.component.ehcache.configuration-uri	URI pointing to the Ehcache XML configuration file’s location		String
camel.component.ehcache.configurations	A map of cache configuration to be used to create caches.		CacheConfiguration>
camel.component.ehcache.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.ehcache.customizer.cache-configuration.enabled	Enable or disable the cache-configuration customizer.	true	Boolean
camel.component.ehcache.customizer.cache-configuration.mode	Configure if the cache configurations have be added or they have to replace those already configured on the component.	append	CacheConfigurationCustomizerConfiguration$Mode
camel.component.ehcache.customizer.cache-manager.enabled	Enable or disable the cache-manager customizer.	true	Boolean
camel.component.ehcache.customizer.cache-manager.override	Configure if the cache manager eventually set on the component should be overridden by the customizer.	false	Boolean
camel.component.ehcache.enabled	Whether to enable auto configuration of the ehcache component. This is enabled by default.		Boolean
camel.component.ehcache.event-firing	Set the delivery mode (synchronous, asynchronous)	asynchronous	EventFiring
camel.component.ehcache.event-ordering	Set the delivery mode (ordered, unordered)	ordered	EventOrdering
camel.component.ehcache.event-types	Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED). You can specify multiple entries separated by comma.		String
camel.component.ehcache.key-type	The cache key type, default java.lang.Object		String
camel.component.ehcache.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.ehcache.value-type	The cache value type, default java.lang.Object		String

Name

Description

Default

Type

camel.component.ehcache.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.ehcache.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.ehcache.bridge-error-handler

Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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

Boolean

camel.component.ehcache.cache-manager

The cache manager. The option is a org.ehcache.CacheManager type.

CacheManager

camel.component.ehcache.cache-manager-configuration

The cache manager configuration. The option is a org.ehcache.config.Configuration type.

Configuration

camel.component.ehcache.configuration

The default cache configuration to be used to create caches. The option is a org.ehcache.config.CacheConfiguration type.

CacheConfiguration

camel.component.ehcache.configuration-uri

URI pointing to the Ehcache XML configuration file’s location

String

camel.component.ehcache.configurations

A map of cache configuration to be used to create caches.

CacheConfiguration>

camel.component.ehcache.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.ehcache.customizer.cache-configuration.enabled

Enable or disable the cache-configuration customizer.

true

Boolean

camel.component.ehcache.customizer.cache-configuration.mode

Configure if the cache configurations have be added or they have to replace those already configured on the component.

append

CacheConfigurationCustomizerConfiguration$Mode

camel.component.ehcache.customizer.cache-manager.enabled

Enable or disable the cache-manager customizer.

true

Boolean

camel.component.ehcache.customizer.cache-manager.override

Configure if the cache manager eventually set on the component should be overridden by the customizer.

false

Boolean

camel.component.ehcache.enabled

Whether to enable auto configuration of the ehcache component. This is enabled by default.

Boolean

camel.component.ehcache.event-firing

Set the delivery mode (synchronous, asynchronous)

asynchronous

EventFiring

camel.component.ehcache.event-ordering

Set the delivery mode (ordered, unordered)

ordered

EventOrdering

camel.component.ehcache.event-types

Set the type of events to listen for (EVICTED,EXPIRED,REMOVED,CREATED,UPDATED). You can specify multiple entries separated by comma.

String

camel.component.ehcache.key-type

The cache key type, default java.lang.Object

String

camel.component.ehcache.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.ehcache.value-type

The cache value type, default java.lang.Object

String