org.opends.server.admin.std.client
Interface FileSystemEntryCacheCfgClient

All Superinterfaces:
ConfigurationClient, EntryCacheCfgClient

public interface FileSystemEntryCacheCfgClient
extends EntryCacheCfgClient

A client-side interface for reading and modifying 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
 ManagedObjectDefinition<? extends FileSystemEntryCacheCfgClient,? extends FileSystemEntryCacheCfg> definition()
          Get the configuration definition 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 setCacheDirectory(java.lang.String value)
          Sets the "cache-directory" property.
 void setCacheType(FileSystemEntryCacheCfgDefn.CacheType value)
          Sets the "cache-type" property.
 void setCompactEncoding(java.lang.Boolean value)
          Sets the "compact-encoding" property.
 void setDBCachePercent(java.lang.Integer value)
          Sets the "db-cache-percent" property.
 void setDBCacheSize(java.lang.Long value)
          Sets the "db-cache-size" property.
 void setExcludeFilter(java.util.Collection<java.lang.String> values)
          Sets the "exclude-filter" property.
 void setIncludeFilter(java.util.Collection<java.lang.String> values)
          Sets the "include-filter" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setJEProperty(java.util.Collection<java.lang.String> values)
          Sets the "je-property" property.
 void setLockTimeout(java.lang.Long value)
          Sets the "lock-timeout" property.
 void setMaxEntries(java.lang.Integer value)
          Sets the "max-entries" property.
 void setMaxMemorySize(java.lang.Long value)
          Sets the "max-memory-size" property.
 void setPersistentCache(java.lang.Boolean value)
          Sets the "persistent-cache" property.
 
Methods inherited from interface org.opends.server.admin.std.client.EntryCacheCfgClient
getCacheLevel, isEnabled, setCacheLevel, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends FileSystemEntryCacheCfgClient,? extends FileSystemEntryCacheCfg> definition()
Get the configuration definition associated with this File System Entry Cache.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface EntryCacheCfgClient
Returns:
Returns the configuration definition associated with this File System Entry Cache.

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.

setCacheDirectory

void setCacheDirectory(java.lang.String value)
                       throws IllegalPropertyValueException
Sets the "cache-directory" property.

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

Parameters:
value - The value of the "cache-directory" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setCacheType

void setCacheType(FileSystemEntryCacheCfgDefn.CacheType value)
                  throws IllegalPropertyValueException
Sets the "cache-type" property.

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

Parameters:
value - The value of the "cache-type" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setCompactEncoding

void setCompactEncoding(java.lang.Boolean value)
                        throws IllegalPropertyValueException
Sets 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.

Parameters:
value - The value of the "compact-encoding" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setDBCachePercent

void setDBCachePercent(java.lang.Integer value)
                       throws IllegalPropertyValueException
Sets the "db-cache-percent" property.

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

Parameters:
value - The value of the "db-cache-percent" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setDBCacheSize

void setDBCacheSize(java.lang.Long value)
                    throws IllegalPropertyValueException
Sets the "db-cache-size" property.

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

Parameters:
value - The value of the "db-cache-size" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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 the values of the "exclude-filter" property.

setExcludeFilter

void setExcludeFilter(java.util.Collection<java.lang.String> values)
                      throws IllegalPropertyValueException
Sets the "exclude-filter" property.

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

Parameters:
values - The values of the "exclude-filter" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

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 the values of the "include-filter" property.

setIncludeFilter

void setIncludeFilter(java.util.Collection<java.lang.String> values)
                      throws IllegalPropertyValueException
Sets the "include-filter" property.

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

Parameters:
values - The values of the "include-filter" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

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 EntryCacheCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Specified by:
setJavaClass in interface EntryCacheCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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 the values of the "je-property" property.

setJEProperty

void setJEProperty(java.util.Collection<java.lang.String> values)
                   throws IllegalPropertyValueException
Sets 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.

Parameters:
values - The values of the "je-property" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

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.

setLockTimeout

void setLockTimeout(java.lang.Long value)
                    throws IllegalPropertyValueException
Sets the "lock-timeout" property.

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

Parameters:
value - The value of the "lock-timeout" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setMaxEntries

void setMaxEntries(java.lang.Integer value)
                   throws IllegalPropertyValueException
Sets the "max-entries" property.

The maximum number of entries allowed in the cache.

Parameters:
value - The value of the "max-entries" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setMaxMemorySize

void setMaxMemorySize(java.lang.Long value)
                      throws IllegalPropertyValueException
Sets the "max-memory-size" property.

The maximum size of the entry cache in bytes.

Parameters:
value - The value of the "max-memory-size" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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.

setPersistentCache

void setPersistentCache(java.lang.Boolean value)
                        throws IllegalPropertyValueException
Sets the "persistent-cache" property.

Specifies whether the cache should persist across restarts.

Parameters:
value - The value of the "persistent-cache" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.