Package | Description |
---|---|
org.forgerock.opendj.adapter.server3x |
Classes for interacting with an embedded OpenDJ 2.x instance using the OpenDJ LDAP SDK.
|
org.forgerock.opendj.config.server.spi |
Contains a number of API declarations for use throughout the
Directory Server.
|
org.forgerock.opendj.io |
Classes and interfaces providing I/O functionality.
|
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.opends.admin.ads |
Defines the different classes that are you used to have a read-only view of the configuration of the servers that are
registered in the Administration Directory Server (ADS).
|
org.opends.guitools.controlpanel.util |
Contains some utilities used in the Control Panel.
|
org.opends.server.api |
Contains a number of API declarations for use throughout the
Directory Server.
|
org.opends.server.config |
Contains code used to interact with the Directory Server configuration.
|
org.opends.server.core |
Contains various classes that comprise the core of the Directory Server codebase.
|
org.opends.server.replication.protocol |
This package contains the code used by the replication server and by the code running on the Directory Server side to
exchange their information.
|
org.opends.server.replication.service |
This package contains the generic of the Multi-Master replication code that works on the Directory Server side.
|
org.opends.server.tools |
Contains various Directory Server tool implementations.
|
org.opends.server.tools.dsreplication |
Defines the classes that are you used by the replication command lines.
|
org.opends.server.tools.tasks |
This package contains classes that support client tool interaction with the tasks backend.
|
org.opends.server.util |
Contains implementations for various Directory Server utility classes and methods which may be used throughout the
server but do not necessarily fit in elsewhere.
|
Modifier and Type | Method and Description |
---|---|
static Entry |
Converters.from(Entry srvResultEntry)
|
Modifier and Type | Method and Description |
---|---|
static Entry |
Converters.to(Entry sdkEntry)
|
Modifier and Type | Method and Description |
---|---|
Entry |
ConfigurationRepository.getEntry(Dn dn)
Returns the configuration entry for the provided DN.
|
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
ConfigAddListener.applyConfigurationAdd(Entry configEntry)
Attempts to apply a new configuration based on the provided added entry.
|
ConfigChangeResult |
ConfigChangeListener.applyConfigurationChange(Entry configEntry)
Attempts to apply a new configuration to this Directory Server component
based on the provided changed entry.
|
ConfigChangeResult |
ConfigDeleteListener.applyConfigurationDelete(Entry configEntry)
Attempts to apply a new configuration based on the provided deleted
entry.
|
boolean |
ConfigAddListener.configAddIsAcceptable(Entry configEntry,
LocalizableMessageBuilder unacceptableReason)
Indicates whether the configuration entry that will result from a
proposed add is acceptable to this add listener.
|
boolean |
ConfigChangeListener.configChangeIsAcceptable(Entry configEntry,
LocalizableMessageBuilder unacceptableReason)
Indicates whether the configuration entry that will result from a
proposed modification is acceptable to this change listener.
|
boolean |
ConfigDeleteListener.configDeleteIsAcceptable(Entry configEntry,
LocalizableMessageBuilder unacceptableReason)
Indicates whether it is acceptable to remove the provided configuration
entry.
|
Modifier and Type | Method and Description |
---|---|
static Entry |
Ldap.readEntry(Asn1Reader reader,
DecodeOptions options)
Reads the next ASN.1 element from the provided
ASN1Reader as a an
Entry . |
Modifier and Type | Method and Description |
---|---|
static void |
Ldap.writeEntry(Asn1Writer writer,
Entry entry)
Writes an
Entry to the provided ASN1Writer . |
Modifier and Type | Class and Description |
---|---|
class |
AbstractEntry
This class provides a skeletal implementation of the
Entry interface,
to minimize the effort required to implement this interface. |
class |
LinkedHashMapEntry
An implementation of the
Entry interface which uses a
LinkedHashMap for storing attributes. |
class |
TreeMapEntry
An implementation of the
Entry interface which uses a TreeMap
for storing attributes. |
Modifier and Type | Method and Description |
---|---|
Entry |
Entry.addAttribute(String attributeDescription,
Object... values)
Ensures that this entry contains the provided attribute and values
(optional operation).
|
Entry |
AbstractEntry.addAttribute(String attributeDescription,
Object... values) |
Entry |
Entry.clearAttributes()
Removes all the attributes from this entry (optional operation).
|
Entry |
AttributeFilter.filteredCopyOf(Entry entry)
Returns a modifiable filtered copy of the provided entry.
|
Entry |
AttributeFilter.filteredViewOf(Entry entry)
Returns an unmodifiable filtered view of the provided entry.
|
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. |
Entry |
MemoryBackend.get(String dn)
Returns a deep copy of the named entry contained in this memory backend, or
null if it does not exist. |
Entry |
RootDse.getEntry()
Returns the entry which backs this Root DSE instance.
|
static Entry |
Entries.makeEntry(String... ldifLines)
Builds an entry from the provided lines of LDIF.
|
static Entry |
Entries.modifyEntry(Entry entry,
Modification change)
Applies the provided modification to an entry.
|
static Entry |
Entries.modifyEntry(Entry entry,
Modification change,
Collection<? super ByteString> conflictingValues)
Applies the provided modification to an entry.
|
static Entry |
Entries.modifyEntry(Entry entry,
ModifyRequest changes)
Applies the provided modification request to an entry.
|
static Entry |
Entries.modifyEntryPermissive(Entry entry,
Collection<Modification> changes)
Applies the provided modifications to an entry using "permissive" modify
semantics.
|
static Entry |
Entries.modifyEntryStrict(Entry entry,
Collection<Modification> changes)
Applies the provided modifications to an entry using "strict" modify
semantics.
|
Entry |
Entry.removeAttribute(String attributeDescription,
Object... values)
Removes all of the attribute values contained in
values from the
named attribute in this entry if it is present (optional operation). |
Entry |
AbstractEntry.removeAttribute(String attributeDescription,
Object... values) |
Entry |
Entry.replaceAttribute(String attributeDescription,
Object... values)
Adds all of the attribute values contained in
values to this
entry, replacing any existing attribute values (optional operation). |
Entry |
AbstractEntry.replaceAttribute(String attributeDescription,
Object... values) |
Entry |
Entry.setName(Dn dn)
Sets the distinguished name of this entry (optional operation).
|
Entry |
Entry.setName(String dn)
Sets the distinguished name of this entry (optional operation).
|
Entry |
AbstractEntry.setName(String dn) |
static Entry |
Entries.unmodifiableEntry(Entry entry)
Returns a read-only view of
entry and its attributes. |
Modifier and Type | Method and Description |
---|---|
Comparator<Entry> |
SortKey.comparator()
Returns a
Comparator which can be used to compare entries using
this sort key. |
static Comparator<Entry> |
SortKey.comparator(Collection<SortKey> keys)
Returns a
Comparator which can be used to compare entries using
the provided list of sort keys. |
Comparator<Entry> |
SortKey.comparator(Schema schema)
Returns a
Comparator which can be used to compare entries using
this sort key. |
static Comparator<Entry> |
SortKey.comparator(Schema schema,
Collection<SortKey> keys)
Returns a
Comparator which can be used to compare entries using
the provided list of sort keys. |
static Comparator<Entry> |
SortKey.comparator(Schema schema,
SortKey... keys)
Returns a
Comparator which can be used to compare entries using
the provided list of sort keys. |
static Comparator<Entry> |
SortKey.comparator(SortKey... keys)
Returns a
Comparator which can be used to compare entries using
the provided list of sort keys. |
static Comparator<Entry> |
SortKey.comparator(String sortKeys)
Returns a
Comparator which can be used to compare entries using
the provided string representation of a list of sort keys. |
static Comparator<Entry> |
Entries.compareByName()
Returns a
Comparator which can be used to compare entries by name
using the natural order for DN comparisons (parent before children). |
Collection<Entry> |
MemoryBackend.getAll()
Returns a collection containing all of the entries in this memory
backend.
|
Function<Dn,Entry> |
DecodeOptions.getEntryFactory()
Returns the function which will be used for creating new
Entry instances when decoding entries. |
static List<Entry> |
Entries.makeEntries(String... ldifLines)
Builds a list of entries from the provided lines of LDIF.
|
Modifier and Type | Method and Description |
---|---|
Result |
Connection.add(Entry entry)
Adds the provided entry to the Directory Server.
|
Result |
AbstractConnectionWrapper.add(Entry entry)
Adds the provided entry to the Directory Server.
|
Result |
AbstractConnection.add(Entry entry) |
static boolean |
Entries.conformsToSchema(Entry entry,
Schema schema,
SchemaValidationPolicy policy,
Collection<LocalizableMessage> errorMessages)
Returns
true if the provided entry is valid according to the
specified schema and schema validation policy. |
static boolean |
Entries.conformsToSchema(Entry entry,
SchemaValidationPolicy policy,
Collection<LocalizableMessage> errorMessages)
Returns
true if the provided entry is valid according to the
default schema and schema validation policy. |
static boolean |
Entries.containsObjectClass(Entry entry,
ObjectClass objectClass)
Check if the provided entry contains the provided object class.
|
static boolean |
Entries.containsObjectClass(Entry entry,
Schema schema,
ObjectClass objectClass)
Check if the provided entry contains the provided object class.
|
static TreeMapEntry |
TreeMapEntry.deepCopyOfEntry(Entry entry)
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
|
static LinkedHashMapEntry |
LinkedHashMapEntry.deepCopyOfEntry(Entry entry)
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
|
static ModifyRequest |
Entries.diffEntries(Entry fromEntry,
Entry toEntry)
Creates a new modify request containing a list of modifications which can
be used to transform
fromEntry into entry toEntry . |
static ModifyRequest |
Entries.diffEntries(Entry fromEntry,
Entry toEntry,
Options options)
Creates a new modify request containing a list of modifications which can
be used to transform
fromEntry into entry toEntry . |
Entry |
AttributeFilter.filteredCopyOf(Entry entry)
Returns a modifiable filtered copy of the provided entry.
|
Entry |
AttributeFilter.filteredViewOf(Entry entry)
Returns an unmodifiable filtered view of the provided entry.
|
static Set<ObjectClass> |
Entries.getObjectClasses(Entry entry)
Returns an unmodifiable set containing the object classes associated with
the provided entry.
|
static Set<ObjectClass> |
Entries.getObjectClasses(Entry entry,
Schema schema)
Returns an unmodifiable set containing the object classes associated with
the provided entry.
|
static ObjectClass |
Entries.getStructuralObjectClass(Entry entry)
Returns the structural object class associated with the provided entry,
or
null if none was found. |
static ObjectClass |
Entries.getStructuralObjectClass(Entry entry,
Schema schema)
Returns the structural object class associated with the provided entry,
or
null if none was found. |
static boolean |
Entries.isSubEntry(Entry entry)
Returns whether the provided entry is a sub entry.
|
ConditionResult |
Matcher.matches(Entry entry)
Indicates whether this filter
Matcher matches the provided Entry . |
ConditionResult |
Filter.matches(Entry entry)
Indicates whether this
Filter matches the provided Entry
using the default schema. |
static Entry |
Entries.modifyEntry(Entry entry,
Modification change)
Applies the provided modification to an entry.
|
static Entry |
Entries.modifyEntry(Entry entry,
Modification change,
Collection<? super ByteString> conflictingValues)
Applies the provided modification to an entry.
|
static Entry |
Entries.modifyEntry(Entry entry,
ModifyRequest changes)
Applies the provided modification request to an entry.
|
static Entry |
Entries.modifyEntryPermissive(Entry entry,
Collection<Modification> changes)
Applies the provided modifications to an entry using "permissive" modify
semantics.
|
static Entry |
Entries.modifyEntryStrict(Entry entry,
Collection<Modification> changes)
Applies the provided modifications to an entry using "strict" modify
semantics.
|
static TreeMapEntry |
TreeMapEntry.shallowCopyOfEntry(Entry entry)
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
|
static LinkedHashMapEntry |
LinkedHashMapEntry.shallowCopyOfEntry(Entry entry)
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.
|
static String |
Entries.toLdif(Entry entry)
Returns the LDIF representation of
entry . |
static Entry |
Entries.unmodifiableEntry(Entry entry)
Returns a read-only view of
entry and its attributes. |
static RootDse |
RootDse.valueOf(Entry entry)
Creates a new Root DSE instance backed by the provided entry.
|
Modifier and Type | Method and Description |
---|---|
DecodeOptions |
DecodeOptions.setEntryFactory(Function<Dn,Entry> factory)
Sets the function which will be used for creating new
Entry instances when decoding entries. |
Modifier and Type | Method and Description |
---|---|
Entry |
PreReadResponseControl.getEntry()
Returns an unmodifiable entry whose contents reflect the state of the
updated entry immediately before the update operation was performed.
|
Entry |
PostReadResponseControl.getEntry()
Returns an unmodifiable entry whose contents reflect the state of the
updated entry immediately after the update operation was performed.
|
Modifier and Type | Method and Description |
---|---|
static PreReadResponseControl |
PreReadResponseControl.newControl(Entry entry)
Creates a new pre-read response control.
|
static PostReadResponseControl |
PostReadResponseControl.newControl(Entry entry)
Creates a new post-read response control.
|
Modifier and Type | Interface and Description |
---|---|
interface |
AddRequest
The Add operation allows a client to request the addition of an entry into
the Directory.
|
interface |
SearchResultEntry
A Search Result Entry represents an entry found during a Search operation.
|
Modifier and Type | Method and Description |
---|---|
static AddRequest |
Requests.newAddRequest(Entry entry)
Creates a new add request backed by the provided entry.
|
static ModifyRequest |
Requests.newModifyRequest(Entry fromEntry,
Entry toEntry)
Creates a new modify request containing a list of modifications which can
be used to transform
fromEntry into entry toEntry . |
static SearchResultEntry |
Responses.newSearchResultEntry(Entry entry)
Creates a new search result entry backed by the provided entry.
|
Modifier and Type | Method and Description |
---|---|
Entry |
Schema.toEntry(Entry entry)
Adds the definitions of all the schema elements contained in this schema
to the provided subschema subentry.
|
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.
|
Modifier and Type | Method and Description |
---|---|
SchemaBuilder |
SchemaBuilder.addSchema(Entry entry,
boolean overwrite)
Adds all of the schema elements contained in the provided subschema
subentry to this schema builder.
|
SchemaBuilder |
SchemaBuilder.addSchema(Entry entry,
boolean overwrite,
SchemaBuilder.SchemaBuilderHook hook)
Adds all of the schema elements contained in the provided subschema
subentry to this schema builder.
|
Entry |
Schema.toEntry(Entry entry)
Adds the definitions of all the schema elements contained in this schema
to the provided subschema subentry.
|
boolean |
Schema.validateEntry(Entry entry,
SchemaValidationPolicy policy,
Collection<LocalizableMessage> errorMessages)
Returns
true if the provided entry is valid according to this
schema and the specified schema validation policy. |
static Schema |
Schema.valueOf(Entry entry)
Parses the provided entry as a subschema subentry.
|
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.
|
Constructor and Description |
---|
SchemaBuilder(Entry entry)
Creates a new schema builder containing all of the schema elements
contained in the provided subschema subentry.
|
Modifier and Type | Method and Description |
---|---|
Entry |
RejectedChangeRecordListener.handleDuplicateEntry(AddRequest change,
Entry existingEntry)
Invoked when an attempt was made to add an entry which already exists.
|
Entry |
RejectedChangeRecordListener.handleDuplicateEntry(ModifyDnRequest change,
Entry existingEntry,
Entry renamedEntry)
Invoked when an attempt was made to rename an entry which already exists.
|
static Entry |
Ldif.makeEntry(List<String> ldifLines)
Builds an entry from the provided lines of LDIF.
|
static Entry |
Ldif.makeEntry(String... ldifLines)
Builds an entry from the provided lines of LDIF.
|
Entry |
LdifEntryReader.readEntry()
Reads the next entry, blocking if necessary until an entry is available.
|
Entry |
EntryReader.readEntry()
Reads the next entry, blocking if necessary until an entry is available.
|
Entry |
EntryGenerator.readEntry() |
static Entry |
LdifEntryReader.valueOfLdifEntry(String... ldifLines)
Parses the provided array of LDIF lines as a single LDIF entry.
|
Modifier and Type | Method and Description |
---|---|
static List<Entry> |
Ldif.makeEntries(List<String> ldifLines)
Builds a list of entries from the provided lines of LDIF.
|
static List<Entry> |
Ldif.makeEntries(String... ldifLines)
Builds a list of entries from the provided lines of LDIF.
|
static Flowable<Entry> |
Ldif.newEntryPublisher(Callable<? extends EntryReader> factory)
Returns a
Flowable view of a EntryReader , creating a new reader for each subscriber. |
Modifier and Type | Method and Description |
---|---|
Entry |
RejectedChangeRecordListener.handleDuplicateEntry(AddRequest change,
Entry existingEntry)
Invoked when an attempt was made to add an entry which already exists.
|
Entry |
RejectedChangeRecordListener.handleDuplicateEntry(ModifyDnRequest change,
Entry existingEntry,
Entry renamedEntry)
Invoked when an attempt was made to rename an entry which already exists.
|
static String |
Ldif.toLdif(Entry entry)
Returns the LDIF representation of
entry . |
static String |
LdifEntryWriter.toString(Entry entry)
Returns the LDIF string representation of the provided entry.
|
LdifEntryWriter |
LdifEntryWriter.writeEntry(Entry entry) |
EntryWriter |
EntryWriter.writeEntry(Entry entry)
Writes an entry.
|
ConnectionEntryWriter |
ConnectionEntryWriter.writeEntry(Entry entry)
Writes an entry to the underlying connection using an Add request,
blocking until the request completes.
|
Modifier and Type | Method and Description |
---|---|
static EntryReader |
Ldif.newEntryReader(Iterable<? extends Entry> entries)
Returns an entry reader over the provided entry collection.
|
static EntryReader |
Ldif.newEntryReader(Iterator<? extends Entry> entries)
Returns an entry reader over the provided entry iterator.
|
Modifier and Type | Method and Description |
---|---|
static Dn |
MonitoringUtils.getDomainName(Entry e)
Returns the domain name extracted from the monitoring entry.
|
static AttributeParser |
MonitoringUtils.parseAttribute(Entry e,
String... attrDescs)
Parses the attribute description, successively trying the provided monitoring attribute names until one returns a
non-
null attribute. |
Modifier and Type | Method and Description |
---|---|
Entry |
ConfigFromConnection.getRootMonitor()
Returns the root entry of the monitoring tree.
|
Modifier and Type | Method and Description |
---|---|
Entry |
MonitorProvider.getMonitorEntry()
Generates and returns a monitor entry based on the contents of this monitor provider.
|
Modifier and Type | Method and Description |
---|---|
Entry |
ConfigurationHandler.getEntry(Dn dn) |
Entry |
ConfigurationHandler.getRootEntry()
Returns the configuration root entry.
|
Modifier and Type | Method and Description |
---|---|
void |
ConfigurationHandler.addEntry(Entry entry)
Add a configuration entry.
|
void |
ConfigurationHandler.replaceEntry(Entry oldEntry,
Entry newEntry)
Replaces the old configuration entry with the new configuration entry provided.
|
Modifier and Type | Method and Description |
---|---|
static Entry |
DirectoryServer.getConfigEntry(Dn entryDN)
Deprecated.
use
DirectoryServer.getEntry(Dn) when possible |
static Entry |
DirectoryServer.getParentSdkEntry(Dn childDn)
Retrieves the entry that is the immediate parent of the entry having the provided DN.
|
Constructor and Description |
---|
AddMsg(CSN csn,
Entry entry,
String entryUuid,
String parentEntryUuid)
Creates a new AddMessage.
|
Modifier and Type | Method and Description |
---|---|
Entry |
ReplicationDomain.getMonitorEntry()
Returns the monitor entry for this replication domain.
|
Modifier and Type | Method and Description |
---|---|
void |
RestoreDb.addTaskAttributes(Entry taskEntry) |
void |
RebuildIndex.addTaskAttributes(Entry taskEntry) |
void |
ImportLdif.addTaskAttributes(Entry taskEntry) |
void |
ExportLdif.addTaskAttributes(Entry taskEntry) |
void |
BackUpDb.addTaskAttributes(Entry taskEntry) |
Modifier and Type | Method and Description |
---|---|
void |
PurgeHistoricalScheduleInformation.addTaskAttributes(Entry taskEntry) |
Modifier and Type | Method and Description |
---|---|
protected void |
TaskTool.addAttribute(Entry taskEntry,
String attrName,
com.forgerock.opendj.cli.Argument argument)
Adds the provided attribute with the argument value(s) to the provided task entry only if the argument has
been provided on the command line.
|
protected void |
TaskTool.addAttributeIfArgumentPresent(Entry taskEntry,
String attrName,
com.forgerock.opendj.cli.Argument argument)
Adds the attribute with the argument value to the task entry if the argument corresponding to the
attribute has been provided on the command line.
|
void |
TaskScheduleInformation.addTaskAttributes(Entry taskEntry)
Adds utility specific attributes to the provided task entry that is added to the task backend.
|
static void |
TaskClient.addTaskAttributes(TaskScheduleInformation information,
Entry taskEntry)
Adds attributes related to scheduling contained in the provided
TaskScheduleInformation in the provided
task entry. |
static String |
TaskClient.getTaskDn(Entry taskEntry)
Uses provided task entry attributes to create a DN for the provided task entry.
|
static String |
TaskClient.getTaskId(Entry taskEntry)
Returns the ID of the provided task entry.
|
Constructor and Description |
---|
TaskEntry(Entry entry)
Creates a parameterized instance.
|
Modifier and Type | Method and Description |
---|---|
static Entry |
StaticUtils.createSdkEntry(Dn dn,
Schema schema)
Creates a new, blank entry with the given DN.
|
Copyright 2010-2018 ForgeRock AS.