Package com.unboundid.ldap.sdk.unboundidds.monitors

Class VersionMonitorEntry

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.monitors.MonitorEntry
com.unboundid.ldap.sdk.unboundidds.monitors.VersionMonitorEntry
All Implemented Interfaces:
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.
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:

  • Field Details

  • Constructor Details

    • 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 be null.

  • Method Details

    • getBuildID

      @Nullable public 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 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 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 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, or null if it was not included in the monitor entry.

    • getFIPS1402CompliantMode

      @Nullable public 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, or null if it was not included in the monitor entry.

    • getFIPS1403CompliantMode

      @Nullable public 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, or null if it was not included in the monitor entry.

    • getFixIDs

      @Nullable public 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 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 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 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 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 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 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 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 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 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 Long getRevisionNumber()
      Deprecated.
      Use getRevisionID() 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 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 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 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 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 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 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 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 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

      @NotNull public 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

      @NotNull public Map<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.