OpenDS - Soft Reference Entry Cache

Soft Reference Entry Cache

The Soft Reference Entry Cache is a Directory Server entry cache implementation that uses soft references to manage objects to allow them to be freed if the JVM is running low on memory.

Parent Component

The Soft Reference Entry Cache component inherits from the Entry Cache

This page describes the Soft Reference Entry Cache:

Properties
LDAP Mapping

Properties

A description of each property follows.

Basic Properties:	Advanced Properties:
↓ cache-level	↓ java-class
↓ enabled	↓ lock-timeout
↓ exclude-filter
↓ include-filter

Basic Properties

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

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

Advanced Properties

java-class

Description	Specifies the fully-qualified name of the Java class that provides the Soft Reference Entry Cache implementation.
Default Value	org.opends.server.extensions.SoftReferenceEntryCache
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 Soft Reference Entry Cache must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

lock-timeout

Description	Specifies the length of time in milliseconds to wait while attempting to acquire a read or write lock.
Default Value	3000ms
Allowed Values	A duration Syntax. A value of "-1" or "unlimited" for no limit. Lower limit is 0 milliseconds.
Multi-valued	No
Required	No
Admin Action Required	None
Advanced Property	Yes
Read-only	No

LDAP Mapping

Each configuration property can be mapped to a specific LDAP attribute under the "cn=config" entry. The mappings that follow are provided for information only. In general, you should avoid changing the server configuration by manipulating the LDAP attributes directly.

Base DN	cn=Entry Caches,cn=config
objectclass name	ds-cfg-soft-reference-entry-cache
objectclass superior	ds-cfg-entry-cache

Property	LDAP attribute
cache-level	ds-cfg-cache-level
enabled	ds-cfg-enabled
exclude-filter	ds-cfg-exclude-filter
include-filter	ds-cfg-include-filter
java-class	ds-cfg-java-class
lock-timeout	ds-cfg-lock-timeout