|
|||||||||
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
public class RootDSE
This class provides a data structure for representing the directory server
root DSE. This entry provides information about the capabilities of the
directory server, server vendor and version information, and published naming
contexts.
Note a root DSE object instance represents a read-only version of an entry,
so all read operations allowed for an entry will succeed, but all write
attempts will be rejected.
com.unboundid.ldap.sdk.controls.ServerSideSortRequestControl
:
RootDSE rootDSE = connection.getRootDSE(); if (rootDSE.supportsControl( ServerSideSortRequestControl.SERVER_SIDE_SORT_REQUEST_OID)) { // The directory server does support the server-side sort control. } else { // The directory server does not support the server-side sort control. }
Field Summary | |
---|---|
static java.lang.String |
ATTR_ALT_SERVER
The name of the attribute that includes a set of URIs (likely in the form of LDAP URLs) of other servers that may be contacted if the target server is unavailable, as defined in RFC 4512 section 5.1. |
static java.lang.String |
ATTR_CHANGELOG_DN
The name of the attribute that specifies the DN that is the base of the LDAP changelog data, if available, as defined in draft-good-ldap-changelog. |
static java.lang.String |
ATTR_FIRST_CHANGE_NUMBER
The name of the attribute that may contain the change number for the first entry in the LDAP changelog. |
static java.lang.String |
ATTR_LAST_CHANGE_NUMBER
The name of the attribute that may contain the change number for the last entry in the LDAP changelog, if available. |
static java.lang.String |
ATTR_LAST_PURGED_CHANGE_NUMBER
The name of the attribute that may contain the change number for the last entry purged from the LDAP changelog, if available. |
static java.lang.String |
ATTR_NAMING_CONTEXT
The name of the attribute that includes the DNs of the public naming contexts defined in the server, as defined in RFC 4512 section 5.1. |
static java.lang.String |
ATTR_SUBSCHEMA_SUBENTRY
The name of the attribute that specifies the DN of the subschema subentry that serves the server root DSE, as defined in RFC 4512 section 4.2. |
static java.lang.String |
ATTR_SUPPORTED_AUTH_PASSWORD_STORAGE_SCHEME
The name of the attribute that includes the names of the supported authentication password storage schemes, as defined in RFC 3112. |
static java.lang.String |
ATTR_SUPPORTED_CONTROL
The name of the attribute that includes the OIDs of the request controls supported by the server, as defined in RFC 4512 section 5.1. |
static java.lang.String |
ATTR_SUPPORTED_EXTENDED_OPERATION
The name of the attribute that includes the OIDs of the extended operations supported by the server, as defined in RFC 4512 section 5.1. |
static java.lang.String |
ATTR_SUPPORTED_FEATURE
The name of the attribute that includes the OIDs of the features supported by the server, as defined in RFC 4512 section 5.1. |
static java.lang.String |
ATTR_SUPPORTED_LDAP_VERSION
The name of the attribute that includes the OIDs of the LDAP protocol versions supported by the server, as defined in RFC 4512 section 5.1. |
static java.lang.String |
ATTR_SUPPORTED_SASL_MECHANISM
The name of the attribute that includes the names of the SASL mechanisms supported by the server, as defined in RFC 4512 section 5.1. |
static java.lang.String |
ATTR_VENDOR_NAME
The name of the attribute that includes the name of the server vendor, as defined in RFC 3045. |
static java.lang.String |
ATTR_VENDOR_VERSION
The name of the attribute that includes the server version, as defined in RFC 3045. |
protected static java.lang.String[] |
REQUEST_ATTRS
The set of request attributes to use when attempting to retrieve the server root DSE. |
Constructor Summary | |
---|---|
RootDSE(Entry rootDSEEntry)
Creates a new root DSE object from the information in the provided entry. |
Method Summary | |
---|---|
java.lang.String[] |
getAltServerURIs()
Retrieves a set of URIs for alternate servers that may be contacted if the current server becomes unavailable. |
java.lang.String |
getChangelogDN()
Retrieves the DN of the base entry for the directory server changelog information, if available. |
java.lang.Long |
getFirstChangeNumber()
Retrieves the change number for the first entry contained in the LDAP changelog, if available. |
java.lang.Long |
getLastChangeNumber()
Retrieves the change number for the last entry contained in the LDAP changelog, if available. |
java.lang.Long |
getLastPurgedChangeNumber()
Retrieves the change number for the last entry purged from the LDAP changelog, if available. |
java.lang.String[] |
getNamingContextDNs()
Retrieves the DNs of the naming contexts provided by the directory server. |
static RootDSE |
getRootDSE(LDAPInterface connection)
Retrieves the directory server root DSE using the provided connection. |
java.lang.String |
getSubschemaSubentryDN()
Retrieves the DN of the subschema subentry that serves the directory server root DSE. |
java.lang.String[] |
getSupportedAuthPasswordSchemeNames()
Retrieves the names of the authentication password storage schemes supported by the server. |
java.lang.String[] |
getSupportedControlOIDs()
Retrieves the OIDs of the supported request controls advertised by the server root DSE. |
java.lang.String[] |
getSupportedExtendedOperationOIDs()
Retrieves the OIDs of the supported extended operations advertised by the server root DSE. |
java.lang.String[] |
getSupportedFeatureOIDs()
Retrieves the OIDs of the supported features advertised by the server root DSE. |
int[] |
getSupportedLDAPVersions()
Retrieves the supported LDAP protocol versions advertised by the server root DSE. |
java.lang.String[] |
getSupportedSASLMechanismNames()
Retrieves the names of the supported SASL mechanisms advertised by the server root DSE. |
java.lang.String |
getVendorName()
Retrieves the name of the directory server vendor, if available. |
java.lang.String |
getVendorVersion()
Retrieves the directory server version string, if available. |
boolean |
supportsAuthPasswordScheme(java.lang.String scheme)
Indicates whether the directory server indicates that it supports the specified authentication password storage scheme. |
boolean |
supportsControl(java.lang.String controlOID)
Indicates whether the directory server indicates that it supports the request control with the provided OID. |
boolean |
supportsExtendedOperation(java.lang.String extendedOperationOID)
Indicates whether the directory server indicates that it supports the extended operation with the provided OID. |
boolean |
supportsFeature(java.lang.String featureOID)
Indicates whether the directory server indicates that it supports the extended operation with the provided OID. |
boolean |
supportsLDAPVersion(int ldapVersion)
Indicates whether the directory server indicates that it supports the provided LDAP protocol version. |
boolean |
supportsSASLMechanism(java.lang.String mechanismName)
Indicates whether the directory server indicates that it supports the specified SASL 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_ALT_SERVER
public static final java.lang.String ATTR_CHANGELOG_DN
public static final java.lang.String ATTR_FIRST_CHANGE_NUMBER
public static final java.lang.String ATTR_LAST_CHANGE_NUMBER
public static final java.lang.String ATTR_LAST_PURGED_CHANGE_NUMBER
public static final java.lang.String ATTR_NAMING_CONTEXT
public static final java.lang.String ATTR_SUBSCHEMA_SUBENTRY
public static final java.lang.String ATTR_SUPPORTED_AUTH_PASSWORD_STORAGE_SCHEME
public static final java.lang.String ATTR_SUPPORTED_CONTROL
public static final java.lang.String ATTR_SUPPORTED_EXTENDED_OPERATION
public static final java.lang.String ATTR_SUPPORTED_FEATURE
public static final java.lang.String ATTR_SUPPORTED_LDAP_VERSION
public static final java.lang.String ATTR_SUPPORTED_SASL_MECHANISM
public static final java.lang.String ATTR_VENDOR_NAME
public static final java.lang.String ATTR_VENDOR_VERSION
protected static final java.lang.String[] REQUEST_ATTRS
Constructor Detail |
---|
public RootDSE(Entry rootDSEEntry)
rootDSEEntry
- The entry to use to create this root DSE object. It
must not be null
.Method Detail |
---|
public static RootDSE 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 final java.lang.String[] getAltServerURIs()
null
if the server
does not publish that information.public final java.lang.String getChangelogDN()
null
if the server does not publish that
information or no changelog is available.public final java.lang.Long getFirstChangeNumber()
public final java.lang.Long getLastChangeNumber()
public final java.lang.Long getLastPurgedChangeNumber()
public final java.lang.String[] getNamingContextDNs()
null
if the server does not publish that information.public final java.lang.String getSubschemaSubentryDN()
null
if the server does not publish that
information.public final java.lang.String[] getSupportedAuthPasswordSchemeNames()
null
if the server does not publish
that information.public final boolean supportsAuthPasswordScheme(java.lang.String scheme)
scheme
- The name of the authentication password storage scheme for
which to make the determination. It must not be
null
.
true
if the directory server indicates that it supports
the specified authentication password storage scheme, or
false
if it does not.public final java.lang.String[] getSupportedControlOIDs()
null
if the server does not publish
that information.public final boolean supportsControl(java.lang.String controlOID)
controlOID
- The OID of the control for which to make the
determination. It must not be null
.
true
if the server indicates that it supports the request
control with the specified OID, or false
if it does not.public final java.lang.String[] getSupportedExtendedOperationOIDs()
null
if the server does not publish
that information.public final boolean supportsExtendedOperation(java.lang.String extendedOperationOID)
extendedOperationOID
- The OID of the extended operation for which
to make the determination. It must not be
null
.
true
if the server indicates that it supports the extended
operation with the specified OID, or false
if it does not.public final java.lang.String[] getSupportedFeatureOIDs()
null
if the server does not publish that
information.public final boolean supportsFeature(java.lang.String featureOID)
featureOID
- The OID of the feature for which to make the
determination. It must not be null
.
true
if the server indicates that it supports the feature
with the specified OID, or false
if it does not.public final int[] getSupportedLDAPVersions()
null
if the server does not publish that
information.public final boolean supportsLDAPVersion(int ldapVersion)
ldapVersion
- The LDAP protocol version for which to make the
determination.
true
if the server indicates that it supports the
specified LDAP protocol version, or false
if it does not.public final java.lang.String[] getSupportedSASLMechanismNames()
null
if the server does not publish
that information.public final boolean supportsSASLMechanism(java.lang.String mechanismName)
mechanismName
- The name of the SASL mechanism for which to make the
determination. It must not be null
.
true
if the server indicates that it supports the
specified SASL mechanism, or false
if it does not.public final java.lang.String getVendorName()
null
if the
server does not publish that information.public final java.lang.String getVendorVersion()
null
if the server
does not publish that information.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |