|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Thread
org.opends.server.api.DirectoryThread
org.opends.server.api.MonitorProvider<VersionMonitorProviderCfg>
org.opends.server.monitors.VersionMonitorProvider
public class VersionMonitorProvider
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 |
---|
public static final java.lang.String ATTR_PRODUCT_NAME
public static final java.lang.String ATTR_SHORT_NAME
public static final java.lang.String ATTR_MAJOR_VERSION
public static final java.lang.String ATTR_MINOR_VERSION
public static final java.lang.String ATTR_POINT_VERSION
public static final java.lang.String ATTR_VERSION_QUALIFIER
public static final java.lang.String ATTR_BUILD_NUMBER
public static final java.lang.String ATTR_FIX_IDS
public static final java.lang.String ATTR_REVISION_NUMBER
public static final java.lang.String ATTR_BUILD_ID
public static final java.lang.String ATTR_COMPACT_VERSION
public static final java.lang.String ATTR_FULL_VERSION
Constructor Detail |
---|
public VersionMonitorProvider()
Method Detail |
---|
public void initializeMonitorProvider(VersionMonitorProviderCfg configuration) throws ConfigException, InitializationException
initializeMonitorProvider
in class MonitorProvider<VersionMonitorProviderCfg>
configuration
- The configuration to use to initialize
this monitor provider.
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.public java.lang.String getMonitorInstanceName()
getMonitorInstanceName
in class MonitorProvider<VersionMonitorProviderCfg>
public long getUpdateInterval()
updateMonitorData()
method. A negative or zero
return value indicates that the updateMonitorData()
method
should not be periodically invoked.
getUpdateInterval
in class MonitorProvider<VersionMonitorProviderCfg>
updateMonitorData()
method.public void updateMonitorData()
getUpdateInterval()
milliseconds apart, but no guarantees will
be made.
updateMonitorData
in class MonitorProvider<VersionMonitorProviderCfg>
public java.util.ArrayList<Attribute> getMonitorData()
getMonitorData
in class MonitorProvider<VersionMonitorProviderCfg>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |