|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.Entry
com.unboundid.ldap.sdk.ReadOnlyEntry
com.unboundid.ldap.sdk.RootDSE
com.unboundid.ldap.sdk.unboundidds.UnboundIDRootDSE
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class UnboundIDRootDSE
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 provides an enhanced implementation of the
RootDSE
class
that provides access to additional attributes that may be included in the
root DSE of an UnboundID server.
Field Summary | |
---|---|
static java.lang.String |
ATTR_BASELINE_CONFIG_DIGEST
The name of the attribute that provides a digest of the base configuration for the software version the server is currently running. |
static java.lang.String |
ATTR_CONFIG_MODEL_DIGEST
The name of the attribute that provides a digest of the configuration model for the software version the server is currently running. |
static java.lang.String |
ATTR_INSTANCE_NAME
The name of the attribute that provides a the unique instance name for the server instance. |
static java.lang.String |
ATTR_PRIVATE_NAMING_CONTEXTS
The name of the attribute that includes the DNs of the private naming contexts defined in the server. |
static java.lang.String |
ATTR_STARTUP_UUID
The name of the attribute that includes unique identifier generated at server startup, and can be used to determine whether an instance has been restarted. |
static java.lang.String |
ATTR_SUPPORTED_OTP_DELIVERY_MECHANISM
The name of the attribute that includes the one-time password delivery mechanisms supported for use in the server. |
Constructor Summary | |
---|---|
UnboundIDRootDSE(Entry rootDSEEntry)
Creates a new UnboundID root DSE object from the information in the provided entry. |
Method Summary | |
---|---|
java.lang.String |
getBaselineConfigurationDigest()
Retrieves a digest of the baseline configuration for the software version the server is currently running. |
java.lang.String |
getConfigurationModelDigest()
Retrieves a digest of the configuration model for the software version the server is currently running. |
java.lang.String |
getInstanceName()
Retrieves the unique name assigned to the server instance. |
java.lang.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. |
static UnboundIDRootDSE |
getRootDSE(LDAPInterface connection)
Retrieves the root DSE from an UnboundID server using the provided connection. |
java.lang.String |
getStartupUUID()
Retrieves a unique identifier that the server generated at startup and can be used to determine whether a server has been restarted. |
java.lang.String[] |
getSupportedOTPDeliveryMechanisms()
Retrieves the names of the supported one-time password delivery mechanisms. |
boolean |
supportsOTPDeliveryMechanism(java.lang.String mechanismName)
Indicates whether the directory server indicates that it supports the specified one-time password delivery mechanism. |
Methods inherited from class com.unboundid.ldap.sdk.ReadOnlyEntry |
---|
addAttribute, addAttribute, addAttribute, addAttribute, addAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeAttributeValues, removeAttributeValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setDN, setDN |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATTR_BASELINE_CONFIG_DIGEST
public static final java.lang.String ATTR_CONFIG_MODEL_DIGEST
public static final java.lang.String ATTR_INSTANCE_NAME
public static final java.lang.String ATTR_PRIVATE_NAMING_CONTEXTS
public static final java.lang.String ATTR_STARTUP_UUID
public static final java.lang.String ATTR_SUPPORTED_OTP_DELIVERY_MECHANISM
Constructor Detail |
---|
public UnboundIDRootDSE(Entry rootDSEEntry)
rootDSEEntry
- The entry to use to create this UnboundID root DSE
object. It must not be null
.Method Detail |
---|
public static UnboundIDRootDSE getRootDSE(LDAPInterface connection) throws LDAPException
connection
- The connection to use to retrieve the server root DSE.
null
if it is not
available (e.g., the client does not have permission to read the
entry).
LDAPException
- If a problem occurs while attempting to retrieve
the server root DSE.public java.lang.String getBaselineConfigurationDigest()
null
if
that information is not available.public java.lang.String getConfigurationModelDigest()
null
if that
information is not available.public java.lang.String getInstanceName()
null
if that information is not available.public java.lang.String[] getPrivateNamingContexts()
null
if that
information is not available.public java.lang.String getStartupUUID()
null
if that information is
not available.public java.lang.String[] getSupportedOTPDeliveryMechanisms()
null
if that information is not available.public boolean supportsOTPDeliveryMechanism(java.lang.String mechanismName)
mechanismName
- The name of the delivery mechanism for which to make
the determination. It must not be null
.
true
if the server indicates that it supports the
specified one-time password delivery mechanism, or false
if it does not.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |