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

public class VersionMonitorProvider
extends MonitorProvider<VersionMonitorProviderCfg>

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

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`ATTR_BUILD_ID`	The name of the attribute used to provide the build ID (aka the build timestamp).
`static String`	`ATTR_BUILD_NUMBER`	The name of the attribute used to provide the weekly build number.
`static String`	`ATTR_COMPACT_VERSION`	The name of the attribute used to provide the compact version string.
`static String`	`ATTR_FIX_IDS`	The name of the attribute used to provide the list of bugfix IDs.
`static String`	`ATTR_FULL_VERSION`	The name of the attribute used to provide the full version string.
`static String`	`ATTR_MAJOR_VERSION`	The name of the attribute used to provide the major version number.
`static String`	`ATTR_MINOR_VERSION`	The name of the attribute used to provide the minor version number.
`static String`	`ATTR_POINT_VERSION`	The name of the attribute used to provide the point version number.
`static String`	`ATTR_PRODUCT_NAME`	The name of the attribute used to provide the product name.
`static String`	`ATTR_REVISION`	The name of the attribute used to provide the revision in the version control system.
`static String`	`ATTR_SHORT_NAME`	The name of the attribute used to provide the short name.
`static String`	`ATTR_VERSION_QUALIFIER`	The name of the attribute used to provide the version qualifier string.

Constructor Summary

Constructors
Constructor Description

VersionMonitorProvider()

Method Summary

All Methods Instance Methods Concrete Methods
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(VersionMonitorProviderCfg configuration)`	Initializes this monitor provider based on the information in the provided configuration entry.

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

- Field Detail
  - ATTR_PRODUCT_NAME
```
public static final 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 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 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 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 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 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 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 String ATTR_FIX_IDS
```
    The name of the attribute used to provide the list of bugfix IDs.
    
    See Also:
    
    Constant Field Values
  - ATTR_REVISION
```
public static final String ATTR_REVISION
```
    The name of the attribute used to provide the revision in the version control system.
    
    See Also:
    
    Constant Field Values
  - ATTR_BUILD_ID
```
public static final 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 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 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()
```
- Method Detail
  - initializeMonitorProvider
```
public void initializeMonitorProvider(VersionMonitorProviderCfg configuration)
                               throws ConfigException,
                                      InitializationException
```
    Description copied from class: MonitorProvider
    
    Initializes this monitor provider based on the information in the provided configuration entry.
    
    Overrides:
    
    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 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<VersionMonitorProviderCfg>
    
    Returns:
    
    The name of 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<VersionMonitorProviderCfg>
    
    Returns:
    
    A set of attributes containing monitor data that should be returned to the client if the corresponding monitor entry is requested.

Class VersionMonitorProvider

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

ATTR_PRODUCT_NAME

ATTR_SHORT_NAME

ATTR_MAJOR_VERSION

ATTR_MINOR_VERSION

ATTR_POINT_VERSION

ATTR_VERSION_QUALIFIER

ATTR_BUILD_NUMBER

ATTR_FIX_IDS

ATTR_REVISION

ATTR_BUILD_ID

ATTR_COMPACT_VERSION

ATTR_FULL_VERSION

Constructor Detail

VersionMonitorProvider

Method Detail

initializeMonitorProvider

getMonitorInstanceName

getMonitorData