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

All Superinterfaces:
ConfigurationClient
All Known Subinterfaces:
FIFOEntryCacheCfgClient, FileSystemEntryCacheCfgClient, SoftReferenceEntryCacheCfgClient

public interface EntryCacheCfgClient
extends ConfigurationClient

A client-side interface for reading and modifying Entry Cache settings.

Entry Caches are responsible for caching entries which are likely to be accessed by client applications in order to improve Directory Server performance.


Method Summary
 ManagedObjectDefinition<? extends EntryCacheCfgClient,? extends EntryCacheCfg> definition()
          Get the configuration definition associated with this Entry Cache.
 java.lang.Integer getCacheLevel()
          Gets the "cache-level" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.lang.Boolean isEnabled()
          Gets the "enabled" property.
 void setCacheLevel(int value)
          Sets the "cache-level" property.
 void setEnabled(boolean value)
          Sets the "enabled" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends EntryCacheCfgClient,? extends EntryCacheCfg> definition()
Get the configuration definition associated with this Entry Cache.

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

getCacheLevel

java.lang.Integer getCacheLevel()
Gets the "cache-level" property.

Specifies the cache level in the cache order if more than one instance of the cache is configured.

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

setCacheLevel

void setCacheLevel(int value)
                   throws IllegalPropertyValueException
Sets the "cache-level" property.

Specifies the cache level in the cache order if more than one instance of the cache is configured.

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

isEnabled

java.lang.Boolean isEnabled()
Gets the "enabled" property.

Indicates whether the Entry Cache is enabled.

Returns:
Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException
Sets the "enabled" property.

Indicates whether the Entry Cache is enabled.

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

getJavaClass

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

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

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

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