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

Class EntryCacheMonitorProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<EntryCacheMonitorProviderCfgClient,EntryCacheMonitorProviderCfg>

org.forgerock.opendj.server.config.meta.EntryCacheMonitorProviderCfgDefn

public final class EntryCacheMonitorProviderCfgDefn
extends ManagedObjectDefinition<EntryCacheMonitorProviderCfgClient,EntryCacheMonitorProviderCfg>

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

The Entry Cache Monitor Provider exposes monitor information about the state of OpenDJ directory server entry caches.

Method Summary

Modifier and Type	Method	Description
EntryCacheMonitorProviderCfgClient	createClientConfiguration(ManagedObject<? extends EntryCacheMonitorProviderCfgClient> impl)	Creates a client configuration view of the provided managed object.
EntryCacheMonitorProviderCfg	createServerConfiguration(ServerManagedObject<? extends EntryCacheMonitorProviderCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static EntryCacheMonitorProviderCfgDefn	getInstance()	Get the Entry Cache Monitor Provider configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<EntryCacheMonitorProviderCfg>	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 EntryCacheMonitorProviderCfgDefn getInstance()

Get the Entry Cache Monitor Provider configuration definition singleton.

Returns:

Returns the Entry Cache Monitor Provider configuration definition singleton.

createClientConfiguration

public EntryCacheMonitorProviderCfgClient createClientConfiguration(ManagedObject<? extends EntryCacheMonitorProviderCfgClient> 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<EntryCacheMonitorProviderCfgClient,EntryCacheMonitorProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<EntryCacheMonitorProviderCfgClient,EntryCacheMonitorProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<EntryCacheMonitorProviderCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<EntryCacheMonitorProviderCfgClient,EntryCacheMonitorProviderCfg>

Returns:

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

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Entry Cache Monitor Provider is enabled for use.

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 Monitor Provider implementation.

Returns:

Returns the "java-class" property definition.