org.opends.server.monitors

Class LocalBackendMonitor

java.lang.Object

org.opends.server.api.MonitorProvider<org.forgerock.opendj.server.config.server.MonitorProviderCfg>

org.opends.server.monitors.LocalBackendMonitor

public class LocalBackendMonitor
extends MonitorProvider<org.forgerock.opendj.server.config.server.MonitorProviderCfg>

This class implements a monitor provider that will report generic information for an enabled Directory Server backend, including its backend ID, base DNs, writability mode, and the number of entries it contains.

Constructor Summary

Constructors

Constructor and Description
LocalBackendMonitor(LocalBackend<?> backend) Creates a new instance of this backend monitor provider that will work with the provided backend.

Method Summary

Modifier and Type	Method and 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.
org.forgerock.opendj.ldap.schema.ObjectClass	getMonitorObjectClass() Retrieves the objectclass that should be included in the monitor entry created from this monitor provider.
void	initializeMonitorProvider(org.forgerock.opendj.server.config.server.MonitorProviderCfg configuration) Initializes this monitor provider based on the information in the provided configuration entry.

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

finalizeMonitorProvider, isConfigurationAcceptable, scheduleUpdate

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalBackendMonitor

public LocalBackendMonitor(LocalBackend<?> backend)

Creates a new instance of this backend monitor provider that will work with the provided backend. Most of the initialization should be handled in the initializeMonitorProvider method.

Parameters:

backend - The backend with which this monitor is associated.

Method Detail

initializeMonitorProvider

public void initializeMonitorProvider(org.forgerock.opendj.server.config.server.MonitorProviderCfg configuration)

Description copied from class: MonitorProvider

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

Overrides:

initializeMonitorProvider in class MonitorProvider<org.forgerock.opendj.server.config.server.MonitorProviderCfg>

Parameters:

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

getMonitorInstanceName

public String getMonitorInstanceName()

Description copied from class: MonitorProvider

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<org.forgerock.opendj.server.config.server.MonitorProviderCfg>

Returns:

The name of this monitor provider.

getMonitorObjectClass

public org.forgerock.opendj.ldap.schema.ObjectClass getMonitorObjectClass()

Retrieves the objectclass that should be included in the monitor entry created from this monitor provider.

Overrides:

getMonitorObjectClass in class MonitorProvider<org.forgerock.opendj.server.config.server.MonitorProviderCfg>

Returns:

The objectclass that should be included in the monitor entry created from this monitor provider.

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<org.forgerock.opendj.server.config.server.MonitorProviderCfg>

Returns:

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