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

Class VersionMonitorProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<VersionMonitorProviderCfgClient,VersionMonitorProviderCfg>

org.forgerock.opendj.server.config.meta.VersionMonitorProviderCfgDefn

public final class VersionMonitorProviderCfgDefn
extends ManagedObjectDefinition<VersionMonitorProviderCfgClient,VersionMonitorProviderCfg>

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

The Version Monitor Provider can be used to publish directory server version information.

Method Summary

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

Get the Version Monitor Provider configuration definition singleton.

Returns:

Returns the Version Monitor Provider configuration definition singleton.

createClientConfiguration

public VersionMonitorProviderCfgClient createClientConfiguration(ManagedObject<? extends VersionMonitorProviderCfgClient> 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<VersionMonitorProviderCfgClient,VersionMonitorProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<VersionMonitorProviderCfgClient,VersionMonitorProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<VersionMonitorProviderCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<VersionMonitorProviderCfgClient,VersionMonitorProviderCfg>

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

Returns:

Returns the "java-class" property definition.