Caffeine LoadCache

Discover more about the Caffeine LoadCache 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 LoadCache performs caching operations using Caffeine Cache with an attached CacheLoader.

Parameters

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

General tab

ParameterDescriptionDefault valueData 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

ParameterDescriptionDefault ValueData Type

Action

Configure 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 create the Caffeine cache if none has been configured or exists in the registry.

True

Boolean

Eviction Type

Set 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 sufficiently large estimate at construction time avoids the need for expensive resizing operations later, but setting this value unnecessarily high wastes memory.

N/A

Integer

Key (DB)

Configure 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. Note that 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, it evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn’t been used recently or very often. When the size is zero, elements will be evicted immediately after being loaded into the cache. This can be useful in testing or to disable caching temporarily without a code change. As eviction is scheduled on the configured executor, tests may prefer to configure the cache to execute tasks directly on the same thread.

N/A

Integer

Stats Enabled

Enable stats 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

ParameterDescriptionDefault ValueData 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

A flag indicating whether the action has a result.

False

Boolean

Action Succeeded

A 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), to invalidate (INVALIDATE_ALL), or existing (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

ParameterDescriptionDefault valueData type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

Last updated