Package org.forgerock.opendj.server.config.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 Details

    • configurationClass

      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

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

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

      Default value is undefined

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

    • getIncludeFilter

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

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

      Default value is undefined

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

    • getJavaClass

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

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

      Default value: org.opends.server.extensions.FIFOEntryCache

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

    • getLockTimeout

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

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

      Default value: 2000.0ms

      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.

      Default value: 2147483647

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

    • getMaxMemoryPercent

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

      Specifies the maximum percentage of JVM memory used by the server before the entry caches stops caching and begins purging itself.

      Very low settings such as 10 or 20 (percent) can prevent this entry cache from having enough space to hold any of the entries to cache, making it appear that the server is ignoring or skipping the entry cache entirely.

      Default value: 90

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