org.opends.server.monitors
Class BackendMonitor

java.lang.Object
  java.lang.Thread
      org.opends.server.api.DirectoryThread
          org.opends.server.api.MonitorProvider<MonitorProviderCfg>
              org.opends.server.monitors.BackendMonitor

All Implemented Interfaces:

java.lang.Runnable

public class BackendMonitor
extends MonitorProvider<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.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

BackendMonitor(Backend backend)
Creates a new instance of this backend monitor provider that will work with the provided backend.

Method Summary

java.util.List<Attribute>	getMonitorData() Retrieves a set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.
java.lang.String	getMonitorInstanceName() Retrieves the name of this monitor provider.
ObjectClass	getMonitorObjectClass() Retrieves the objectclass that should be included in the monitor entry created from this monitor provider.
long	getUpdateInterval() Retrieves the length of time in milliseconds that should elapse between calls to the updateMonitorData method.
void	initializeMonitorProvider(MonitorProviderCfg configuration) Initializes this monitor provider based on the information in the provided configuration entry.
void	updateMonitorData() Performs any processing periodic processing that may be desired to update the information associated with this monitor.

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

finalizeMonitorProvider, isConfigurationAcceptable, run

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

getAssociatedTask, getCreationStackTrace, getDebugProperties, getParentThread, setAssociatedTask

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

BackendMonitor

public BackendMonitor(Backend 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(MonitorProviderCfg configuration)

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

Specified by:

initializeMonitorProvider in class MonitorProvider<MonitorProviderCfg>

Parameters:

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

getMonitorInstanceName

public java.lang.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<MonitorProviderCfg>

Returns:

The name of this monitor provider.

getMonitorObjectClass

public ObjectClass getMonitorObjectClass()

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

Overrides:

getMonitorObjectClass in class MonitorProvider<MonitorProviderCfg>

Returns:

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

getUpdateInterval

public long getUpdateInterval()

Retrieves the length of time in milliseconds that should elapse between calls to the updateMonitorData method. A negative or zero return value indicates that the updateMonitorData method should not be periodically invoked.

Specified by:

getUpdateInterval in class MonitorProvider<MonitorProviderCfg>

Returns:

The length of time in milliseconds that should elapse between calls to the updateMonitorData() method.

updateMonitorData

public void updateMonitorData()

Performs any processing periodic processing that may be desired to update the information associated with this monitor. Note that best-effort attempts will be made to ensure that calls to this method come getUpdateInterval milliseconds apart, but no guarantees will be made.

Specified by:

updateMonitorData in class MonitorProvider<MonitorProviderCfg>

getMonitorData

public java.util.List<Attribute> getMonitorData()

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<MonitorProviderCfg>

Returns:

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