Package org.forgerock.opendj.server.config.client

Interface MemoryUsageMonitorProviderCfgClient

All Superinterfaces:

ConfigurationClient, MonitorProviderCfgClient

public interface MemoryUsageMonitorProviderCfgClient
extends MonitorProviderCfgClient

A client-side interface for reading and modifying Memory Usage Monitor Provider settings.

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
ManagedObjectDefinition<? extends MemoryUsageMonitorProviderCfgClient,? extends MemoryUsageMonitorProviderCfg>	definition()	Get the configuration definition associated with this Memory Usage Monitor Provider.
String	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(String value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.MonitorProviderCfgClient

isEnabled, setEnabled

Method Detail

definition

ManagedObjectDefinition<? extends MemoryUsageMonitorProviderCfgClient,? extends MemoryUsageMonitorProviderCfg> definition()

Get the configuration definition associated with this Memory Usage Monitor Provider.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface MonitorProviderCfgClient

Returns:

Returns the configuration definition associated with this Memory Usage Monitor Provider.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Memory Usage Monitor Provider implementation.

Specified by:

getJavaClass in interface MonitorProviderCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Memory Usage Monitor Provider implementation.

Specified by:

setJavaClass in interface MonitorProviderCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.