com.unboundid.ldap.sdk.unboundidds.monitors
Class VersionMonitorEntry

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
      extended by com.unboundid.ldap.sdk.unboundidds.monitors.VersionMonitorEntry
All Implemented Interfaces:
java.io.Serializable

@NotMutable
@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class VersionMonitorEntry
extends MonitorEntry

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This class defines a monitor entry that provides general information about the Directory Server version. Information that it may make available includes: The server should present at most one version monitor entry. It can be retrieved using the MonitorManager.getVersionMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection) method. This entry provides specific methods for accessing this version information (e.g., the getFullVersion() method can be used to retrieve the full version string for the server). Alternately, this information may be accessed using the generic API. See the MonitorManager class documentation for an example that demonstrates the use of the generic API for accessing monitor data.

See Also:
Serialized Form

Field Summary
protected static java.lang.String VERSION_MONITOR_OC
          The structural object class used in version monitor entries.
 
Constructor Summary
VersionMonitorEntry(Entry entry)
          Creates a new version monitor entry from the provided entry.
 
Method Summary
 java.lang.String getBerkeleyDBJEVersion()
          Retrieves the Berkeley DB Java Edition library version string.
 java.lang.String getBuildID()
          Retrieves the Directory Server build ID string.
 java.lang.Long getBuildNumber()
          Retrieves the Directory Server promoted build number.
 java.lang.String getCompactVersion()
          Retrieves a compact representation of the Directory Server version string.
 java.lang.String getFixIDs()
          Retrieves a space-delimited list of the bugfix IDs for special fixes included in the Directory Server.
 java.lang.String getFullVersion()
          Retrieves the full Directory Server version string.
 java.lang.String getGroovyVersion()
          Retrieves the Groovy library version string.
 java.lang.String getJZLibVersion()
          Retrieves the jzlib library version string.
 java.lang.String getLDAPSDKVersion()
          Retrieves the UnboundID LDAP SDK for Java library version string.
 java.lang.Long getMajorVersion()
          Retrieves the Directory Server major version number.
 java.lang.Long getMinorVersion()
          Retrieves the Directory Server minor version number.
 java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
          Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.
 java.lang.String getMonitorDescription()
          Retrieves a human-readable description name for this monitor entry.
 java.lang.String getMonitorDisplayName()
          Retrieves a human-readable display name for this monitor entry.
 java.lang.Long getPointVersion()
          Retrieves the Directory Server point version number.
 java.lang.String getProductName()
          Retrieves the Directory Server product name (e.g., "UnboundID Directory Server").
 java.lang.Long getRevisionNumber()
          Retrieves the source revision number from which the Directory Server was built.
 java.lang.String getServerSDKVersion()
          Retrieves the UnboundID Server SDK library version string.
 java.lang.String getShortProductName()
          Retrieves the Directory Server short product name (e.g., "UnboundID-DS").
 java.lang.String getSNMP4JAgentVersion()
          Retrieves the SNMP4J agent library version string.
 java.lang.String getSNMP4JAgentXVersion()
          Retrieves the SNMP4J AgentX library version string.
 java.lang.String getSNMP4JVersion()
          Retrieves the SNMP4J library version string.
 java.lang.String getVersionQualifier()
          Retrieves the Directory Server version qualifier string (e.g., "-beta1").
 
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, addMonitorAttribute, decode, getBoolean, getDate, getDN, getDouble, getEntry, getInteger, getLong, getMonitorClass, getMonitorName, getString, getStrings, toString, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

VERSION_MONITOR_OC

protected static final java.lang.String VERSION_MONITOR_OC
The structural object class used in version monitor entries.

See Also:
Constant Field Values
Constructor Detail

VersionMonitorEntry

public VersionMonitorEntry(Entry entry)
Creates a new version monitor entry from the provided entry.

Parameters:
entry - The entry to be parsed as a version monitor entry. It must not be null.
Method Detail

getBuildID

public java.lang.String getBuildID()
Retrieves the Directory Server build ID string.

Returns:
The Directory Server build ID string, or null if it was not included in the monitor entry.

getBuildNumber

public java.lang.Long getBuildNumber()
Retrieves the Directory Server promoted build number.

Returns:
The Directory Server promoted build number, or null if it was not included in the monitor entry.

getCompactVersion

public java.lang.String getCompactVersion()
Retrieves a compact representation of the Directory Server version string. It will not contain any spaces.

Returns:
A compact representation of the Directory Server version string, or null if it was not included in the monitor entry.

getFixIDs

public java.lang.String getFixIDs()
Retrieves a space-delimited list of the bugfix IDs for special fixes included in the Directory Server.

Returns:
A space-delimited list of the bugfix IDs for special fixes included in the Directory Server, or null if it was not included in the monitor entry.

getFullVersion

public java.lang.String getFullVersion()
Retrieves the full Directory Server version string.

Returns:
The full Directory Server version string, or null if it was not included in the monitor entry.

getGroovyVersion

public java.lang.String getGroovyVersion()
Retrieves the Groovy library version string.

Returns:
The Groovy library version string, or null if it was not included in the monitor entry.

getBerkeleyDBJEVersion

public java.lang.String getBerkeleyDBJEVersion()
Retrieves the Berkeley DB Java Edition library version string.

Returns:
The Berkeley DB Java Edition library version string, or null if it was not included in the monitor entry.

getJZLibVersion

public java.lang.String getJZLibVersion()
Retrieves the jzlib library version string.

Returns:
The jzlib library version string, or null if it was not included in the monitor entry.

getLDAPSDKVersion

public java.lang.String getLDAPSDKVersion()
Retrieves the UnboundID LDAP SDK for Java library version string.

Returns:
The UnboundID LDAP SDK for Java library version string, or null if it was not included in the monitor entry.

getMajorVersion

public java.lang.Long getMajorVersion()
Retrieves the Directory Server major version number.

Returns:
The Directory Server major version number, or null if it was not included in the monitor entry.

getMinorVersion

public java.lang.Long getMinorVersion()
Retrieves the Directory Server minor version number.

Returns:
The Directory Server minor version number, or null if it was not included in the monitor entry.

getPointVersion

public java.lang.Long getPointVersion()
Retrieves the Directory Server point version number.

Returns:
The Directory Server point version number, or null if it was not included in the monitor entry.

getProductName

public java.lang.String getProductName()
Retrieves the Directory Server product name (e.g., "UnboundID Directory Server").

Returns:
The Directory Server product name, or null if it was not included in the monitor entry.

getRevisionNumber

public java.lang.Long getRevisionNumber()
Retrieves the source revision number from which the Directory Server was built.

Returns:
The source revision number from which the Directory Server was built, or null if it was not included in the monitor entry.

getServerSDKVersion

public java.lang.String getServerSDKVersion()
Retrieves the UnboundID Server SDK library version string.

Returns:
The UnboundID Server SDK library version string, or null if it was not included in the monitor entry.

getShortProductName

public java.lang.String getShortProductName()
Retrieves the Directory Server short product name (e.g., "UnboundID-DS").

Returns:
The Directory Server short product name, or null if it was not included in the monitor entry.

getSNMP4JVersion

public java.lang.String getSNMP4JVersion()
Retrieves the SNMP4J library version string.

Returns:
The SNMP4J library version string, or null if it was not included in the monitor entry.

getSNMP4JAgentVersion

public java.lang.String getSNMP4JAgentVersion()
Retrieves the SNMP4J agent library version string.

Returns:
The SNMP4J agent library version string, or null if it was not included in the monitor entry.

getSNMP4JAgentXVersion

public java.lang.String getSNMP4JAgentXVersion()
Retrieves the SNMP4J AgentX library version string.

Returns:
The SNMP4J AgentX library version string, or null if it was not included in the monitor entry.

getVersionQualifier

public java.lang.String getVersionQualifier()
Retrieves the Directory Server version qualifier string (e.g., "-beta1").

Returns:
The Directory Server version qualifier string, or null if it was not included in the monitor entry.

getMonitorDisplayName

public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.

Overrides:
getMonitorDisplayName in class MonitorEntry
Returns:
A human-readable display name for this monitor entry.

getMonitorDescription

public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.

Overrides:
getMonitorDescription in class MonitorEntry
Returns:
A human-readable description name for this monitor entry.

getMonitorAttributes

public java.util.Map<java.lang.String,MonitorAttribute> getMonitorAttributes()
Retrieves the set of parsed monitor attributes for this monitor entry, mapped from a unique identifier (in all lowercase characters) to the corresponding monitor attribute.

Overrides:
getMonitorAttributes in class MonitorEntry
Returns:
The set of parsed monitor attributes for this monitor entry.