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

Interface EntryCacheCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

FifoEntryCacheCfgClient, 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 OpenDJ directory server performance.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends EntryCacheCfgClient,? extends EntryCacheCfg>	definition()	Get the configuration definition associated with this Entry Cache.
ValueOrExpression<Integer>	getCacheLevel()	Gets the "cache-level" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setCacheLevel(ValueOrExpression<Integer> value)	Sets the "cache-level" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.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

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setCacheLevel(ValueOrExpression<Integer> value)
            throws PropertyException

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:

PropertyException - If the new value is invalid.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the Entry Cache is enabled.

Returns:

Returns the value of the "enabled" property.

setEnabled

@MandatoryProperty
void setEnabled(ValueOrExpression<Boolean> value)
         throws PropertyException

Sets the "enabled" property.

Indicates whether the Entry Cache is enabled.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

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:

PropertyException - If the new value is invalid.