org.opends.server.admin.std.server
Interface EntryCacheCfg

All Superinterfaces:
Configuration
All Known Subinterfaces:
FIFOEntryCacheCfg, FileSystemEntryCacheCfg, SoftReferenceEntryCacheCfg

public interface EntryCacheCfg
extends Configuration

A server-side interface for querying Entry Cache settings.

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


Method Summary
 void addChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener)
          Register to be notified when this Entry Cache is changed.
 java.lang.Class<? extends EntryCacheCfg> configurationClass()
          Gets the configuration class associated with this Entry Cache.
 int getCacheLevel()
          Gets the "cache-level" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 boolean isEnabled()
          Gets the "enabled" property.
 void removeChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener)
          Deregister an existing Entry Cache configuration change listener.
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends EntryCacheCfg> configurationClass()
Gets the configuration class associated with this Entry Cache.

Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Entry Cache.

addChangeListener

void addChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener)
Register to be notified when this Entry Cache is changed.

Parameters:
listener - The Entry Cache configuration change listener.

removeChangeListener

void removeChangeListener(ConfigurationChangeListener<EntryCacheCfg> listener)
Deregister an existing Entry Cache configuration change listener.

Parameters:
listener - The Entry Cache configuration change listener.

getCacheLevel

int getCacheLevel()
Gets the "cache-level" property.

Specifies the cache level in the cache order if more than one instance of the cache is configured.

Returns:
Returns the value of the "cache-level" property.

isEnabled

boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Entry Cache is enabled.

Returns:
Returns the value of the "enabled" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Entry Cache implementation.

Returns:
Returns the value of the "java-class" property.