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

Class MonitorProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<MonitorProviderCfgClient,MonitorProviderCfg>

org.forgerock.opendj.server.config.meta.MonitorProviderCfgDefn

public final class MonitorProviderCfgDefn
extends ManagedObjectDefinition<MonitorProviderCfgClient,MonitorProviderCfg>

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

Monitor Providers can be used to provide information about the state of the server or one of its components.

Method Summary

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

Get the Monitor Provider configuration definition singleton.

Returns:

Returns the Monitor Provider configuration definition singleton.

createClientConfiguration

public MonitorProviderCfgClient createClientConfiguration(ManagedObject<? extends MonitorProviderCfgClient> 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<MonitorProviderCfgClient,MonitorProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<MonitorProviderCfgClient,MonitorProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<MonitorProviderCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<MonitorProviderCfgClient,MonitorProviderCfg>

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

Returns:

Returns the "java-class" property definition.