The File System Entry Cache is an entry cache implementation which uses a JE database to keep track of the entries.
For best performance, the JE database should reside in a memory based file system although any file system will do for this cache to function. Entries are maintained either by FIFO (default) or LRU-based (configurable) list implementation. Cache sizing is based on the size of free space available in the file system, such that if enough memory is free, then adding an entry to the cache will not require purging. If more than the specified size of the file system available space is already consumed, then one or more entries 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 are not 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 set of filters are provided then an entry must match at least one of them in order to be stored in the cache. JE environment cache size can also be configured either as a percentage of the free memory available in the JVM, or as an absolute size in bytes. This cache has a persistence property which, if enabled, allows for the contents of the cache to persist across server or cache restarts.
Parent Component
The File System Entry Cache component inherits from the Entry Cache
Specifies the directory in which the JE environment should store the cache.
Default Value
/tmp/OpenDJ.FSCache
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
The File System Entry Cache must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
cache-level
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 value is 1.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
cache-type
Description
Specifies the policy which should be used for purging entries from the cache.
Default Value
fifo
Allowed Values
fifo - FIFO based entry cache.
lru - LRU based entry cache.
Multi-valued
No
Required
No
Admin Action Required
The File System Entry Cache must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No
compact-encoding
Description
Indicates whether the cache should use a compact form when encoding cache entries by compressing the attribute descriptions and object class sets. Note that compression does not preserve user-supplied capitalization in the object class and attribute type names.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None. Changing this property only affects the encoding of the cache entries put in the cache after the change is made. It will not be retroactively applied to existing cache entries.
Advanced Property
No
Read-only
No
db-cache-percent
Description
Specifies the maximum memory usage for the internal JE cache as a percentage of the total JVM memory.
Default Value
1
Allowed Values
An integer value. Lower value is 0. Upper value is 90 .
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
db-cache-size
Description
Specifies the maximum JVM memory usage in bytes for the internal JE cache.
Default Value
0b
Allowed Values
A positive integer representing a size.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
enabled
Description
Indicates whether the Entry Cache is enabled.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No
exclude-filter
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
Advanced Property
No
Read-only
No
include-filter
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
Advanced Property
No
Read-only
No
max-entries
Description
The maximum number of entries allowed in the cache.
Default Value
2147483647
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
max-memory-size
Description
The maximum size of the entry cache in bytes.
Default Value
0b
Allowed Values
A positive integer representing a size.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
persistent-cache
Description
Specifies whether the cache should persist across restarts.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No
Advanced Properties
java-class
Description
Specifies the fully-qualified name of the Java class that provides the File System Entry Cache implementation.
Default Value
org.opends.server.extensions.FileSystemEntryCache
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.EntryCache
Multi-valued
No
Required
Yes
Admin Action Required
The File System Entry Cache must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No
je-property
Description
Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache. Any Berkeley DB Java Edition property can be specified using the following form: property-name=property-value. Refer to the OpenDJ documentation for further information on related properties, their implications and range values. The definitive identification of all the property parameters available in the example.properties file in the Berkeley DB Java Edition distribution.
Default Value
je.env.isLocking=false
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No
lock-timeout
Description
The length of time to wait while attempting to acquire a read or write lock.
Default Value
2000.0ms
Allowed Values
A duration Syntax. A value of "-1" or "unlimited" for no limit. Lower limit is 0 milliseconds.