Package com.unboundid.ldap.sdk.unboundidds

Class UnboundIDRootDSE

java.lang.Object
com.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.RootDSE
com.unboundid.ldap.sdk.unboundidds.UnboundIDRootDSE
All Implemented Interfaces:
LDIFRecord, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class UnboundIDRootDSE extends RootDSE
This class provides an enhanced implementation of the RootDSE class that provides access to additional attributes that may be included in the root DSE of a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server.
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.
See Also:

  • Field Details

  • Constructor Details

    • UnboundIDRootDSE

      public UnboundIDRootDSE(@NotNull Entry rootDSEEntry)
      Creates a new UnboundID root DSE object from the information in the provided entry.
      Parameters:
      rootDSEEntry - The entry to use to create this UnboundID root DSE object. It must not be null.

  • Method Details

    • getRootDSE

      @Nullable public static UnboundIDRootDSE getRootDSE(@NotNull LDAPInterface connection) throws LDAPException
      Retrieves the root DSE from an UnboundID server using the provided connection.
      Parameters:
      connection - The connection to use to retrieve the server root DSE.
      Returns:
      The UnboundID server root DSE, or null if it is not available (e.g., the client does not have permission to read the entry).
      Throws:
      LDAPException - If a problem occurs while attempting to retrieve the server root DSE.

    • getBaselineConfigurationDigest

      @Nullable public String getBaselineConfigurationDigest()
      Retrieves a digest of the baseline configuration for the software version the server is currently running.
      Returns:
      The server's baseline configuration digest, or null if that information is not available.

    • getConfigurationModelDigest

      @Nullable public String getConfigurationModelDigest()
      Retrieves a digest of the configuration model for the software version the server is currently running.
      Returns:
      The server's configuration model digest, or null if that information is not available.

    • getInstanceName

      @Nullable public String getInstanceName()
      Retrieves the unique name assigned to the server instance.
      Returns:
      The unique name assigned to the server instance, or null if that information is not available.

    • getPrivateNamingContexts

      @Nullable public String[] getPrivateNamingContexts()
      Retrieves the DNs of the private naming contexts, which identify base DNs for content in the server that is not intended to be accessed by normal clients but instead provides some alternate function like administration or monitoring.
      Returns:
      The DNs of the private naming contexts, or null if that information is not available.

    • getStartupUUID

      @Nullable public String getStartupUUID()
      Retrieves a unique identifier that the server generated at startup and can be used to determine whether a server has been restarted.
      Returns:
      The server's startup UUID, or null if that information is not available.

    • getSupportedOTPDeliveryMechanisms

      @Nullable public String[] getSupportedOTPDeliveryMechanisms()
      Retrieves the names of the supported one-time password delivery mechanisms.
      Returns:
      The names of the supported one-time password delivery mechanisms, or null if that information is not available.

    • supportsOTPDeliveryMechanism

      public boolean supportsOTPDeliveryMechanism(@NotNull String mechanismName)
      Indicates whether the directory server indicates that it supports the specified one-time password delivery mechanism.
      Parameters:
      mechanismName - The name of the delivery mechanism for which to make the determination. It must not be null.
      Returns:
      true if the server indicates that it supports the specified one-time password delivery mechanism, or false if it does not.