org.opends.server.admin.std.server
Interface SoftReferenceEntryCacheCfg

All Superinterfaces:
Configuration, EntryCacheCfg

public interface SoftReferenceEntryCacheCfg
extends EntryCacheCfg

A server-side interface for querying Soft Reference Entry Cache settings.

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.


Method Summary
 void addSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener)
          Register to be notified when this Soft Reference Entry Cache is changed.
 java.lang.Class<? extends SoftReferenceEntryCacheCfg> configurationClass()
          Gets the configuration class associated with this Soft Reference Entry Cache.
 java.util.SortedSet<java.lang.String> getExcludeFilter()
          Gets the "exclude-filter" property.
 java.util.SortedSet<java.lang.String> getIncludeFilter()
          Gets the "include-filter" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 long getLockTimeout()
          Gets the "lock-timeout" property.
 void removeSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener)
          Deregister an existing Soft Reference Entry Cache configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.EntryCacheCfg
addChangeListener, getCacheLevel, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

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

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

addSoftReferenceChangeListener

void addSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener)
Register to be notified when this Soft Reference Entry Cache is changed.

Parameters:
listener - The Soft Reference Entry Cache configuration change listener.

removeSoftReferenceChangeListener

void removeSoftReferenceChangeListener(ConfigurationChangeListener<SoftReferenceEntryCacheCfg> listener)
Deregister an existing Soft Reference Entry Cache configuration change listener.

Parameters:
listener - The Soft Reference Entry Cache configuration change listener.

getExcludeFilter

java.util.SortedSet<java.lang.String> getExcludeFilter()
Gets the "exclude-filter" property.

The set of filters that define the entries that should be excluded from the cache.

Returns:
Returns an unmodifiable set containing the values of the "exclude-filter" property.

getIncludeFilter

java.util.SortedSet<java.lang.String> getIncludeFilter()
Gets the "include-filter" property.

The set of filters that define the entries that should be included in the cache.

Returns:
Returns an unmodifiable set containing the values of the "include-filter" property.

getJavaClass

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

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

Specified by:
getJavaClass in interface EntryCacheCfg
Returns:
Returns the value of the "java-class" property.

getLockTimeout

long getLockTimeout()
Gets the "lock-timeout" property.

Specifies the length of time in milliseconds to wait while attempting to acquire a read or write lock.

Returns:
Returns the value of the "lock-timeout" property.