org.opends.server.admin.std.server
Interface FileSystemEntryCacheCfg

All Superinterfaces:
Configuration, EntryCacheCfg

public interface FileSystemEntryCacheCfg
extends EntryCacheCfg

A server-side interface for querying File System Entry Cache settings.

The File System Entry Cache is an entry cache implementation which uses a JE database to keep track of the entries.


Method Summary
 void addFileSystemChangeListener(ConfigurationChangeListener<FileSystemEntryCacheCfg> listener)
          Register to be notified when this File System Entry Cache is changed.
 java.lang.Class<? extends FileSystemEntryCacheCfg> configurationClass()
          Gets the configuration class associated with this File System Entry Cache.
 java.lang.String getCacheDirectory()
          Gets the "cache-directory" property.
 FileSystemEntryCacheCfgDefn.CacheType getCacheType()
          Gets the "cache-type" property.
 int getDBCachePercent()
          Gets the "db-cache-percent" property.
 long getDBCacheSize()
          Gets the "db-cache-size" property.
 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.
 java.util.SortedSet<java.lang.String> getJEProperty()
          Gets the "je-property" property.
 long getLockTimeout()
          Gets the "lock-timeout" property.
 int getMaxEntries()
          Gets the "max-entries" property.
 long getMaxMemorySize()
          Gets the "max-memory-size" property.
 boolean isCompactEncoding()
          Gets the "compact-encoding" property.
 boolean isPersistentCache()
          Gets the "persistent-cache" property.
 void removeFileSystemChangeListener(ConfigurationChangeListener<FileSystemEntryCacheCfg> listener)
          Deregister an existing File System 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 FileSystemEntryCacheCfg> configurationClass()
Gets the configuration class associated with this File System Entry Cache.

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

addFileSystemChangeListener

void addFileSystemChangeListener(ConfigurationChangeListener<FileSystemEntryCacheCfg> listener)
Register to be notified when this File System Entry Cache is changed.

Parameters:
listener - The File System Entry Cache configuration change listener.

removeFileSystemChangeListener

void removeFileSystemChangeListener(ConfigurationChangeListener<FileSystemEntryCacheCfg> listener)
Deregister an existing File System Entry Cache configuration change listener.

Parameters:
listener - The File System Entry Cache configuration change listener.

getCacheDirectory

java.lang.String getCacheDirectory()
Gets the "cache-directory" property.

Specifies the directory in which the JE environment should store the cache.

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

getCacheType

FileSystemEntryCacheCfgDefn.CacheType getCacheType()
Gets the "cache-type" property.

Specifies the policy which should be used for purging entries from the cache.

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

isCompactEncoding

boolean isCompactEncoding()
Gets the "compact-encoding" property.

Indicates whether the cache should use a compact form when encoding cache entries by compressing the attribute descriptions and object class sets.

Note that compression does not preserve user-supplied capitalization in the object class and attribute type names.

Returns:
Returns the value of the "compact-encoding" property.

getDBCachePercent

int getDBCachePercent()
Gets the "db-cache-percent" property.

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

Returns:
Returns the value of the "db-cache-percent" property.

getDBCacheSize

long getDBCacheSize()
Gets the "db-cache-size" property.

Specifies the maximum JVM memory usage in bytes for the internal JE cache.

Returns:
Returns the value of the "db-cache-size" property.

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 File System Entry Cache implementation.

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

getJEProperty

java.util.SortedSet<java.lang.String> getJEProperty()
Gets the "je-property" property.

Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache.

Any Berkeley DB Java Edition property can be specified using the following form: property-name=property-value. Refer to the OpenDS documentation for further information on related properties, their implications and range values. The definitive identification of all the property parameters available in the example.properties file in the Berkeley DB Java Edition distribution.

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

getLockTimeout

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

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.

The maximum number of entries allowed in the cache.

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

getMaxMemorySize

long getMaxMemorySize()
Gets the "max-memory-size" property.

The maximum size of the entry cache in bytes.

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

isPersistentCache

boolean isPersistentCache()
Gets the "persistent-cache" property.

Specifies whether the cache should persist across restarts.

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