Uses of Class
org.forgerock.opendj.ldap.Dn
Package
Description
This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
Contains the Service Discovery Mechanisms and APIs.
Classes and interfaces providing I/O functionality.
Classes and interfaces for core types including connections, entries, and
attributes.
Classes and interfaces for common LDAP controls.
Classes and interfaces for core LDAP requests/responses.
Classes and interfaces for constructing and querying LDAP schemas.
Classes and interfaces for reading and writing LDIF.
An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based
KeyStore
service.-
Uses of Dn in org.forgerock.am.identity.domain
Modifier and TypeMethodDescriptionstatic boolean
UniversalId.isUniversalIdOrSpecialUserDn
(Dn dn) Check if dn is a universalId or a special user dn.static UniversalId
Creates a newUniversalId
instance based of the passed individual parts that represent a unique identity.static UniversalId
Creates a newUniversalId
instance based of the passed universal ID. -
Uses of Dn in org.forgerock.openam.ldap
Modifier and TypeMethodDescriptionLDAPUtils.collectNonIdenticalValues
(Dn compare, Set<String> dns) Returns a set of all the non-root DNs from the collection that are not equal to thecompare
parameter.static String
Returns the RDN without the attribute name from the passed inDn
object, for example:uid=demo,ou=people,dc=example,dc=com
will returndemo
.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.discovery
Modifier and TypeMethodDescriptionReplicationServiceDiscoveryMechanism.getPartition
(Collection<Dn> baseDNs) ServiceDiscoveryMechanism.getPartition
(Collection<Dn> baseDNs) Returns the partition.StaticServiceDiscoveryMechanism.getPartition
(Collection<Dn> baseDns) -
Uses of Dn in org.forgerock.opendj.io
Modifier and TypeMethodDescriptionReads the next element as a distinguished name having the provided type tag.Reads the next element as a distinguished name having the Universal Sequence ASN.1 type tag.Modifier and TypeMethodDescriptionWrites the X.501 type Name as an RDN sequence with the provided type tag.Writes the X.501 type Name as an RDN sequence. -
Uses of Dn in org.forgerock.opendj.ldap
Modifier and TypeFieldDescriptionstatic final Option<Collection<Dn>>
LdapClients.LOAD_BALANCER_BASE_DNS
Specifies the base DN(s) for the data that the ldap service handles.LdapClients.LOAD_BALANCER_PARTITION_BASE_DNS
Specifies partition base DNs.Modifier and TypeMethodDescriptionAttributeParser.asDn()
Returns the first value decoded as aDN
using the schema associated with this parser, ornull
if the attribute does not contain any values.Returns the first value decoded as aDN
using the schema associated with this parser, ordefaultValue
if the attribute does not contain any values.Returns the first value decoded as aDN
using the schema associated with this parser, ordefaultValue
if the attribute does not contain any values.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.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.Returns a DN which is subordinate to this DN and having the additional RDN components contained in the provided DN.Returns a DN which is an immediate child of this DN and having the specified RDN.static Dn
Dn.emptyDn()
Returns the empty DN.static Dn
Creates a new DN using the provided DN template and unescaped attribute values using the default schema.static Dn
Creates a new DN using the provided DN template and unescaped attribute values using the provided schema.SubtreeSpecification.getBaseDN()
Get the absolute base DN of the subtree specification.final Dn
AbstractMapEntry.getName()
Entries.NullEntry.getName()
Entry.getName()
Returns the distinguished name of this entry.LdapUrl.getName()
Returns the distinguished name of the base entry relative to which the search is to be performed.SubtreeSpecification.getRelativeBaseDN()
Get the relative base LocalName, ie the "base" field.RootDse.getSubschemaSubentry()
Returns a string which represents the DN of the subschema subentry holding the schema controlling the Root DSE.Dn.localName
(int index) Returns the DN whose content is the specified number of RDNs from this DN.Dn.parent()
Returns the DN which is the immediate parent of this DN, ornull
if this DN is the empty DN.Dn.parent
(int index) Returns the DN which is equal to this DN with the specified number of RDNs removed.Returns a copy of this DN whose parent DN,fromDN
, has been renamed to the new parent DN,toDN
.Returns a DN whose value is the result of applying LDAP modify DN semantics to this DN.static Dn
Dn.rootDn()
Deprecated.static Dn
Parses the provided LDAP string representation of a DN using the default schema.static Dn
Parses the provided LDAP string representation of a DN using the provided schema.static Dn
Dn.valueOf
(ByteString dn) Parses the provided LDAP string representation of a DN using the default schema.Modifier and TypeMethodDescriptionAttributeParser.asSetOfDn()
Returns the values decoded as a set ofDN
s using the schema associated with this parser, or an empty set if the attribute does not contain any values.Returns the values decoded as a set ofDN
s using the schema associated with this parser, ordefaultValues
if the attribute does not contain any values.AttributeParser.asSetOfDn
(Collection<Dn> defaultValues) Returns the values decoded as a set ofDN
s using the schema associated with this parser, ordefaultValues
if the attribute does not contain any values.Returns the values decoded as a set ofDN
s using the schema associated with this parser, ordefaultValues
if the attribute does not contain any values.Functions.byteStringToDn()
Returns a function which parsesDN
s using the default schema.Functions.byteStringToDn
(Schema schema) Returns a function which parsesDN
s using the provided schema.SubtreeSpecification.getChopAfter()
Get the ChopAfter LocalNames from the specificExclusions.SubtreeSpecification.getChopBefore()
Get the ChopBefore LocalNames from the specificExclusions.DecodeOptions.getEntryFactory()
Returns the function which will be used for creating newEntry
instances when decoding entries.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).Modifier and TypeMethodDescriptionReturns the first value decoded as aDN
using the schema associated with this parser, ordefaultValue
if the attribute does not contain any values.Returns the values decoded as a set ofDN
s using the schema associated with this parser, ordefaultValues
if the attribute does not contain any values.Returns a DN which is subordinate to this DN and having the additional RDN components contained in the provided DN.int
boolean
Returnstrue
if the named entry exists in this memory backend.default Result
Deletes the named entry from the Directory Server.Returns a deep copy of the named entry contained in this memory backend, ornull
if it does not exist.boolean
MemoryBackend.hasSubordinates
(Dn dn) Returnstrue
if the named entry exists and has at least one child entry.boolean
Returnstrue
if this DN is an immediate child of the provided DN.boolean
SubtreeSpecification.isDNWithinScope
(Dn dn) Determine if the specified DN is within the scope of the subtree specification.boolean
Dn.isInScopeOf
(Dn dn, SearchScope scope) Returnstrue
if this DN matches the provided base DN and search scope.boolean
Dn.isParentOf
(Dn dn) Returnstrue
if this DN is the immediate parent of the provided DN.boolean
Dn.isSubordinateOrEqualTo
(Dn dn) Returnstrue
if this DN is subordinate to or equal to the provided DN.boolean
Dn.isSubordinateTo
(Dn dn) Returnstrue
if this DN is subordinate to, but not equal to the provided DN.boolean
Dn.isSuperiorOrEqualTo
(Dn dn) Returnstrue
if this DN is superior to or equal to the provided DN.boolean
Dn.isSuperiorTo
(Dn dn) Returnstrue
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
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, or0
if the named entry does not exist.Reads the named entry from the Directory Server.Reads the named entry from the Directory Server.default io.reactivex.rxjava3.core.Single<SearchResultEntry>
Reads the named entry from the Directory Server.AbstractConnection.readEntryAsync
(Dn name, Collection<String> attributeDescriptions) AbstractConnectionWrapper.readEntryAsync
(Dn name, Collection<String> attributeDescriptions) Asynchronously reads the named entry from the Directory Server.Connection.readEntryAsync
(Dn name, Collection<String> attributeDescriptions) Asynchronously reads the named entry from the Directory Server.Returns a copy of this DN whose parent DN,fromDN
, has been renamed to the new parent DN,toDN
.Returns a DN whose value is the result of applying LDAP modify DN semantics to this DN.final Entry
default Entry
Sets the distinguished name of this entry (optional operation).static SubtreeSpecification
Parses the string argument as an RFC3672 subtree specification.Modifier and TypeMethodDescriptionMemoryBackend.addVirtualAttributes
(AttributeDescription attributeDescription, BiFunction<Dn, MemoryBackend, Attribute> virtualAttributeFactory) Adds a virtual attribute to the backend.AttributeParser.asSetOfDn
(Collection<Dn> defaultValues) Returns the values decoded as a set ofDN
s using the schema associated with this parser, ordefaultValues
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.setEntryFactory
(Function<Dn, Entry> factory) Sets the function which will be used for creating newEntry
instances when decoding entries.ModifierConstructorDescriptionprotected
AbstractMapEntry
(Dn name, M attributes) Creates an empty entry using the provided distinguished name andMap
.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.SubtreeSpecification
(Dn rootDN) Create a dummy subtree specification.TreeMapEntry
(Dn name) Creates an empty entry using the provided distinguished name and no attributes. -
Uses of Dn in org.forgerock.opendj.ldap.controls
Modifier and TypeMethodDescriptionProxiedAuthV1RequestControl.getAuthorizationDnName()
Returns the distinguished name of the user whose authorization is to be used when performing the operation.GetEffectiveRightsRequestControl.getAuthorizationName()
Returns the distinguished name of the user for which effective rights are to be returned, ornull
if the client's authentication ID is to be used.EntryChangeNotificationResponseControl.getPreviousName()
Returns the distinguished name that the entry had prior to a modify DN operation, ornull
if the operation was not a modify DN.Modifier and TypeMethodDescriptionAuthorizationIdentityResponseControl.newControl
(Dn authorizationDn) Creates a new authorization identity response control using the provided authorization ID.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.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. -
Uses of Dn in org.forgerock.opendj.ldap.messages
Modifier and TypeMethodDescriptionstatic Dn
Requests.dnOfRequest
(Request request) Returns the DN of the entry targeted by the provided request, ornull
if the target entry cannot be determined.AddRequest.getName()
BindRequest.getName()
Returns the name of the Directory object that the client wishes to bind as.CompareRequest.getName()
Returns the distinguished name of the entry to be compared.DeleteRequest.getName()
Returns the distinguished name of the entry to be deleted.ModifyDnRequest.getName()
Returns the distinguished name of the entry to be renamed.ModifyRequest.getName()
Returns the distinguished name of the entry to be modified.SearchRequest.getName()
Returns the distinguished name of the base entry relative to which the search is to be performed.ModifyDnRequest.getNewSuperior()
Returns the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed.Modifier and TypeMethodDescriptionstatic 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.BindResult.setMatchedDn
(Dn dn) CompareResult.setMatchedDn
(Dn dn) ExtendedResult.setMatchedDn
(Dn dn) GenericExtendedResult.setMatchedDn
(Dn dn) PasswordModifyExtendedResult.setMatchedDn
(Dn dn) Result.setMatchedDn
(Dn dn) Sets the matched DN associated with this result.WhoAmIExtendedResult.setMatchedDn
(Dn dn) Sets the name of the Directory object that the client wishes to bind as.Sets the distinguished name of the entry to be compared.Sets the distinguished name of the entry to be deleted.Sets the distinguished name of the entry to be renamed.Sets the distinguished name of the entry to be modified.Sets the distinguished name of the base entry relative to which the search is to be performed.default SearchResultEntry
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
Modifier and TypeMethodDescriptionSchemaValidationPolicy.checkDitStructureRulesParentEntryResolver()
Returns the parent entry resolver which should be used for retrieving the parent entry during DIT structure rule validation.Modifier and TypeMethodDescriptionSchemaBuilder.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.rxjava3.core.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.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.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.rxjava3.core.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.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 SearchRequest
Schema.getReadSchemaSearchRequest
(Dn name) Constructs a search request for retrieving the named subschema sub-entry.static Schema
Schema.readSchema
(Connection connection, Dn name) Reads the schema contained in the named subschema sub-entry.static io.reactivex.rxjava3.core.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.rxjava3.core.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.Modifier and TypeMethodDescriptionSchemaValidationPolicy.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
Modifier and TypeMethodDescriptionChangeRecord.getName()
Returns the distinguished name of the entry being modified by thisChangeRecord
.Modifier and TypeMethodDescriptionLdifChangeRecordReader.setExcludeBranch
(Dn excludeBranch) Excludes all change records which target entries beneath the named entry (inclusive) from being read from LDIF.LdifChangeRecordWriter.setExcludeBranch
(Dn excludeBranch) Excludes all change records which target entries beneath the named entry (inclusive) from being written to LDIF.LdifEntryReader.setExcludeBranch
(Dn excludeBranch) Excludes all entries beneath the named entry (inclusive) from being read from LDIF.LdifEntryWriter.setExcludeBranch
(Dn excludeBranch) Excludes all entries beneath the named entry (inclusive) from being written to LDIF.LdifChangeRecordReader.setIncludeBranch
(Dn includeBranch) Ensures that all change records which target entries beneath the named entry (inclusive) are read from LDIF.LdifChangeRecordWriter.setIncludeBranch
(Dn includeBranch) Ensures that all change records which target entries beneath the named entry (inclusive) are written to LDIF.LdifEntryReader.setIncludeBranch
(Dn includeBranch) Ensures that all entries beneath the named entry (inclusive) are read from LDIF.LdifEntryWriter.setIncludeBranch
(Dn includeBranch) Ensures that all entries beneath the named entry (inclusive) are written to LDIF.Sets the distinguished name of the entry to be updated. -
Uses of Dn in org.forgerock.opendj.security
Modifier and TypeMethodDescriptionDeploymentId.generateSslKeyPair
(Dn subjectDn, Collection<String> dnsNames) Generates an SSL private key and an SSL certificate signed by the root CA certificate associated with this deployment ID.DeploymentId.generateSslKeyPair
(Dn subjectDn, Collection<String> dnsNames, Instant notBefore, Duration validity) Generates an SSL private key and an SSL certificate signed by the root CA certificate associated with this deployment ID.DeploymentId.generateSslKeyPairForWritableReplica
(Dn subjectDn, Collection<String> dnsNames, Instant notBefore, Duration validity) Generates an SSL private key and an SSL certificate, same asDeploymentId.generateSslKeyPair(Dn, Collection, Instant, Duration)
, but theExtendedKeyUsage
extension has an additional ForgeRock defined usage for recognizing replicas allowed to send updates.Sets the certificate issuer name.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.Sets the certificate subject name.
emptyDn()
instead