FIFO Entry Cache

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

The FIFO Entry Cache provides a simple entry cache implementation that uses a first-in/first-out approach to holding entries so that the entries which have been in the cache the longest will be the first entries to be purged if the need arises.

Note that in most deployments, no entry cache is needed as excellent performance can be achieved without the entry cache and using only the database caching mechanism. It is generally recommended that the entry cache remain disabled in most cases, since that makes configuration and sizing simpler. The entry cache should generally only be used for special types of entries (e.g., static groups with a large number of members) in which it the process of decoding the associated entry from the database is excessively expensive and causes a notable performance degradation. In such cases, then the include-filter and/or exclude-filter properties should be used to ensure that only the most problematic entries are held in the entry cache.

Cache sizing is based on the percentage of free memory within the JVM, such that if enough memory is free, then adding an entry to the cache will not require purging, but if more than a specified percentage of the available memory within the JVM is already consumed, then one or more entries will need to be removed in order to make room for a new entry.

It is also possible to configure a maximum number of entries for the cache. If this is specified, then the number of entries will not be allowed to exceed this value, but it may not be possible to hold this many entries if the available memory fills up first.

Other configurable parameters for this cache include the maximum length of time to block while waiting to acquire a lock, and a set of filters that may be used to define criteria for determining which entries are stored in the cache. If a filter list is provided, then only entries matching at least one of the given filters will be stored in the cache.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The FIFO Entry Cache component inherits from the Entry Cache

Properties

The properties supported by this managed object are as follows:

Basic Properties

description

enabled

cache-level

max-memory-percent

max-entries

include-filter

exclude-filter

min-cache-entry-value-count

min-cache-entry-attribute

Advanced Properties

cache-unindexed-search-results (Advanced Property)

lock-timeout (Advanced Property)

dsconfig Usage

To list the configured Entry Caches:

dsconfig list-entry-caches
     [--property {propertyName}] ...

To view the configuration for an existing Entry Cache:

dsconfig get-entry-cache-prop
     --cache-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Entry Cache:

dsconfig set-entry-cache-prop
     --cache-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new FIFO Entry Cache:

dsconfig create-entry-cache
     --cache-name {name}
     --type fifo
     --set enabled:{propertyValue}
     --set cache-level:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Entry Cache:

dsconfig delete-entry-cache
     --cache-name {name}