blob: c3ed10b8d23c177ee571e114da4405bf5c3731dd [file] [log] [blame]
{"component":{"kind":"component","name":"caffeine-loadcache","title":"Caffeine LoadCache","description":"Perform caching operations using Caffeine Cache with an attached CacheLoader.","deprecated":false,"firstVersion":"2.20.0","label":"cache,datagrid,clustering","javaType":"org.apache.camel.component.caffeine.load.CaffeineLoadCacheComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-caffeine","version":"3.18.1","scheme":"caffeine-loadcache","extendsScheme":"","syntax":"caffeine-loadcache:cacheName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelCaffeineAction":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The action to execute. Possible values: CLEANUP PUT PUT_ALL GET GET_ALL INVALIDATE INVALIDATE_ALL AS_MAP","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION"},"CamelCaffeineActionHasResult":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action has a result or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_HAS_RESULT"},"CamelCaffeineActionSucceeded":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The flag indicating whether the action was successful or not.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#ACTION_SUCCEEDED"},"CamelCaffeineKey":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key for all actions on a single entry.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEY"},"CamelCaffeineKeys":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Set","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The keys to get (GET_ALL), to invalidate (INVALIDATE_ALL) or existing (AS_MAP) according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#KEYS"},"CamelCaffeineValue":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The value of key for all put actions (PUT or PUT_ALL).","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#VALUE"},"CamelCaffeineOldValue":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The old value returned according to the action.","constantName":"org.apache.camel.component.caffeine.CaffeineConstants#OLD_VALUE"}},"properties":{"cacheName":{"kind":"path","displayName":"Cache Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"the cache name"},"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.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default cache action. If an action is set in the message header, then the operation from the header takes precedence."},"cacheLoader":{"kind":"parameter","displayName":"Cache Loader","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.CacheLoader","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure a CacheLoader in case of a LoadCache use"},"createCacheIfNotExist":{"kind":"parameter","displayName":"Create Cache If Not Exist","group":"producer","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Configure if a cache need to be created if it does exist or can't be pre-configured."},"evictionType":{"kind":"parameter","displayName":"Eviction Type","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.caffeine.EvictionType","enum":["size_based","time_based"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"SIZE_BASED","configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the eviction Type for this cache"},"expireAfterAccessTime":{"kind":"parameter","displayName":"Expire After Access Time","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the expire After Access Time in case of time based Eviction (in seconds)"},"expireAfterWriteTime":{"kind":"parameter","displayName":"Expire After Write Time","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":300,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the expire After Access Write in case of time based Eviction (in seconds)"},"initialCapacity":{"kind":"parameter","displayName":"Initial Capacity","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the initial Capacity for the cache"},"key":{"kind":"parameter","displayName":"Key","group":"producer","label":"producer","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To configure the default action key. If a key is set in the message header, then the key from the header takes precedence."},"maximumSize":{"kind":"parameter","displayName":"Maximum Size","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":10000,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set the maximum size for the cache"},"removalListener":{"kind":"parameter","displayName":"Removal Listener","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.RemovalListener","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific removal Listener for the cache"},"statsCounter":{"kind":"parameter","displayName":"Stats Counter","group":"producer","label":"producer","required":false,"type":"object","javaType":"com.github.benmanes.caffeine.cache.stats.StatsCounter","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"Set a specific Stats Counter for the cache stats"},"statsEnabled":{"kind":"parameter","displayName":"Stats Enabled","group":"producer","label":"producer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"To enable stats on the cache"},"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."},"keyType":{"kind":"parameter","displayName":"Key Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"The cache key type, default java.lang.Object"},"valueType":{"kind":"parameter","displayName":"Value Type","group":"advanced","label":"advanced","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.caffeine.CaffeineConfiguration","configurationField":"configuration","description":"The cache value type, default java.lang.Object"}}}