org.opends.server.admin.std.server
Interface FIFOEntryCacheCfg

All Superinterfaces:
Configuration, EntryCacheCfg

public interface FIFOEntryCacheCfg
extends EntryCacheCfg

A server-side interface for querying FIFO Entry Cache settings.

FIFO Entry Caches use a FIFO queue to keep track of the cached entries.


Method Summary
 void addFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener)
          Register to be notified when this FIFO Entry Cache is changed.
 java.lang.Class<? extends FIFOEntryCacheCfg> configurationClass()
          Gets the configuration class associated with this FIFO 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.
 int getMaxEntries()
          Gets the "max-entries" property.
 int getMaxMemoryPercent()
          Gets the "max-memory-percent" property.
 void removeFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener)
          Deregister an existing FIFO 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 FIFOEntryCacheCfg> configurationClass()
Gets the configuration class associated with this FIFO Entry Cache.

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

addFIFOChangeListener

void addFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener)
Register to be notified when this FIFO Entry Cache is changed.

Parameters:
listener - The FIFO Entry Cache configuration change listener.

removeFIFOChangeListener

void removeFIFOChangeListener(ConfigurationChangeListener<FIFOEntryCacheCfg> listener)
Deregister an existing FIFO Entry Cache configuration change listener.

Parameters:
listener - The FIFO 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 FIFO 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 to wait while attempting to acquire a read or write lock.

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

getMaxEntries

int getMaxEntries()
Gets the "max-entries" property.

Specifies the maximum number of entries that we will allow in the cache.

Returns:
Returns the value of the "max-entries" property.

getMaxMemoryPercent

int getMaxMemoryPercent()
Gets the "max-memory-percent" property.

Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory.

Returns:
Returns the value of the "max-memory-percent" property.