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

Class MemoryUsageMonitorProviderCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<MemoryUsageMonitorProviderCfgClient,MemoryUsageMonitorProviderCfg>

org.forgerock.opendj.server.config.meta.MemoryUsageMonitorProviderCfgDefn

public final class MemoryUsageMonitorProviderCfgDefn
extends ManagedObjectDefinition<MemoryUsageMonitorProviderCfgClient,MemoryUsageMonitorProviderCfg>

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

The Memory Usage Monitor Provider can be used to publish information about memory consumption and garbage collection activity in the JVM.

Method Summary

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

Get the Memory Usage Monitor Provider configuration definition singleton.

Returns:

Returns the Memory Usage Monitor Provider configuration definition singleton.

createClientConfiguration

public MemoryUsageMonitorProviderCfgClient createClientConfiguration(ManagedObject<? extends MemoryUsageMonitorProviderCfgClient> 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<MemoryUsageMonitorProviderCfgClient,MemoryUsageMonitorProviderCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<MemoryUsageMonitorProviderCfgClient,MemoryUsageMonitorProviderCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<MemoryUsageMonitorProviderCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<MemoryUsageMonitorProviderCfgClient,MemoryUsageMonitorProviderCfg>

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

Returns:

Returns the "java-class" property definition.