Uses of Class
org.forgerock.opendj.ldap.Dn

Packages that use Dn

Package	Description
org.forgerock.openam.ldap	This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
org.forgerock.opendj.ldap	Classes and interfaces for core types including connections, entries, and attributes.
org.forgerock.opendj.ldap.controls	Classes and interfaces for common LDAP controls.
org.forgerock.opendj.ldap.messages	Classes and interfaces for core LDAP requests/responses.
org.forgerock.opendj.ldap.schema	Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.
org.forgerock.opendj.security	An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based KeyStore service.

Uses of Dn in org.forgerock.openam.ldap

Methods in org.forgerock.openam.ldap that return Dn

Modifier and Type	Method and Description
static Dn	LDAPUtils.newDN(String orgName) Creates a DN from the specified DN string.

Methods in org.forgerock.openam.ldap with parameters of type Dn

Modifier and Type	Method and Description
static Set<String>	LDAPUtils.collectNonIdenticalValues(Dn compare, Set<String> dns) Returns a set of all the non-root DNs from the collection that are not equal to the compare parameter.
static String	LDAPUtils.getName(Dn dn) Returns the RDN without the attribute name from the passed in Dn object, for example: uid=demo,ou=people,dc=example,dc=com will return demo.
static String	LDAPUtils.rdnTypeFromDn(Dn dn) When provided a DN, returns the attribute type name of the first RDN.
static String	LDAPUtils.rdnValueFromDn(Dn dn) When provided a DN, returns the value part of the first RDN.

Uses of Dn in org.forgerock.opendj.ldap

Fields in org.forgerock.opendj.ldap with type parameters of type Dn

Modifier and Type	Field and Description
static Option<Collection<Dn>>	LdapClients.LOAD_BALANCER_PARTITION_BASE_DNS Specifies partition base DNs.

Methods in org.forgerock.opendj.ldap that return Dn

Modifier and Type	Method and Description
Dn	AttributeParser.asDn() Returns the first value decoded as a DN using the schema associated with this parser, or null if the attribute does not contain any values.
Dn	AttributeParser.asDn(Dn defaultValue) Returns the first value decoded as a DN using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
Dn	AttributeParser.asDn(String defaultValue) Returns the first value decoded as a DN using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
Dn	Dn.child(Dn dn) Returns a DN which is subordinate to this DN and having the additional RDN components contained in the provided DN.
Dn	Dn.child(Rdn rdn) Returns a DN which is an immediate child of this DN and having the specified RDN.
Dn	Dn.child(String dn) Returns a DN which is subordinate to this DN and having the additional RDN components contained in the provided DN decoded using the default schema.
Dn	Dn.child(String attributeType, Object attributeValue) Returns a DN which is an immediate child of this DN and with an RDN having the provided attribute type and value decoded using the default schema.
static Dn	Dn.emptyDn() Returns the empty DN.
static Dn	Dn.format(String template, Object... attributeValues) Creates a new DN using the provided DN template and unescaped attribute values using the default schema.
static Dn	Dn.format(String template, Schema schema, Object... attributeValues) Creates a new DN using the provided DN template and unescaped attribute values using the provided schema.
Dn	LdapUrl.getName() Returns the distinguished name of the base entry relative to which the search is to be performed.
Dn	Entry.getName() Returns the string representation of the distinguished name of this entry.
Dn	Entries.NullEntry.getName()
Dn	AbstractMapEntry.getName()
Dn	RootDse.getSubschemaSubentry() Returns a string which represents the DN of the subschema subentry holding the schema controlling the Root DSE.
Dn	Dn.localName(int index) Returns the DN whose content is the specified number of RDNs from this DN.
Dn	Dn.parent() Returns the DN which is the immediate parent of this DN, or null if this DN is the Root DN.
Dn	Dn.parent(int index) Returns the DN which is equal to this DN with the specified number of RDNs removed.
Dn	Dn.rename(Dn fromDN, Dn toDN) Returns a copy of this DN whose parent DN, fromDN, has been renamed to the new parent DN, toDN.
Dn	Dn.rename(Rdn newRdn, Dn newSuperior) Returns a DN whose value is the result of applying LDAP modify DN semantics to this DN.
static Dn	Dn.rootDn() Deprecated. use Dn.emptyDn() instead
static Dn	Dn.valueOf(ByteString dn) Parses the provided LDAP string representation of a DN using the default schema.
static Dn	Dn.valueOf(String dn) Parses the provided LDAP string representation of a DN using the default schema.
static Dn	Dn.valueOf(String dn, Schema schema) Parses the provided LDAP string representation of a DN using the provided schema.

Methods in org.forgerock.opendj.ldap that return types with arguments of type Dn

Modifier and Type	Method and Description
Set<Dn>	AttributeParser.asSetOfDn() Returns the values decoded as a set of DNs using the schema associated with this parser, or an empty set if the attribute does not contain any values.
Set<Dn>	AttributeParser.asSetOfDn(Collection<Dn> defaultValues) Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
Set<Dn>	AttributeParser.asSetOfDn(Dn... defaultValues) Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
Set<Dn>	AttributeParser.asSetOfDn(String... defaultValues) Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
static Function<ByteString,Dn,org.forgerock.i18n.LocalizedIllegalArgumentException>	Functions.byteStringToDn() Returns a function which parses DNs using the default schema.
static Function<ByteString,Dn,org.forgerock.i18n.LocalizedIllegalArgumentException>	Functions.byteStringToDn(Schema schema) Returns a function which parses DNs using the provided schema.
Function<Dn,Entry>	DecodeOptions.getEntryFactory() Returns the function which will be used for creating new Entry instances when decoding entries.
Collection<Dn>	RootDse.getNamingContexts() Returns an unmodifiable list of DNs identifying the context prefixes of the naming contexts that the Directory Server masters or shadows (in part or in whole).

Methods in org.forgerock.opendj.ldap with parameters of type Dn

Modifier and Type	Method and Description
Dn	AttributeParser.asDn(Dn defaultValue) Returns the first value decoded as a DN using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
Set<Dn>	AttributeParser.asSetOfDn(Dn... defaultValues) Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
Dn	Dn.child(Dn dn) Returns a DN which is subordinate to this DN and having the additional RDN components contained in the provided DN.
int	Dn.compareTo(Dn dn)
boolean	MemoryBackend.contains(Dn dn) Returns true if the named entry exists in this memory backend.
default Result	Connection.delete(Dn name) Deletes the named entry from the Directory Server.
Entry	MemoryBackend.get(Dn dn) Returns a deep copy of the named entry contained in this memory backend, or null if it does not exist.
boolean	MemoryBackend.hasSubordinates(Dn dn) Returns true if the named entry exists and has at least one child entry.
boolean	Dn.isChildOf(Dn dn) Returns true if this DN is an immediate child of the provided DN.
boolean	Dn.isInScopeOf(Dn dn, SearchScope scope) Returns true if this DN matches the provided base DN and search scope.
boolean	Dn.isParentOf(Dn dn) Returns true if this DN is the immediate parent of the provided DN.
boolean	Dn.isSubordinateOrEqualTo(Dn dn) Returns true if this DN is subordinate to or equal to the provided DN.
boolean	Dn.isSubordinateTo(Dn dn) Returns true if this DN is subordinate to, but not equal to the provided DN.
boolean	Dn.isSuperiorOrEqualTo(Dn dn) Returns true if this DN is superior to or equal to the provided DN.
boolean	Dn.isSuperiorTo(Dn dn) Returns true if this DN is superior to, but not equal to the provided DN.
static LdapException	LdapException.newLdapException(ResultCode resultCode, CharSequence diagnosticMessage, Dn matchedDn, Throwable cause) Creates a new LDAP exception with the provided resultCode, diagnosticMessage, matched DN and cause.
static Entry	Entries.nullEntry(Dn dn) Returns a read-only empty entry having the provided distinguished name.
int	MemoryBackend.numSubordinates(Dn dn) Returns the number of entries which are immediately subordinate to the named entry, or 0 if the named entry does not exist.
default io.reactivex.Single<SearchResultEntry>	LdapClientSocket.readEntry(Dn name, String... attributeDescriptions) Reads the named entry from the Directory Server.
SearchResultEntry	Connection.readEntry(Dn name, String... attributeDescriptions) Reads the named entry from the Directory Server.
SearchResultEntry	AbstractConnectionWrapper.readEntry(Dn name, String... attributeDescriptions) Reads the named entry from the Directory Server.
SearchResultEntry	AbstractConnection.readEntry(Dn baseObject, String... attributeDescriptions)
LdapPromise<SearchResultEntry>	Connection.readEntryAsync(Dn name, Collection<String> attributeDescriptions) Asynchronously reads the named entry from the Directory Server.
LdapPromise<SearchResultEntry>	AbstractConnectionWrapper.readEntryAsync(Dn name, Collection<String> attributeDescriptions) Asynchronously reads the named entry from the Directory Server.
LdapPromise<SearchResultEntry>	AbstractConnection.readEntryAsync(Dn name, Collection<String> attributeDescriptions)
Dn	Dn.rename(Dn fromDN, Dn toDN) Returns a copy of this DN whose parent DN, fromDN, has been renamed to the new parent DN, toDN.
Dn	Dn.rename(Rdn newRdn, Dn newSuperior) Returns a DN whose value is the result of applying LDAP modify DN semantics to this DN.
Entry	Entry.setName(Dn dn) Sets the distinguished name of this entry (optional operation).
Entry	Entries.NullEntry.setName(Dn dn)
Entry	AbstractMapEntry.setName(Dn dn)

Method parameters in org.forgerock.opendj.ldap with type arguments of type Dn

Modifier and Type	Method and Description
Set<Dn>	AttributeParser.asSetOfDn(Collection<Dn> defaultValues) Returns the values decoded as a set of DNs using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
static LdapClient	LdapClients.newFixedSizeDistributionLoadBalancer(Set<Dn> partitionBaseDns, ConsistentHashMap<? extends LdapClient> partitions, Options options) Creates a distribution load balancer which uses consistent hashing to distributes requests across a set of partitions based on a hash of each request's target DN.
DecodeOptions	DecodeOptions.setEntryFactory(Function<Dn,Entry> factory) Sets the function which will be used for creating new Entry instances when decoding entries.

Constructors in org.forgerock.opendj.ldap with parameters of type Dn

Constructor and Description
AbstractMapEntry(Dn name, M attributes) Creates an empty entry using the provided distinguished name and Map.
LdapUrl(boolean isSecured, String host, Integer port, Dn name) Creates a new LDAP URL referring to a single entry on the specified server.
LdapUrl(boolean isSecured, String host, Integer port, Dn name, SearchScope scope, Filter filter, String... attributes) Creates a new LDAP URL including the full set of parameters for a search request.
LinkedHashMapEntry(Dn name) Creates an empty entry using the provided distinguished name and no attributes.
TreeMapEntry(Dn name) Creates an empty entry using the provided distinguished name and no attributes.

Uses of Dn in org.forgerock.opendj.ldap.controls

Methods in org.forgerock.opendj.ldap.controls that return Dn

Modifier and Type	Method and Description
Dn	ProxiedAuthV1RequestControl.getAuthorizationDnName() Returns the distinguished name of the user whose authorization is to be used when performing the operation.
Dn	GetEffectiveRightsRequestControl.getAuthorizationName() Returns the distinguished name of the user for which effective rights are to be returned, or null if the client's authentication ID is to be used.
Dn	EntryChangeNotificationResponseControl.getPreviousName() Returns the distinguished name that the entry had prior to a modify DN operation, or null if the operation was not a modify DN.

Methods in org.forgerock.opendj.ldap.controls with parameters of type Dn

Modifier and Type	Method and Description
static GetEffectiveRightsRequestControl	GetEffectiveRightsRequestControl.newControl(boolean isCritical, Dn authorizationName, Collection<AttributeType> attributes) Creates a new get effective rights request control with the provided criticality, optional authorization name and attribute list.
static ProxiedAuthV1RequestControl	ProxiedAuthV1RequestControl.newControl(Dn authorizationName) Creates a new proxy authorization v1 request control with the provided authorization name.
static AuthorizationIdentityResponseControl	AuthorizationIdentityResponseControl.newControl(Dn authorizationDn) Creates a new authorization identity response control using the provided authorization ID.
static EntryChangeNotificationResponseControl	EntryChangeNotificationResponseControl.newControl(PersistentSearchChangeType type, Dn previousName, long changeNumber) Creates a new entry change notification response control with the provided change type and optional previous distinguished name and change number.

Uses of Dn in org.forgerock.opendj.ldap.messages

Methods in org.forgerock.opendj.ldap.messages that return Dn

Modifier and Type	Method and Description
static Dn	Requests.dnOfRequest(Request request) Returns the DN of the entry targeted by the provided request, or null if the target entry cannot be determined.
Dn	SearchResultEntry.getName()
Dn	SearchRequest.getName() Returns the distinguished name of the base entry relative to which the search is to be performed.
Dn	ModifyRequest.getName() Returns the distinguished name of the entry to be modified.
Dn	ModifyDnRequest.getName() Returns the distinguished name of the entry to be renamed.
Dn	DeleteRequest.getName() Returns the distinguished name of the entry to be deleted.
Dn	CompareRequest.getName() Returns the distinguished name of the entry to be compared.
Dn	BindRequest.getName() Returns the name of the Directory object that the client wishes to bind as.
Dn	AddRequest.getName()
Dn	ModifyDnRequest.getNewSuperior() Returns the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.

Methods in org.forgerock.opendj.ldap.messages with parameters of type Dn

Modifier and Type	Method and Description
static AddRequest	Requests.newAddRequest(Dn name) Creates a new add request using the provided distinguished name.
static CompareRequest	Requests.newCompareRequest(Dn name, AttributeDescription attributeDescription, Object assertionValue) Creates a new compare request using the provided distinguished name, attribute name, and assertion value.
static DeleteRequest	Requests.newDeleteRequest(Dn name) Creates a new delete request using the provided distinguished name.
static ModifyDnRequest	Requests.newModifyDnRequest(Dn name, Rdn newRDN) Creates a new modify DN request using the provided distinguished name and new RDN.
static ModifyRequest	Requests.newModifyRequest(Dn name) Creates a new modify request using the provided distinguished name.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope) Creates a new search request using the provided distinguished name and scope.
static SearchRequest	Requests.newSearchRequest(Dn name, SearchScope scope, Filter filter, String... attributeDescriptions) Creates a new search request using the provided distinguished name, scope, and filter.
static SearchResultEntry	Responses.newSearchResultEntry(Dn name) Creates a new search result entry using the provided distinguished name.
static BindRequest	Requests.newSimpleBindRequest(Dn name, byte[] password) Creates a new simple bind request having the provided name and password suitable for name/password authentication.
static BindRequest	Requests.newSimpleBindRequest(Dn name, char[] password) Creates a new simple bind request having the provided name and password suitable for name/password authentication.
static BindRequest	Requests.newSimpleBindRequest(Dn name, String password) Creates a new simple bind request having the provided name and password suitable for name/password authentication.
static SearchRequest	Requests.newSingleEntrySearchRequest(Dn name, SearchScope scope, Filter filter, String... attributeDescriptions) Creates a new search request for a single entry, using the provided distinguished name, scope, and filter.
WhoAmIExtendedResult	WhoAmIExtendedResult.setMatchedDn(Dn dn)
Result	Result.setMatchedDn(Dn dn) Sets the matched DN associated with this result.
PasswordModifyExtendedResult	PasswordModifyExtendedResult.setMatchedDn(Dn dn)
GenericExtendedResult	GenericExtendedResult.setMatchedDn(Dn dn)
ExtendedResult	ExtendedResult.setMatchedDn(Dn dn)
CompareResult	CompareResult.setMatchedDn(Dn dn)
BindResult	BindResult.setMatchedDn(Dn dn)
SearchResultEntry	SearchResultEntry.setName(Dn dn)
SearchRequest	SearchRequest.setName(Dn dn) Sets the distinguished name of the base entry relative to which the search is to be performed.
ModifyRequest	ModifyRequest.setName(Dn dn) Sets the distinguished name of the entry to be modified.
ModifyDnRequest	ModifyDnRequest.setName(Dn dn) Sets the distinguished name of the entry to be renamed.
DeleteRequest	DeleteRequest.setName(Dn dn) Sets the distinguished name of the entry to be deleted.
CompareRequest	CompareRequest.setName(Dn dn) Sets the distinguished name of the entry to be compared.
BindRequest	BindRequest.setName(Dn name) Sets the name of the Directory object that the client wishes to bind as.
AddRequest	AddRequest.setName(Dn dn)
ModifyDnRequest	ModifyDnRequest.setNewSuperior(Dn dn) Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.

Uses of Dn in org.forgerock.opendj.ldap.schema

Methods in org.forgerock.opendj.ldap.schema that return types with arguments of type Dn

Modifier and Type	Method and Description
Function<Dn,Entry,LdapException>	SchemaValidationPolicy.checkDitStructureRulesParentEntryResolver() Returns the parent entry resolver which should be used for retrieving the parent entry during DIT structure rule validation.

Methods in org.forgerock.opendj.ldap.schema with parameters of type Dn

Modifier and Type	Method and Description
SchemaBuilder	SchemaBuilder.addSchema(Connection connection, Dn name, boolean overwrite) Reads the schema elements contained in the named subschema sub-entry and adds them to this schema builder.
io.reactivex.Single<SchemaBuilder>	SchemaBuilder.addSchema(LdapClientSocket socket, Dn name, boolean overwrite) Reads the schema elements contained in the named subschema sub-entry and adds them to this schema builder.
LdapPromise<SchemaBuilder>	SchemaBuilder.addSchemaAsync(Connection connection, Dn name, boolean overwrite) Asynchronously reads the schema elements contained in the named subschema sub-entry and adds them to this schema builder.
SchemaBuilder	SchemaBuilder.addSchemaForEntry(Connection connection, Dn name, boolean overwrite) Reads the schema elements contained in the subschema sub-entry which applies to the named entry and adds them to this schema builder.
io.reactivex.Single<SchemaBuilder>	SchemaBuilder.addSchemaForEntry(LdapClientSocket socket, Dn name, boolean overwrite) Reads the schema elements contained in the subschema sub-entry which applies to the named entry and adds them to this schema builder.
LdapPromise<SchemaBuilder>	SchemaBuilder.addSchemaForEntryAsync(Connection connection, Dn name, boolean overwrite) Asynchronously reads the schema elements contained in the subschema sub-entry which applies to the named entry and adds them to this schema builder.
static Schema	Schema.readSchema(Connection connection, Dn name) Reads the schema contained in the named subschema sub-entry.
static io.reactivex.Single<Schema>	Schema.readSchema(LdapClientSocket socket, Dn name) Reads the schema contained in the named subschema sub-entry.
static LdapPromise<Schema>	Schema.readSchemaAsync(Connection connection, Dn name) Asynchronously reads the schema contained in the named subschema sub-entry.
static Schema	Schema.readSchemaForEntry(Connection connection, Dn name) Reads the schema contained in the subschema sub-entry which applies to the named entry.
static io.reactivex.Single<Schema>	Schema.readSchemaForEntry(LdapClientSocket socket, Dn name) Reads the schema contained in the subschema sub-entry which applies to the named entry.
static LdapPromise<Schema>	Schema.readSchemaForEntryAsync(Connection connection, Dn name) Asynchronously reads the schema contained in the subschema sub-entry which applies to the named entry.

Method parameters in org.forgerock.opendj.ldap.schema with type arguments of type Dn

Modifier and Type	Method and Description
SchemaValidationPolicy	SchemaValidationPolicy.checkDitStructureRules(SchemaValidationPolicy.Action policy, Function<Dn,Entry,LdapException> parentEntryResolver) Specifies the policy for validating entries against structure rules defined in the schema.

Uses of Dn in org.forgerock.opendj.ldif

Methods in org.forgerock.opendj.ldif that return Dn

Modifier and Type	Method and Description
Dn	ChangeRecord.getName() Returns the distinguished name of the entry being modified by this ChangeRecord.

Methods in org.forgerock.opendj.ldif with parameters of type Dn

Modifier and Type	Method and Description
LdifEntryWriter	LdifEntryWriter.setExcludeBranch(Dn excludeBranch) Excludes all entries beneath the named entry (inclusive) from being written to LDIF.
LdifEntryReader	LdifEntryReader.setExcludeBranch(Dn excludeBranch) Excludes all entries beneath the named entry (inclusive) from being read from LDIF.
LdifChangeRecordWriter	LdifChangeRecordWriter.setExcludeBranch(Dn excludeBranch) Excludes all change records which target entries beneath the named entry (inclusive) from being written to LDIF.
LdifChangeRecordReader	LdifChangeRecordReader.setExcludeBranch(Dn excludeBranch) Excludes all change records which target entries beneath the named entry (inclusive) from being read from LDIF.
LdifEntryWriter	LdifEntryWriter.setIncludeBranch(Dn includeBranch) Ensures that all entries beneath the named entry (inclusive) are written to LDIF.
LdifEntryReader	LdifEntryReader.setIncludeBranch(Dn includeBranch) Ensures that all entries beneath the named entry (inclusive) are read from LDIF.
LdifChangeRecordWriter	LdifChangeRecordWriter.setIncludeBranch(Dn includeBranch) Ensures that all change records which target entries beneath the named entry (inclusive) are written to LDIF.
LdifChangeRecordReader	LdifChangeRecordReader.setIncludeBranch(Dn includeBranch) Ensures that all change records which target entries beneath the named entry (inclusive) are read from LDIF.
ChangeRecord	ChangeRecord.setName(Dn dn) Sets the distinguished name of the entry to be updated.

Uses of Dn in org.forgerock.opendj.security

Methods in org.forgerock.opendj.security with parameters of type Dn

Modifier and Type	Method and Description
static KeyStoreParameters	KeyStoreParameters.newKeyStoreParameters(ConnectionFactory factory, Dn baseDN) Creates a set of LDAP key store parameters with default options.
static KeyStoreParameters	KeyStoreParameters.newKeyStoreParameters(ConnectionFactory factory, Dn baseDN, Options options) Creates a set of LDAP key store parameters with custom options.
static KeyStore	OpenDjSecurityProvider.newLdapKeyStore(ConnectionFactory factory, Dn baseDN) Creates a new LDAP key store with default options.
static KeyStore	OpenDjSecurityProvider.newLdapKeyStore(ConnectionFactory factory, Dn baseDN, Options options) Creates a new LDAP key store with custom options.
static KeyStore	OpenDjSecurityProvider.newLdifKeyStore(File ldifFile, Dn baseDN) Creates a new LDIF based key store which will read and write key store objects to the provided key store file.
static KeyStore	OpenDjSecurityProvider.newLdifKeyStore(File ldifFile, Dn baseDN, Options options) Creates a new LDIF based key store which will read and write key store objects to the provided key store file.