Class VersionMonitorEntry
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
-
- com.unboundid.ldap.sdk.unboundidds.monitors.VersionMonitorEntry
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class VersionMonitorEntry extends MonitorEntry
This class defines a monitor entry that provides general information about the Directory Server version.
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
Information that it may make available includes:- The full Directory Server version string, which may contain spaces.
- The compact Directory Server version string, which will not contain any spaces and may use a more compact representation than the full version string.
- The Directory Server product name.
- A compact representation of the Directory Server product name.
- The server major version number.
- The server minor version number.
- The server point version number.
- A version qualifier string which may provide a more descriptive name for the build of the server.
- The server build ID string.
- The server promoted build number.
- The source control revision number for the source used to build the server.
- A list of the bugfix IDs for any special fixes included in the server.
MonitorManager.getVersionMonitorEntry(com.unboundid.ldap.sdk.LDAPConnection)
method. This entry provides specific methods for accessing this version information (e.g., thegetFullVersion()
method can be used to retrieve the full version string for the server). Alternately, this information may be accessed using the generic API. See theMonitorManager
class documentation for an example that demonstrates the use of the generic API for accessing monitor data.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.String
VERSION_MONITOR_OC
The structural object class used in version monitor entries.
-
Constructor Summary
Constructors Constructor Description VersionMonitorEntry(Entry entry)
Creates a new version monitor entry from the provided entry.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description 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.Boolean
getFIPS1402CompliantMode()
Indicates whether the server is running in FIPS 140-2-compliant mode.java.lang.Boolean
getFIPS1403CompliantMode()
Indicates whether the server is running in FIPS 140-3-compliant mode.java.lang.Boolean
getFIPSCompliantMode()
Indicates whether the server is running in FIPS-compliant mode.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., "Ping Identity Directory Server").java.lang.String
getRevisionID()
Retrieves a string that identifies the source revision from which the server was built.java.lang.Long
getRevisionNumber()
Deprecated.UsegetRevisionID()
instead, as the version control system might not use numeric revision identifiers.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., "Ping-Identity-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
-
-
-
-
Field Detail
-
VERSION_MONITOR_OC
@NotNull 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(@NotNull 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 benull
.
-
-
Method Detail
-
getBuildID
@Nullable 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
@Nullable 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
@Nullable 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.
-
getFIPSCompliantMode
@Nullable public java.lang.Boolean getFIPSCompliantMode()
Indicates whether the server is running in FIPS-compliant mode.- Returns:
Boolean.TRUE
if the server is running in FIPS 140-2 or FIPS 140-3-compliant mode,Boolean.FALSE
if the server is not running in FIPS-compliant mode, ornull
if it was not included in the monitor entry.
-
getFIPS1402CompliantMode
@Nullable public java.lang.Boolean getFIPS1402CompliantMode()
Indicates whether the server is running in FIPS 140-2-compliant mode.- Returns:
Boolean.TRUE
if the server is running in FIPS 140-2-compliant mode,Boolean.FALSE
if the server is not running in FIPS 140-2-compliant mode, ornull
if it was not included in the monitor entry.
-
getFIPS1403CompliantMode
@Nullable public java.lang.Boolean getFIPS1403CompliantMode()
Indicates whether the server is running in FIPS 140-3-compliant mode.- Returns:
Boolean.TRUE
if the server is running in FIPS 140-3-compliant mode,Boolean.FALSE
if the server is not running in FIPS 140-3-compliant mode, ornull
if it was not included in the monitor entry.
-
getFixIDs
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable public java.lang.String getProductName()
Retrieves the Directory Server product name (e.g., "Ping Identity Directory Server").- Returns:
- The Directory Server product name, or
null
if it was not included in the monitor entry.
-
getRevisionNumber
@Deprecated @Nullable public java.lang.Long getRevisionNumber()
Deprecated.UsegetRevisionID()
instead, as the version control system might not use numeric revision identifiers.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 or if it was not numeric.
-
getRevisionID
@Nullable public java.lang.String getRevisionID()
Retrieves a string that identifies the source revision from which the server was built.- Returns:
- A string that identifies the source revision from which the server was built.
-
getServerSDKVersion
@Nullable 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
@Nullable public java.lang.String getShortProductName()
Retrieves the Directory Server short product name (e.g., "Ping-Identity-DS").- Returns:
- The Directory Server short product name, or
null
if it was not included in the monitor entry.
-
getSNMP4JVersion
@Nullable 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
@Nullable 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
@Nullable 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
@Nullable 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
@NotNull public java.lang.String getMonitorDisplayName()
Retrieves a human-readable display name for this monitor entry.- Overrides:
getMonitorDisplayName
in classMonitorEntry
- Returns:
- A human-readable display name for this monitor entry.
-
getMonitorDescription
@NotNull public java.lang.String getMonitorDescription()
Retrieves a human-readable description name for this monitor entry.- Overrides:
getMonitorDescription
in classMonitorEntry
- Returns:
- A human-readable description name for this monitor entry.
-
getMonitorAttributes
@NotNull 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 classMonitorEntry
- Returns:
- The set of parsed monitor attributes for this monitor entry.
-
-