Package org.forgerock.opendj.server.config.client

Interface FIFOEntryCacheCfgClient

All Superinterfaces:

ConfigurationClient, EntryCacheCfgClient

public interface FIFOEntryCacheCfgClient
extends EntryCacheCfgClient

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

FIFO Entry Caches use a FIFO queue to keep track of the cached entries.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends FIFOEntryCacheCfgClient,? extends FIFOEntryCacheCfg>	definition()	Get the configuration definition associated with this FIFO Entry Cache.
SortedSet<String>	getExcludeFilter()	Gets the "exclude-filter" property.
SortedSet<String>	getIncludeFilter()	Gets the "include-filter" property.
String	getJavaClass()	Gets the "java-class" property.
long	getLockTimeout()	Gets the "lock-timeout" property.
int	getMaxEntries()	Gets the "max-entries" property.
int	getMaxMemoryPercent()	Gets the "max-memory-percent" property.
void	setExcludeFilter(Collection<String> values)	Sets the "exclude-filter" property.
void	setIncludeFilter(Collection<String> values)	Sets the "include-filter" property.
void	setJavaClass(String value)	Sets the "java-class" property.
void	setLockTimeout(Long value)	Sets the "lock-timeout" property.
void	setMaxEntries(Integer value)	Sets the "max-entries" property.
void	setMaxMemoryPercent(Integer value)	Sets the "max-memory-percent" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.EntryCacheCfgClient

getCacheLevel, isEnabled, setCacheLevel, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends FIFOEntryCacheCfgClient,? extends FIFOEntryCacheCfg> definition()

Get the configuration definition associated with this FIFO Entry Cache.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface EntryCacheCfgClient

Returns:

Returns the configuration definition associated with this FIFO Entry Cache.

getExcludeFilter

SortedSet<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(Collection<String> values)
               throws PropertyException

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:

PropertyException - If one or more of the new values are invalid.

getIncludeFilter

SortedSet<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(Collection<String> values)
               throws PropertyException

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:

PropertyException - If one or more of the new values are invalid.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

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

Specified by:

getJavaClass in interface EntryCacheCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface EntryCacheCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getLockTimeout

long getLockTimeout()

Gets the "lock-timeout" property.

Specifies 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(Long value)
             throws PropertyException

Sets the "lock-timeout" property.

Specifies 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:

PropertyException - If the new value is invalid.

getMaxEntries

int getMaxEntries()

Gets the "max-entries" property.

Specifies the maximum number of entries that we will allow in the cache.

Returns:

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

setMaxEntries

void setMaxEntries(Integer value)
            throws PropertyException

Sets the "max-entries" property.

Specifies the maximum number of entries that we will allow in the cache.

Parameters:

value - The value of the "max-entries" property.

Throws:

PropertyException - If the new value is invalid.

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.

Returns:

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

setMaxMemoryPercent

void setMaxMemoryPercent(Integer value)
                  throws PropertyException

Sets 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.

Parameters:

value - The value of the "max-memory-percent" property.

Throws:

PropertyException - If the new value is invalid.