org.opends.server.monitors
Class VersionMonitorProvider

java.lang.Object
  java.lang.Thread
      org.opends.server.api.DirectoryThread
          org.opends.server.api.MonitorProvider<VersionMonitorProviderCfg>
              org.opends.server.monitors.VersionMonitorProvider

All Implemented Interfaces:

java.lang.Runnable

public class VersionMonitorProvider
extends MonitorProvider<VersionMonitorProviderCfg>

This class defines a monitor provider that reports Directory Server version information.

Nested Class Summary

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

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

Field Summary

static java.lang.String	ATTR_BUILD_ID The name of the attribute used to provide the build ID (aka the build timestamp).
static java.lang.String	ATTR_BUILD_NUMBER The name of the attribute used to provide the weekly build number.
static java.lang.String	ATTR_COMPACT_VERSION The name of the attribute used to provide the compact version string.
static java.lang.String	ATTR_FIX_IDS The name of the attribute used to provide the list of bugfix IDs.
static java.lang.String	ATTR_FULL_VERSION The name of the attribute used to provide the full version string.
static java.lang.String	ATTR_MAJOR_VERSION The name of the attribute used to provide the major version number.
static java.lang.String	ATTR_MINOR_VERSION The name of the attribute used to provide the minor version number.
static java.lang.String	ATTR_POINT_VERSION The name of the attribute used to provide the point version number.
static java.lang.String	ATTR_PRODUCT_NAME The name of the attribute used to provide the product name.
static java.lang.String	ATTR_REVISION_NUMBER The name of the attribute used to provide the Subversion revision number.
static java.lang.String	ATTR_SHORT_NAME The name of the attribute used to provide the short name.
static java.lang.String	ATTR_VERSION_QUALIFIER The name of the attribute used to provide the version qualifier string.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

VersionMonitorProvider()
Initializes this monitor provider.

Method Summary

java.util.ArrayList<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.
long	getUpdateInterval() Retrieves the length of time in milliseconds that should elapse between calls to the updateMonitorData() method.
void	initializeMonitorProvider(VersionMonitorProviderCfg 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, getMonitorObjectClass, 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

Field Detail

ATTR_PRODUCT_NAME

public static final java.lang.String ATTR_PRODUCT_NAME

The name of the attribute used to provide the product name.

See Also:

Constant Field Values

ATTR_SHORT_NAME

public static final java.lang.String ATTR_SHORT_NAME

The name of the attribute used to provide the short name.

See Also:

Constant Field Values

ATTR_MAJOR_VERSION

public static final java.lang.String ATTR_MAJOR_VERSION

The name of the attribute used to provide the major version number.

See Also:

Constant Field Values

ATTR_MINOR_VERSION

public static final java.lang.String ATTR_MINOR_VERSION

The name of the attribute used to provide the minor version number.

See Also:

Constant Field Values

ATTR_POINT_VERSION

public static final java.lang.String ATTR_POINT_VERSION

The name of the attribute used to provide the point version number.

See Also:

Constant Field Values

ATTR_VERSION_QUALIFIER

public static final java.lang.String ATTR_VERSION_QUALIFIER

The name of the attribute used to provide the version qualifier string.

See Also:

Constant Field Values

ATTR_BUILD_NUMBER

public static final java.lang.String ATTR_BUILD_NUMBER

The name of the attribute used to provide the weekly build number.

See Also:

Constant Field Values

ATTR_FIX_IDS

public static final java.lang.String ATTR_FIX_IDS

The name of the attribute used to provide the list of bugfix IDs.

See Also:

Constant Field Values

ATTR_REVISION_NUMBER

public static final java.lang.String ATTR_REVISION_NUMBER

The name of the attribute used to provide the Subversion revision number.

See Also:

Constant Field Values

ATTR_BUILD_ID

public static final java.lang.String ATTR_BUILD_ID

The name of the attribute used to provide the build ID (aka the build timestamp).

See Also:

Constant Field Values

ATTR_COMPACT_VERSION

public static final java.lang.String ATTR_COMPACT_VERSION

The name of the attribute used to provide the compact version string.

See Also:

Constant Field Values

ATTR_FULL_VERSION

public static final java.lang.String ATTR_FULL_VERSION

The name of the attribute used to provide the full version string.

See Also:

Constant Field Values

Constructor Detail

VersionMonitorProvider

public VersionMonitorProvider()

Initializes this monitor provider.

Method Detail

initializeMonitorProvider

public void initializeMonitorProvider(VersionMonitorProviderCfg configuration)
                               throws ConfigException,
                                      InitializationException

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

Specified by:

initializeMonitorProvider in class MonitorProvider<VersionMonitorProviderCfg>

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

Returns:

The name of 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<VersionMonitorProviderCfg>

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

getMonitorData

public java.util.ArrayList<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<VersionMonitorProviderCfg>

Returns:

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