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, java.io.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:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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.

Fields inherited from class com.unboundid.ldap.sdk.RootDSE

ATTR_ALT_SERVER, ATTR_CHANGELOG_DN, ATTR_FIRST_CHANGE_NUMBER, ATTR_LAST_CHANGE_NUMBER, ATTR_LAST_PURGED_CHANGE_NUMBER, ATTR_NAMING_CONTEXT, ATTR_SUBSCHEMA_SUBENTRY, ATTR_SUPPORTED_AUTH_PASSWORD_STORAGE_SCHEME, ATTR_SUPPORTED_CONTROL, ATTR_SUPPORTED_EXTENDED_OPERATION, ATTR_SUPPORTED_FEATURE, ATTR_SUPPORTED_LDAP_VERSION, ATTR_SUPPORTED_SASL_MECHANISM, ATTR_VENDOR_NAME, ATTR_VENDOR_VERSION

Constructor Summary

Constructors

Constructor and Description
UnboundIDRootDSE(Entry rootDSEEntry) Creates a new UnboundID root DSE object from the information in the provided entry.

Method Summary

Modifier and Type	Method and Description
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.RootDSE

getAltServerURIs, getChangelogDN, getFirstChangeNumber, getLastChangeNumber, getLastPurgedChangeNumber, getNamingContextDNs, getSubschemaSubentryDN, getSupportedAuthPasswordSchemeNames, getSupportedControlOIDs, getSupportedExtendedOperationOIDs, getSupportedFeatureOIDs, getSupportedLDAPVersions, getSupportedSASLMechanismNames, getVendorName, getVendorVersion, supportsAuthPasswordScheme, supportsControl, supportsExtendedOperation, supportsFeature, supportsLDAPVersion, supportsSASLMechanism

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 com.unboundid.ldap.sdk.Entry

addAttribute, applyModifications, applyModifications, applyModifyDN, applyModifyDN, diff, diff, diff, duplicate, equals, getAttribute, getAttribute, getAttributes, getAttributesWithOptions, getAttributeValue, getAttributeValueAsBoolean, getAttributeValueAsDate, getAttributeValueAsDN, getAttributeValueAsInteger, getAttributeValueAsLong, getAttributeValueByteArrays, getAttributeValueBytes, getAttributeValues, getDN, getObjectClassAttribute, getObjectClassValues, getParentDN, getParentDNString, getParsedDN, getRDN, getSchema, hasAttribute, hasAttribute, hasAttribute, hasAttributeValue, hasAttributeValue, hasAttributeValue, hasAttributeValue, hashCode, hasObjectClass, intersectEntries, matchesBaseAndScope, matchesBaseAndScope, mergeEntries, removeAttributeValue, removeAttributeValue, setAttribute, toLDIF, toLDIF, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toLDIFString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ATTR_BASELINE_CONFIG_DIGEST

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

See Also:

Constant Field Values

ATTR_CONFIG_MODEL_DIGEST

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

See Also:

Constant Field Values

ATTR_INSTANCE_NAME

@NotNull
public static final java.lang.String ATTR_INSTANCE_NAME

The name of the attribute that provides a the unique instance name for the server instance.

See Also:

Constant Field Values

ATTR_PRIVATE_NAMING_CONTEXTS

@NotNull
public static final 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. These are base DNs that provide some content in the UnboundID server, but do not house user-provided data that is expected to be accessed by normal clients.

See Also:

Constant Field Values

ATTR_STARTUP_UUID

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

See Also:

Constant Field Values

ATTR_SUPPORTED_OTP_DELIVERY_MECHANISM

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

See Also:

Constant Field Values

Constructor Detail

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 Detail

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 java.lang.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 java.lang.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 java.lang.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 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.

Returns:

The DNs of the private naming contexts, or null if that information is not available.

getStartupUUID

@Nullable
public 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.

Returns:

The server's startup UUID, or null if that information is not available.

getSupportedOTPDeliveryMechanisms

@Nullable
public java.lang.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
                                            java.lang.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.