| {"component":{"kind":"component","name":"jcache","title":"JCache","description":"Perform caching operations against JSR107/JCache.","deprecated":false,"firstVersion":"2.17.0","label":"cache,datagrid,clustering","javaType":"org.apache.camel.component.jcache.JCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-jcache","version":"3.18.1","scheme":"jcache","extendsScheme":"","syntax":"jcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CamelJCacheAction":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The cache operation to perform","constantName":"org.apache.camel.component.jcache.JCacheConstants#ACTION"},"CamelJCacheResult":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The result of the cache operation","constantName":"org.apache.camel.component.jcache.JCacheConstants#RESULT"},"CamelJCacheEventType":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of event received","constantName":"org.apache.camel.component.jcache.JCacheConstants#EVENT_TYPE"},"CamelJCacheKey":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key of the cache entry","constantName":"org.apache.camel.component.jcache.JCacheConstants#KEY"},"CamelJCacheKeys":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Set<Object>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The collection of keys against which the action should be performed","constantName":"org.apache.camel.component.jcache.JCacheConstants#KEYS"},"CamelJCacheOldValue":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value of the cache entry","constantName":"org.apache.camel.component.jcache.JCacheConstants#OLD_VALUE"},"CamelJCacheEntryProcessor":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"EntryProcessor<Object, Object, Object>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The EntryProcessor to invoke","constantName":"org.apache.camel.component.jcache.JCacheConstants#ENTRY_PROCESSOR"},"CamelJCacheEntryArgs":{"kind":"header","displayName":"","group":"producer","label":"producer","required":false,"javaType":"Collection<Object>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The additional arguments to pass to the EntryProcessor","constantName":"org.apache.camel.component.jcache.JCacheConstants#ARGUMENTS"}},"properties":{"cacheName":{"kind":"path","displayName":"Cache Name","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the cache"},"cacheConfiguration":{"kind":"parameter","displayName":"Cache Configuration","group":"common","label":"","required":false,"type":"object","javaType":"javax.cache.configuration.Configuration","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"A Configuration for the Cache"},"cacheConfigurationProperties":{"kind":"parameter","displayName":"Cache Configuration Properties","group":"common","label":"","required":false,"type":"object","javaType":"java.util.Properties","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The Properties for the javax.cache.spi.CachingProvider to create the CacheManager"},"cachingProvider":{"kind":"parameter","displayName":"Caching Provider","group":"common","label":"common","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The fully qualified class name of the javax.cache.spi.CachingProvider"},"configurationUri":{"kind":"parameter","displayName":"Configuration Uri","group":"common","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"An implementation specific URI for the CacheManager"},"managementEnabled":{"kind":"parameter","displayName":"Management Enabled","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Whether management gathering is enabled"},"readThrough":{"kind":"parameter","displayName":"Read Through","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If read-through caching should be used"},"statisticsEnabled":{"kind":"parameter","displayName":"Statistics Enabled","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Whether statistics gathering is enabled"},"storeByValue":{"kind":"parameter","displayName":"Store By Value","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If cache should use store-by-value or store-by-reference semantics"},"writeThrough":{"kind":"parameter","displayName":"Write Through","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"If write-through caching should be used"},"filteredEvents":{"kind":"parameter","displayName":"Filtered Events","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["CREATED","UPDATED","REMOVED","EXPIRED"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Events a consumer should filter (multiple events can be separated by comma). If using filteredEvents option, then eventFilters one will be ignored"},"oldValueRequired":{"kind":"parameter","displayName":"Old Value Required","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"if the old value is required for events"},"synchronous":{"kind":"parameter","displayName":"Synchronous","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"if the event listener should block the thread causing the event"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":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 or ERROR level and ignored."},"eventFilters":{"kind":"parameter","displayName":"Event Filters","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"array","javaType":"java.util.List<javax.cache.event.CacheEntryEventFilter>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheEntryEventFilter. If using eventFilters option, then filteredEvents one will be ignored"},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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."},"exchangePattern":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"action":{"kind":"parameter","displayName":"Action","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"To configure using a cache operation by default. If an operation in the message header, then the operation from the header takes precedence."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"cacheLoaderFactory":{"kind":"parameter","displayName":"Cache Loader Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory<javax.cache.integration.CacheLoader>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheLoader factory"},"cacheWriterFactory":{"kind":"parameter","displayName":"Cache Writer Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory<javax.cache.integration.CacheWriter>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The CacheWriter factory"},"createCacheIfNotExists":{"kind":"parameter","displayName":"Create Cache If Not Exists","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Configure if a cache need to be created if it does exist or can't be pre-configured."},"expiryPolicyFactory":{"kind":"parameter","displayName":"Expiry Policy Factory","group":"advanced","label":"advanced","required":false,"type":"object","javaType":"javax.cache.configuration.Factory<javax.cache.expiry.ExpiryPolicy>","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"The ExpiryPolicy factory"},"lookupProviders":{"kind":"parameter","displayName":"Lookup Providers","group":"advanced","label":"advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.jcache.JCacheConfiguration","configurationField":"configuration","description":"Configure if a camel-cache should try to find implementations of jcache api in runtimes like OSGi."}}} |