--- apiVersion: v1 kind: List items: - apiVersion: v1 kind: ConfigMap metadata: labels: funktion.fabric8.io/kind: Connector provider: fabric8 project: connector-cache version: 1.1.41 group: io.fabric8.funktion.connector name: cache data: deployment.yml: | --- apiVersion: extensions/v1beta1 kind: Deployment metadata: labels: funktion.fabric8.io/kind: Subscription connector: cache spec: replicas: 1 template: metadata: labels: funktion.fabric8.io/kind: Subscription connector: cache spec: containers: - image: funktion/connector-cache:1.1.41 name: connector schema.yml: | --- component: kind: component scheme: cache syntax: cache:cacheName title: EHCache description: The cache component enables you to perform caching operations using EHCache as the Cache Implementation. label: cache deprecated: true async: false javaType: org.apache.camel.component.cache.CacheComponent groupId: org.apache.camel artifactId: camel-cache version: 2.18.1 componentProperties: cacheManagerFactory: kind: property type: object javaType: org.apache.camel.component.cache.CacheManagerFactory deprecated: false secret: false description: To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used. order: 0 configuration: kind: property type: object javaType: org.apache.camel.component.cache.CacheConfiguration deprecated: false secret: false description: Sets the Cache configuration order: 1 configurationFile: kind: property type: string javaType: java.lang.String deprecated: false secret: false description: Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml order: 2 properties: cacheName: kind: path group: common required: true type: string javaType: java.lang.String deprecated: false secret: false description: Name of the cache order: 0 diskExpiryThreadIntervalSeconds: kind: parameter group: common type: integer javaType: long deprecated: false secret: false description: The number of seconds between runs of the disk expiry thread. order: 1 diskPersistent: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Whether the disk store persists between restarts of the application. order: 2 diskStorePath: kind: parameter group: common type: string javaType: java.lang.String deprecated: true secret: false description: This parameter is ignored. CacheManager sets it using setter injection. order: 3 eternal: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires. order: 4 key: kind: parameter group: common type: string javaType: java.lang.String deprecated: false secret: false description: The default key to use. If a key is provided in the message header then the key from the header takes precedence. order: 5 maxElementsInMemory: kind: parameter group: common type: integer javaType: int deprecated: false secret: false defaultValue: "1000" description: The number of elements that may be stored in the defined cache in memory. order: 6 memoryStoreEvictionPolicy: kind: parameter group: common type: string javaType: net.sf.ehcache.store.MemoryStoreEvictionPolicy enum: - LRU - LFU - FIFO deprecated: false secret: false defaultValue: LFU description: Which eviction strategy to use when maximum number of elements in memory is reached. The strategy defines which elements to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out order: 7 objectCache: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Whether to turn on allowing to store non serializable objects in the cache. If this option is enabled then overflow to disk cannot be enabled as well. order: 8 operation: kind: parameter group: common type: string javaType: java.lang.String deprecated: false secret: false description: The default cache operation to use. If an operation in the message header then the operation from the header takes precedence. order: 9 overflowToDisk: kind: parameter group: common type: boolean javaType: boolean deprecated: false secret: false defaultValue: true description: Specifies whether cache may overflow to disk order: 10 timeToIdleSeconds: kind: parameter group: common type: integer javaType: long deprecated: false secret: false defaultValue: "300" description: The maximum amount of time between accesses before an element expires order: 11 timeToLiveSeconds: kind: parameter group: common type: integer javaType: long deprecated: false secret: false defaultValue: "300" description: The maximum time between creation time and when an element expires. Is used only if the element is not eternal order: 12 bridgeErrorHandler: kind: parameter group: consumer label: consumer type: boolean javaType: boolean optionalPrefix: consumer. deprecated: false secret: false defaultValue: false description: 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/ERROR level and ignored. order: 13 exceptionHandler: kind: parameter group: consumer (advanced) label: consumer,advanced type: object javaType: org.apache.camel.spi.ExceptionHandler optionalPrefix: consumer. deprecated: false secret: false description: To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. order: 14 exchangePattern: kind: parameter group: consumer (advanced) label: consumer,advanced type: string javaType: org.apache.camel.ExchangePattern enum: - InOnly - RobustInOnly - InOut - InOptionalOut - OutOnly - RobustOutOnly - OutIn - OutOptionalIn deprecated: false secret: false description: Sets the exchange pattern when the consumer creates an exchange. order: 15 cacheLoaderRegistry: kind: parameter group: advanced label: advanced type: object javaType: org.apache.camel.component.cache.CacheLoaderRegistry deprecated: false secret: false description: To configure cache loader using the CacheLoaderRegistry order: 16 cacheManagerFactory: kind: parameter group: advanced label: advanced type: object javaType: org.apache.camel.component.cache.CacheManagerFactory deprecated: false secret: false description: To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory configured on the component is used. order: 17 eventListenerRegistry: kind: parameter group: advanced label: advanced type: object javaType: org.apache.camel.component.cache.CacheEventListenerRegistry deprecated: false secret: false description: To configure event listeners using the CacheEventListenerRegistry order: 18 synchronous: kind: parameter group: advanced label: advanced type: boolean javaType: boolean deprecated: false secret: false defaultValue: false description: Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). order: 19 documentation.adoc: |+ [[Cache-CacheComponent]] Cache Component ~~~~~~~~~~~~~~~ *Available as of Camel 2.1* The *cache* component enables you to perform caching operations using EHCache as the Cache Implementation. The cache itself is created on demand or if a cache of that name already exists then it is simply utilized with its original settings. This component supports producer and event based consumer endpoints. The Cache consumer is an event based consumer and can be used to listen and respond to specific cache activities. If you need to perform selections from a pre-existing cache, use the processors defined for the cache component. Maven users will need to add the following dependency to their `pom.xml` for this component: [source,xml] ------------------------------------------------------------ org.apache.camel camel-cache x.x.x ------------------------------------------------------------ [[Cache-URIformat]] URI format ^^^^^^^^^^ [source,java] --------------------------- cache://cacheName[?options] --------------------------- You can append query options to the URI in the following format, `?option=value&option=#beanRef&...` [[Cache-Options]] Options ^^^^^^^ // component options: START The EHCache component supports 3 options which are listed below. {% raw %} [width="100%",cols="2,1m,7",options="header"] |======================================================================= | Name | Java Type | Description | cacheManagerFactory | CacheManagerFactory | To use the given CacheManagerFactory for creating the CacheManager. By default the DefaultCacheManagerFactory is used. | configuration | CacheConfiguration | Sets the Cache configuration | configurationFile | String | Sets the location of the ehcache.xml file to load from classpath or file system. By default the file is loaded from classpath:ehcache.xml |======================================================================= {% endraw %} // component options: END // endpoint options: START The EHCache component supports 20 endpoint options which are listed below: {% raw %} [width="100%",cols="2,1,1m,1m,5",options="header"] |======================================================================= | Name | Group | Default | Java Type | Description | cacheName | common | | String | *Required* Name of the cache | diskExpiryThreadIntervalSeconds | common | | long | The number of seconds between runs of the disk expiry thread. | diskPersistent | common | false | boolean | Whether the disk store persists between restarts of the application. | diskStorePath | common | | String | This parameter is ignored. CacheManager sets it using setter injection. | eternal | common | false | boolean | Sets whether elements are eternal. If eternal timeouts are ignored and the element never expires. | key | common | | String | The default key to use. If a key is provided in the message header then the key from the header takes precedence. | maxElementsInMemory | common | 1000 | int | The number of elements that may be stored in the defined cache in memory. | memoryStoreEvictionPolicy | common | LFU | MemoryStoreEvictionPolicy | Which eviction strategy to use when maximum number of elements in memory is reached. The strategy defines which elements to be removed. LRU - Lest Recently Used LFU - Lest Frequently Used FIFO - First In First Out | objectCache | common | false | boolean | Whether to turn on allowing to store non serializable objects in the cache. If this option is enabled then overflow to disk cannot be enabled as well. | operation | common | | String | The default cache operation to use. If an operation in the message header then the operation from the header takes precedence. | overflowToDisk | common | true | boolean | Specifies whether cache may overflow to disk | timeToIdleSeconds | common | 300 | long | The maximum amount of time between accesses before an element expires | timeToLiveSeconds | common | 300 | long | The maximum time between creation time and when an element expires. Is used only if the element is not eternal | bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. | exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. | exchangePattern | consumer (advanced) | | ExchangePattern | Sets the exchange pattern when the consumer creates an exchange. | cacheLoaderRegistry | advanced | | CacheLoaderRegistry | To configure cache loader using the CacheLoaderRegistry | cacheManagerFactory | advanced | | CacheManagerFactory | To use a custom CacheManagerFactory for creating the CacheManager to be used by this endpoint. By default the CacheManagerFactory configured on the component is used. | eventListenerRegistry | advanced | | CacheEventListenerRegistry | To configure event listeners using the CacheEventListenerRegistry | synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= {% endraw %} // endpoint options: END [[Cache-SendingReceivingMessagestofromthecache]] Sending/Receiving Messages to/from the cache ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [[Cache-MessageHeadersuptoCamel2.7]] Message Headers up to Camel 2.7 +++++++++++++++++++++++++++++++ [width="100%",cols="20%,80%",options="header",] |======================================================================= |Header |Description |`CACHE_OPERATION` |The operation to be performed on the cache. Valid options are * GET * CHECK * ADD * UPDATE * DELETE * DELETEALL + `GET` and `CHECK` requires *Camel 2.3* onwards. |`CACHE_KEY` |The cache key used to store the Message in the cache. The cache key is optional if the CACHE_OPERATION is DELETEALL |======================================================================= [[Cache-MessageHeadersCamel2.8]] Message Headers Camel 2.8+ ++++++++++++++++++++++++++ [Info] ==== Header changes in Camel 2.8 The header names and supported values have changed to be prefixed with 'CamelCache' and use mixed case. This makes them easier to identify and keep separate from other headers. The CacheConstants variable names remain unchanged, just their values have been changed. Also, these headers are now removed from the exchange after the cache operation is performed. ==== [width="100%",cols="20%,80%",options="header",] |======================================================================= |Header |Description |`CamelCacheOperation` |The operation to be performed on the cache. The valid options are * CamelCacheGet * CamelCacheCheck * CamelCacheAdd * CamelCacheUpdate * CamelCacheDelete * CamelCacheDeleteAll |`CamelCacheKey` |The cache key used to store the Message in the cache. The cache key is optional if the CamelCacheOperation is CamelCacheDeleteAll |======================================================================= The `CamelCacheAdd` and `CamelCacheUpdate` operations support additional headers: [width="100%",cols="10%,10%,80%",options="header",] |======================================================================= |Header |Type |Description |`CamelCacheTimeToLive` |`Integer` |*Camel 2.11:* Time to live in seconds. |`CamelCacheTimeToIdle` |`Integer` |*Camel 2.11:* Time to idle in seconds. |`CamelCacheEternal` |`Boolean` |*Camel 2.11:* Whether the content is eternal. |======================================================================= [[Cache-CacheProducer]] Cache Producer ++++++++++++++ Sending data to the cache involves the ability to direct payloads in exchanges to be stored in a pre-existing or created-on-demand cache. The mechanics of doing this involve * setting the Message Exchange Headers shown above. * ensuring that the Message Exchange Body contains the message directed to the cache [[Cache-CacheConsumer]] Cache Consumer ++++++++++++++ Receiving data from the cache involves the ability of the CacheConsumer to listen on a pre-existing or created-on-demand Cache using an event Listener and receive automatic notifications when any cache activity take place (i.e CamelCacheGet/CamelCacheUpdate/CamelCacheDelete/CamelCacheDeleteAll). Upon such an activity taking place * an exchange containing Message Exchange Headers and a Message Exchange Body containing the just added/updated payload is placed and sent. * in case of a CamelCacheDeleteAll operation, the Message Exchange Header CamelCacheKey and the Message Exchange Body are not populated. [[Cache-CacheProcessors]] Cache Processors ++++++++++++++++ There are a set of nice processors with the ability to perform cache lookups and selectively replace payload content at the * body * token * xpath level [[Cache-CacheUsageSamples]] Cache Usage Samples ^^^^^^^^^^^^^^^^^^^ [[Cache-Example1:Configuringthecache]] Example 1: Configuring the cache ++++++++++++++++++++++++++++++++ [source,java] ------------------------------------------------- from("cache://MyApplicationCache" + "?maxElementsInMemory=1000" + "&memoryStoreEvictionPolicy=" + "MemoryStoreEvictionPolicy.LFU" + "&overflowToDisk=true" + "&eternal=true" + "&timeToLiveSeconds=300" + "&timeToIdleSeconds=true" + "&diskPersistent=true" + "&diskExpiryThreadIntervalSeconds=300") ------------------------------------------------- [[Cache-Example2:Addingkeystothecache]] Example 2: Adding keys to the cache +++++++++++++++++++++++++++++++++++ [source,java] --------------------------------------------------------------------------------------------- RouteBuilder builder = new RouteBuilder() { public void configure() { from("direct:start") .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_OPERATION_ADD)) .setHeader(CacheConstants.CACHE_KEY, constant("Ralph_Waldo_Emerson")) .to("cache://TestCache1") } }; --------------------------------------------------------------------------------------------- [[Cache-Example2:Updatingexistingkeysinacache]] Example 2: Updating existing keys in a cache ++++++++++++++++++++++++++++++++++++++++++++ [source,java] ------------------------------------------------------------------------------------------------ RouteBuilder builder = new RouteBuilder() { public void configure() { from("direct:start") .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_OPERATION_UPDATE)) .setHeader(CacheConstants.CACHE_KEY, constant("Ralph_Waldo_Emerson")) .to("cache://TestCache1") } }; ------------------------------------------------------------------------------------------------ [[Cache-Example3:Deletingexistingkeysinacache]] Example 3: Deleting existing keys in a cache ++++++++++++++++++++++++++++++++++++++++++++ [source,java] -------------------------------------------------------------------------------------- RouteBuilder builder = new RouteBuilder() { public void configure() { from("direct:start") .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_DELETE)) .setHeader(CacheConstants.CACHE_KEY", constant("Ralph_Waldo_Emerson")) .to("cache://TestCache1") } }; -------------------------------------------------------------------------------------- [[Cache-Example4:Deletingallexistingkeysinacache]] Example 4: Deleting all existing keys in a cache ++++++++++++++++++++++++++++++++++++++++++++++++ [source,java] ----------------------------------------------------------------------------------------- RouteBuilder builder = new RouteBuilder() { public void configure() { from("direct:start") .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_DELETEALL)) .to("cache://TestCache1"); } }; ----------------------------------------------------------------------------------------- [[Cache-Example5:NotifyinganychangesregisteringinaCachetoProcessorsandotherProducers]] Example 5: Notifying any changes registering in a Cache to Processors and other Producers +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ [source,java] -------------------------------------------------------------------------------------------------- RouteBuilder builder = new RouteBuilder() { public void configure() { from("cache://TestCache1") .process(new Processor() { public void process(Exchange exchange) throws Exception { String operation = (String) exchange.getIn().getHeader(CacheConstants.CACHE_OPERATION); String key = (String) exchange.getIn().getHeader(CacheConstants.CACHE_KEY); Object body = exchange.getIn().getBody(); // Do something } }) } }; -------------------------------------------------------------------------------------------------- [[Cache-Example6:UsingProcessorstoselectivelyreplacepayloadwithcachevalues]] Example 6: Using Processors to selectively replace payload with cache values ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ [source,java] --------------------------------------------------------------------------------------- RouteBuilder builder = new RouteBuilder() { public void configure() { //Message Body Replacer from("cache://TestCache1") .filter(header(CacheConstants.CACHE_KEY).isEqualTo("greeting")) .process(new CacheBasedMessageBodyReplacer("cache://TestCache1","farewell")) .to("direct:next"); //Message Token replacer from("cache://TestCache1") .filter(header(CacheConstants.CACHE_KEY).isEqualTo("quote")) .process(new CacheBasedTokenReplacer("cache://TestCache1","novel","#novel#")) .process(new CacheBasedTokenReplacer("cache://TestCache1","author","#author#")) .process(new CacheBasedTokenReplacer("cache://TestCache1","number","#number#")) .to("direct:next"); //Message XPath replacer from("cache://TestCache1"). .filter(header(CacheConstants.CACHE_KEY).isEqualTo("XML_FRAGMENT")) .process(new CacheBasedXPathReplacer("cache://TestCache1","book1","/books/book1")) .process (new CacheBasedXPathReplacer("cache://TestCache1","book2","/books/book2")) .to("direct:next"); } }; --------------------------------------------------------------------------------------- [[Cache-Example7:GettinganentryfromtheCache]] Example 7: Getting an entry from the Cache ++++++++++++++++++++++++++++++++++++++++++ [source,java] ------------------------------------------------------------------------------------------------ from("direct:start") // Prepare headers .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_OPERATION_GET)) .setHeader(CacheConstants.CACHE_KEY, constant("Ralph_Waldo_Emerson")). .to("cache://TestCache1"). // Check if entry was not found .choice().when(header(CacheConstants.CACHE_ELEMENT_WAS_FOUND).isNull()). // If not found, get the payload and put it to cache .to("cxf:bean:someHeavyweightOperation"). .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_OPERATION_ADD)) .setHeader(CacheConstants.CACHE_KEY, constant("Ralph_Waldo_Emerson")) .to("cache://TestCache1") .end() .to("direct:nextPhase"); ------------------------------------------------------------------------------------------------ [[Cache-Example8:CheckingforanentryintheCache]] Example 8: Checking for an entry in the Cache +++++++++++++++++++++++++++++++++++++++++++++ Note: The CHECK command tests existence of an entry in the cache but doesn't place a message in the body. [source,java] ------------------------------------------------------------------------------------------------ from("direct:start") // Prepare headers .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_OPERATION_CHECK)) .setHeader(CacheConstants.CACHE_KEY, constant("Ralph_Waldo_Emerson")). .to("cache://TestCache1"). // Check if entry was not found .choice().when(header(CacheConstants.CACHE_ELEMENT_WAS_FOUND).isNull()). // If not found, get the payload and put it to cache .to("cxf:bean:someHeavyweightOperation"). .setHeader(CacheConstants.CACHE_OPERATION, constant(CacheConstants.CACHE_OPERATION_ADD)) .setHeader(CacheConstants.CACHE_KEY, constant("Ralph_Waldo_Emerson")) .to("cache://TestCache1") .end(); ------------------------------------------------------------------------------------------------ [[Cache-ManagementofEHCache]] Management of EHCache ^^^^^^^^^^^^^^^^^^^^^ http://ehcache.org/[EHCache] has its own statistics and management from link:camel-jmx.html[JMX]. Here's a snippet on how to expose them via JMX in a Spring application context: [source,xml] ----------------------------------------------------------------------------------------------------------------------------- ----------------------------------------------------------------------------------------------------------------------------- Of course you can do the same thing in straight Java: [source,java] -------------------------------------------------------------------------------------------------- ManagementService.registerMBeans(CacheManager.getInstance(), mbeanServer, true, true, true, true); -------------------------------------------------------------------------------------------------- You can get cache hits, misses, in-memory hits, disk hits, size stats this way. You can also change CacheConfiguration parameters on the fly. [[Cache-CachereplicationCamel2.8]] Cache replication Camel 2.8 ^^^^^^^^^^^^^^^^^^^^^^^^^^^ The Camel Cache component is able to distribute a cache across server nodes using several different replication mechanisms including: RMI, JGroups, JMS and Cache Server. There are two different ways to make it work: *1.* You can configure `ehcache.xml` manually OR *2.* You can configure these three options: * cacheManagerFactory * eventListenerRegistry * cacheLoaderRegistry Configuring Camel Cache replication using the first option is a bit of hard work as you have to configure all caches separately. So in a situation when the all names of caches are not known, using `ehcache.xml` is not a good idea. The second option is much better when you want to use many different caches as you do not need to define options per cache. This is because replication options are set per `CacheManager` and per `CacheEndpoint`. Also it is the only way when cache names are not know at the development phase. [Note] ==== It might be useful to read the http://ehcache.org/documentation[EHCache manual] to get a better understanding of the Camel Cache replication mechanism. ==== [[Cache-Example:JMScachereplication]] Example: JMS cache replication ++++++++++++++++++++++++++++++ JMS replication is the most powerful and secured replication method. Used together with Camel Cache replication makes it also rather simple. An example is available on link:cachereplicationjmsexample.html[a separate page].