Package org.forgerock.opendj.server.config.meta

Class EntryCacheCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<EntryCacheCfgClient,EntryCacheCfg>

org.forgerock.opendj.server.config.meta.EntryCacheCfgDefn

public final class EntryCacheCfgDefn
extends ManagedObjectDefinition<EntryCacheCfgClient,EntryCacheCfg>

An interface for querying the Entry Cache managed object definition meta information.

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
EntryCacheCfgClient	createClientConfiguration(ManagedObject<? extends EntryCacheCfgClient> impl)	Creates a client configuration view of the provided managed object.
EntryCacheCfg	createServerConfiguration(ServerManagedObject<? extends EntryCacheCfg> impl)	Creates a server configuration view of the provided server managed object.
IntegerPropertyDefinition	getCacheLevelPropertyDefinition()	Get the "cache-level" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static EntryCacheCfgDefn	getInstance()	Get the Entry Cache configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<EntryCacheCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static EntryCacheCfgDefn getInstance()

Get the Entry Cache configuration definition singleton.

Returns:

Returns the Entry Cache configuration definition singleton.

createClientConfiguration

public EntryCacheCfgClient createClientConfiguration(ManagedObject<? extends EntryCacheCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<EntryCacheCfgClient,EntryCacheCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public EntryCacheCfg createServerConfiguration(ServerManagedObject<? extends EntryCacheCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<EntryCacheCfgClient,EntryCacheCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<EntryCacheCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<EntryCacheCfgClient,EntryCacheCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getCacheLevelPropertyDefinition

public IntegerPropertyDefinition getCacheLevelPropertyDefinition()

Get the "cache-level" property definition.

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

Returns:

Returns the "cache-level" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Entry Cache is enabled.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.