| Package | Description |
|---|---|
| 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.requests |
Classes and interfaces for core LDAP requests.
|
| org.forgerock.opendj.ldap.responses |
Classes and interfaces for core LDAP 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.
|
| 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.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 |
Entry.getName()
Returns the string representation of the distinguished name of this
entry.
|
DN |
LDAPUrl.getName()
Returns the distinguished name of the base entry relative to which the
search is to be performed.
|
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. |
static DN |
DN.rootDN()
Returns the Root DN.
|
DN |
DN.CompactDn.toDn()
Returns the DN corresponding to this compact representation.
|
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.
|
| 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 org.forgerock.util.Function<ByteString,DN,org.forgerock.util.promise.NeverThrowsException> |
Functions.byteStringToDN()
Returns a function which parses
DNs using the default schema. |
static org.forgerock.util.Function<ByteString,DN,org.forgerock.util.promise.NeverThrowsException> |
Functions.byteStringToDN(Schema schema)
Returns a function which parses
DNs using the provided schema. |
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).
|
static org.forgerock.util.Function<String,DN,org.forgerock.util.promise.NeverThrowsException> |
Functions.stringToDN()
Returns a function which parses
DNs using the default schema. |
static org.forgerock.util.Function<String,DN,org.forgerock.util.promise.NeverThrowsException> |
Functions.stringToDN(Schema schema)
Returns a function which parses
DNs using the provided schema. |
| 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. |
Entry |
MemoryBackend.get(DN dn)
Returns the named entry contained in this memory backend, or
null
if it does not exist. |
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.isSuperiorOrEqualTo(DN dn)
Returns
true if this DN is superior to or equal to the provided
DN. |
Entry |
EntryFactory.newEntry(DN name)
Creates an empty entry using the provided distinguished name and no
attributes.
|
SearchResultEntry |
AbstractConnection.readEntry(DN baseObject,
String... attributeDescriptions) |
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.
|
LdapPromise<SearchResultEntry> |
AbstractConnection.readEntryAsync(DN name,
Collection<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.
|
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. |
Entry |
Entry.setName(DN dn)
Sets the distinguished name of this entry (optional operation).
|
| 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. |
| Constructor and Description |
|---|
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.
|
| 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. |
| 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 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.
|
| Modifier and Type | Method and Description |
|---|---|
DN |
CompareRequest.getName()
Returns the distinguished name of the entry to be compared.
|
DN |
SearchRequest.getName()
Returns the distinguished name of the base entry relative to which the
search is to be performed.
|
DN |
AddRequest.getName() |
DN |
DeleteRequest.getName()
Returns the distinguished name of the entry to be deleted.
|
DN |
ModifyDNRequest.getName()
Returns the distinguished name of the entry to be renamed.
|
DN |
ModifyRequest.getName()
Returns the distinguished name of the entry to be modified.
|
DN |
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 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,
Filter filter,
String... attributeDescriptions)
Creates a new search request using the provided distinguished name,
scope, and filter.
|
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.
|
CompareRequest |
CompareRequest.setName(DN dn)
Sets the distinguished name of the entry to be compared.
|
SearchRequest |
SearchRequest.setName(DN dn)
Sets the distinguished name of the base entry relative to which the
search is to be performed.
|
AddRequest |
AddRequest.setName(DN dn) |
DeleteRequest |
DeleteRequest.setName(DN dn)
Sets the distinguished name of the entry to be deleted.
|
ModifyDNRequest |
ModifyDNRequest.setName(DN dn)
Sets the distinguished name of the entry to be renamed.
|
ModifyRequest |
ModifyRequest.setName(DN dn)
Sets the distinguished name of the entry to be modified.
|
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.
|
| Modifier and Type | Method and Description |
|---|---|
DN |
SearchResultEntry.getName() |
| Modifier and Type | Method and Description |
|---|---|
static SearchResultEntry |
Responses.newSearchResultEntry(DN name)
Creates a new search result entry using the provided distinguished name.
|
SearchResultEntry |
SearchResultEntry.setName(DN 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.
|
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.
|
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.
|
Entry |
SchemaValidationPolicy.EntryResolver.getEntry(DN dn)
Returns the named entry in order to enforce DIT structure rules.
|
static Schema |
Schema.readSchema(Connection connection,
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 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 Type | Method and Description |
|---|---|
DN |
ChangeRecord.getName()
Returns the distinguished name of the entry being modified by this
ChangeRecord. |
| Modifier and Type | Method and Description |
|---|---|
LDIFChangeRecordReader |
LDIFChangeRecordReader.setExcludeBranch(DN excludeBranch)
Excludes all change records which target entries beneath the named entry
(inclusive) from being read from LDIF.
|
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.setIncludeBranch(DN includeBranch)
Ensures that all change records which target entries beneath the named
entry (inclusive) are 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.
|
Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.