Package org.opends.server.monitors

Class MemoryUsageMonitorProvider

java.lang.Object

org.opends.server.api.MonitorProvider<MemoryUsageMonitorProviderCfg>

org.opends.server.monitors.MemoryUsageMonitorProvider

All Implemented Interfaces:

Runnable

public class MemoryUsageMonitorProvider
extends MonitorProvider<MemoryUsageMonitorProviderCfg>
implements Runnable

This class defines a monitor provider that reports information about Directory Server memory usage.

Constructor Summary

Constructors

Constructor	Description
MemoryUsageMonitorProvider()

Method Summary

Modifier and Type	Method	Description
MonitorData	getMonitorData()	Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
String	getMonitorInstanceName()	Retrieves the name of this monitor provider.
void	initializeMonitorProvider(MemoryUsageMonitorProviderCfg configuration)	Initializes this monitor provider based on the information in the provided configuration entry.
void	run()

Methods inherited from class org.opends.server.api.MonitorProvider

finalizeMonitorProvider, getMonitorObjectClass, isConfigurationAcceptable, scheduleUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MemoryUsageMonitorProvider

public MemoryUsageMonitorProvider()

Method Detail

initializeMonitorProvider

public void initializeMonitorProvider(MemoryUsageMonitorProviderCfg configuration)
                               throws ConfigException,
                                      InitializationException

Initializes this monitor provider based on the information in the provided configuration entry.

Overrides:

initializeMonitorProvider in class MonitorProvider<MemoryUsageMonitorProviderCfg>

Parameters:

configuration - The configuration to use to initialize this monitor provider.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization.

InitializationException - If a problem occurs during initialization that is not related to the server configuration.

getMonitorInstanceName

public String getMonitorInstanceName()

Retrieves the name of this monitor provider. It should be unique among all monitor providers, including all instances of the same monitor provider.

Specified by:

getMonitorInstanceName in class MonitorProvider<MemoryUsageMonitorProviderCfg>

Returns:

The name of this monitor provider.

run

public void run()

Specified by:

run in interface Runnable

getMonitorData

public MonitorData getMonitorData()

Description copied from class: MonitorProvider

Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.

Specified by:

getMonitorData in class MonitorProvider<MemoryUsageMonitorProviderCfg>

Returns:

A set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.