UnboundID Identity Data Store

Identity Data Store Documentation Index
Configuration Reference Home

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.

Note: this is an abstract component that cannot be instantiated.

Entry Caches are responsible for caching entries which are likely to be accessed by client applications in order to improve Identity Data Store performance.

↓Direct Subcomponents
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Entry Caches are available in the server :

FIFO Entry Cache

These Entry Caches inherit from the properties described below.

Properties

The properties supported by this managed object are as follows:

Basic Properties:	Advanced Properties:
↓ description	↓ cache-unindexed-search-results
↓ enabled
↓ java-class
↓ cache-level

Basic Properties

description

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

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. Modification requires no further action

java-class (Read-Only)

Description	Specifies the fully-qualified name of the Java class that provides the Entry Cache implementation.
Default Value	None
Allowed Values	The fully-qualified name of a Java class that extends or implements com.unboundid.directory.server.api.EntryCache
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

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 limit is 1.
Multi-Valued	No
Required	Yes
Admin Action Required	None. Modification requires no further action

Advanced Properties

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

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 delete an existing Entry Cache:

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