Caffeine Cache

Discover more about the Caffeine Cache connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

Caffeine Cache performs caching operations using Caffeine Cache.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter	Description	Default value	Data type
Cache Name (DB)	The name of the cache.	N/A	String
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.	False	Boolean

Optional tab

Parameter	Description	Default value	Data type
Action	Configures the default cache action. If an action is set in the message header, the operation from the header takes precedence.	N/A	String
Create Cache If Not Exist	Automatically creates the Caffeine cache if none has been configured or exists in the registry.	True	Boolean
Eviction Type	Sets the eviction type for this cache.	SIZE_BASED	String
Expire After Access Time	Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation, the most recent replacement of its value, or its last read. Access time is reset by all cache read and write operations. The unit is in seconds.	300	Integer
Expire After Write Time	Specifies that each entry should be automatically removed from the cache once a fixed duration has elapsed after the entry’s creation or the most recent replacement of its value. The unit is in seconds.	300	Integer
Initial Capacity	Sets the minimum total size for the internal data structures. Providing a large enough estimate at construction time avoids expensive resizing operations later, but setting this value unnecessarily high wastes memory.	N/A	Integer
Key (DB)	Configures the default action key. If a key is set in the message header, the key from the header takes precedence.	N/A	String
Maximum Size	Specifies the maximum number of entries the cache may contain. The cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries less likely to be used again. When size is zero, elements are evicted immediately after being loaded into the cache. This can be useful for testing or temporarily disabling caching without code changes.	N/A	Integer
Stats Enabled	Enables statistics on the cache.	False	Boolean
Value Type (DB)	The cache value type. Default is java.lang.Object.	N/A	String
Body (DB)	The body, if applicable.	{}	JSON

Headers tab

Parameter	Description	Default Value	Data Type
Action (DB)	The action to execute. Possible values: CLEANUP, PUT, PUT_ALL, GET, GET_ALL, INVALIDATE, INVALIDATE_ALL, AS_MAP.	N/A	String
Action Has Result	Flag indicating whether the action has a result.	False	Boolean
Action Succeeded	Flag indicating whether the action was successful.	False	Boolean
Key (DB)	The key for all actions on a single entry.	N/A	String
Keys (DB)	The keys to get (GET_ALL), invalidate (INVALIDATE_ALL), or list (AS_MAP), according to the action.	N/A	JSON
Value (DB)	The value of the key for all put actions (PUT or PUT_ALL).	N/A	String
Old Value (DB)	The old value returned according to the action.	N/A	String

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String