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

All Superinterfaces:
ConfigurationClient, EntryCacheCfgClient

public interface SoftReferenceEntryCacheCfgClient
extends EntryCacheCfgClient

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

The Soft Reference Entry Cache is a Directory Server entry cache implementation that uses soft references to manage objects to allow them to be freed if the JVM is running low on memory.


Method Summary
 ManagedObjectDefinition<? extends SoftReferenceEntryCacheCfgClient,? extends SoftReferenceEntryCacheCfg> definition()
          Get the configuration definition associated with this Soft Reference 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.
 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 setLockTimeout(java.lang.Long value)
          Sets the "lock-timeout" 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 SoftReferenceEntryCacheCfgClient,? extends SoftReferenceEntryCacheCfg> definition()
Get the configuration definition associated with this Soft Reference Entry Cache.

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

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 Soft Reference 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 Soft Reference 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.

getLockTimeout

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

Specifies the length of time in milliseconds 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.

Specifies the length of time in milliseconds 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.