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 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
The FIFO Entry Cache component inherits from the Entry Cache
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | ↓ cache-unindexed-search-results |
| ↓ enabled | |
| ↓ cache-level | |
| ↓ max-memory-percent | |
| ↓ max-entries | |
| ↓ only-cache-frequently-accessed | |
| ↓ include-filter | |
| ↓ exclude-filter | |
| ↓ min-cache-entry-value-count | |
| ↓ min-cache-entry-attribute |
| Description | A description for this Entry Cache |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether the Entry Cache is enabled. |
| Default Value | None |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the cache level in the cache order if more than one instance of the cache is configured. |
| Default Value | None |
| Allowed Values | An integer value. Lower limit is 1. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the maximum amount of memory, as a percentage of the total maximum JVM heap size, that this cache should occupy when full. If the amount of memory the cache is using is greater than this amount, then an attempt to put a new entry in the cache will be ignored and will cause the oldest entry to be purged. |
| Default Value | 5 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 90 . |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the maximum number of entries that will be allowed in the cache. Once the cache reaches this size, then adding new entries will cause existing entries to be purged, starting with the oldest. |
| Default Value | 10000 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
only-cache-frequently-accessed
| Description | Specifies that the cache should only store entries which are accessed much more frequently than the average entry. The cache will observe attempts to place entries in the cache and compare an entry's accesses to the average entry's. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of filters that define the entries that should be included in the cache. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The set of filters that define the entries that should be excluded from the cache. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the minimum number of attribute values (optionally across a specified subset of attributes as defined in the min-cache-entry-attributes property) for entries that should be held in the cache. Entries with fewer than this number of attribute values will be excluded from the cache. A value of zero indicates that there is no minimum value count for entries to cache. |
| Default Value | 0 |
| Allowed Values | An integer value. Lower limit is 0. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | The FIFO Entry Cache must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
| Description | Specifies the names of the attribute types for which the min-cache-entry-value-count property should apply. If no attribute types are specified, then all user attributes will be examined. |
| Default Value | None |
| Allowed Values | The name or OID of an attribute type defined in the server schema. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | The FIFO Entry Cache must be disabled and re-enabled for changes to this setting to take effect. In order for this modification to take effect, the component must be restarted, either by disabling and re-enabling it, or by restarting the server |
cache-unindexed-search-results (Advanced Property)
| Description | Indicates whether the entry cache should be updated with entries that have been returned to the client during the course of processing an unindexed search. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
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}