Uses of Interface
org.forgerock.opendj.ldap.Entry
-
Packages that use Entry Package Description 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. -
-
Uses of Entry in org.forgerock.opendj.io
Methods in org.forgerock.opendj.io that return Entry Modifier and Type Method Description static Entry
Ldap. readEntry(Asn1Reader reader, DecodeOptions options)
Reads the next ASN.1 element from the providedASN1Reader
as anEntry
.Methods in org.forgerock.opendj.io with parameters of type Entry Modifier and Type Method Description static void
Ldap. writeEntry(Asn1Writer writer, Entry entry)
Writes anEntry
to the providedAsn1Writer
. -
Uses of Entry in org.forgerock.opendj.ldap
Classes in org.forgerock.opendj.ldap that implement Entry Modifier and Type Class Description class
AbstractEntry
This class provides a skeletal implementation of theEntry
interface, to minimize the effort required to implement this interface.class
AbstractMapEntry<M extends Map<AttributeDescription,Attribute>>
Abstract implementation forMap
based entries.static class
Entries.NullEntry
AnEntry
which implements the null object pattern.class
LinkedHashMapEntry
An implementation of theEntry
interface which uses aLinkedHashMap
for storing attributes.class
TreeMapEntry
An implementation of theEntry
interface which uses aTreeMap
for storing attributes.Methods in org.forgerock.opendj.ldap that return Entry Modifier and Type Method Description default Entry
Entry. addAttribute(String attributeDescription, Object... values)
Ensures that this entry contains the provided attribute and values (optional operation).Entry
AbstractMapEntry. clearAttributes()
Entry
Entries.NullEntry. clearAttributes()
default Entry
Entry. clearAttributes()
Removes all the attributes from this entry (optional operation).static Entry
Entries. copyOnWriteEntry(Entry entry, Function<Entry,Entry> copyConstructor)
Returns a shallow copy-on-write view ofentry
.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(String dn)
Returns a deep copy of the named entry contained in this memory backend, ornull
if it does not exist.Entry
MemoryBackend. get(Dn dn)
Returns a deep copy of the named entry contained in this memory backend, ornull
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, ModifyRequest changes)
Applies the provided modification request to an entry.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. 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 Entry
Entries. nullEntry()
Returns a read-only empty entry having the empty distinguished name.static Entry
Entries. nullEntry(Dn dn)
Returns a read-only empty entry having the provided distinguished name.default Entry
Entry. removeAttribute(String attributeDescription, Object... values)
Removes all of the attribute values contained invalues
from the named attribute in this entry if it is present (optional operation).default Entry
Entry. replaceAttribute(String attributeDescription, Object... values)
Adds all of the attribute values contained invalues
to this entry, replacing any existing attribute values (optional operation).Entry
AbstractMapEntry. setName(Dn dn)
Entry
Entries.NullEntry. setName(Dn dn)
default Entry
Entry. setName(String dn)
Sets the distinguished name of this entry (optional operation).default Entry
Entry. setName(Dn dn)
Sets the distinguished name of this entry (optional operation).static Entry
Entries. unmodifiableEntry(Entry entry)
Returns a read-only view ofentry
and its attributes.Methods in org.forgerock.opendj.ldap that return types with arguments of type Entry Modifier and Type Method Description Comparator<Entry>
SortKey. comparator()
Returns aComparator
which can be used to compare entries using this sort key.static Comparator<Entry>
SortKey. comparator(String sortKeys)
Returns aComparator
which can be used to compare entries using the provided string representation of a list of sort keys.static Comparator<Entry>
SortKey. comparator(Collection<SortKey> keys)
Returns aComparator
which can be used to compare entries using the provided list of sort keys.Comparator<Entry>
SortKey. comparator(Schema schema)
Returns aComparator
which can be used to compare entries using this sort key.static Comparator<Entry>
SortKey. comparator(Schema schema, Collection<SortKey> keys)
Returns aComparator
which can be used to compare entries using the provided list of sort keys.static Comparator<Entry>
SortKey. comparator(Schema schema, SortKey... keys)
Returns aComparator
which can be used to compare entries using the provided list of sort keys.static Comparator<Entry>
SortKey. comparator(SortKey... keys)
Returns aComparator
which can be used to compare entries using the provided list of sort keys.static Comparator<Entry>
Entries. compareByName()
Returns aComparator
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 newEntry
instances when decoding entries.static List<Entry>
Entries. makeEntries(String... ldifLines)
Builds a list of entries from the provided lines of LDIF.Methods in org.forgerock.opendj.ldap with parameters of type Entry Modifier and Type Method Description Result
AbstractConnection. add(Entry entry)
Result
AbstractConnectionWrapper. add(Entry entry)
Adds the provided entry to the Directory Server.Result
Connection. add(Entry entry)
Adds the provided entry to the Directory Server.static boolean
Entries. conformsToSchema(Entry entry, SchemaValidationPolicy policy, Collection<LocalizableMessage> errorMessages)
Returnstrue
if the provided entry is valid according to the default schema and schema validation policy.static boolean
Entries. conformsToSchema(Entry entry, SchemaValidationPolicy policy, Collection<LocalizableMessage> errorMessages, Schema schema)
Returnstrue
if the provided entry is valid according to the specified 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, ObjectClass objectClass, Schema schema)
Check if the provided entry contains the provided object class.static Entry
Entries. copyOnWriteEntry(Entry entry, Function<Entry,Entry> copyConstructor)
Returns a shallow copy-on-write view ofentry
.static LinkedHashMapEntry
LinkedHashMapEntry. deepCopyOfEntry(Entry entry)
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.static TreeMapEntry
TreeMapEntry. 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 transformfromEntry
into entrytoEntry
.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 transformfromEntry
into entrytoEntry
.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, ornull
if none was found.static ObjectClass
Entries. getStructuralObjectClass(Entry entry, Schema schema)
Returns the structural object class associated with the provided entry, ornull
if none was found.static boolean
Entries. isSubEntry(Entry entry)
Returns whether the provided entry is a sub entry.ConditionResult
Filter. matches(Entry entry)
Indicates whether thisFilter
matches the providedEntry
using the default schema.ConditionResult
Matcher. matches(Entry entry)
Indicates whether this filterMatcher
matches the providedEntry
.static Entry
Entries. modifyEntry(Entry entry, ModifyRequest changes)
Applies the provided modification request to an entry.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. 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 LinkedHashMapEntry
LinkedHashMapEntry. shallowCopyOfEntry(Entry entry)
Creates an entry having the same distinguished name, attributes, and object classes of the provided entry.static TreeMapEntry
TreeMapEntry. 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 ofentry
.static Entry
Entries. unmodifiableEntry(Entry entry)
Returns a read-only view ofentry
and its attributes.static RootDse
RootDse. valueOf(Entry entry)
Creates a new Root DSE instance backed by the provided entry.Method parameters in org.forgerock.opendj.ldap with type arguments of type Entry Modifier and Type Method Description static Entry
Entries. copyOnWriteEntry(Entry entry, Function<Entry,Entry> copyConstructor)
Returns a shallow copy-on-write view ofentry
.static Entry
Entries. copyOnWriteEntry(Entry entry, Function<Entry,Entry> copyConstructor)
Returns a shallow copy-on-write view ofentry
.DecodeOptions
DecodeOptions. setEntryFactory(Function<Dn,Entry> factory)
Sets the function which will be used for creating newEntry
instances when decoding entries. -
Uses of Entry in org.forgerock.opendj.ldap.controls
Methods in org.forgerock.opendj.ldap.controls that return Entry Modifier and Type Method Description Entry
PostReadResponseControl. getEntry()
Returns an unmodifiable entry whose contents reflect the state of the updated entry immediately after the update operation was performed.Entry
PreReadResponseControl. getEntry()
Returns an unmodifiable entry whose contents reflect the state of the updated entry immediately before the update operation was performed.Methods in org.forgerock.opendj.ldap.controls with parameters of type Entry Modifier and Type Method Description static PostReadResponseControl
PostReadResponseControl. newControl(Entry entry)
Creates a new post-read response control.static PreReadResponseControl
PreReadResponseControl. newControl(Entry entry)
Creates a new pre-read response control. -
Uses of Entry in org.forgerock.opendj.ldap.messages
Subinterfaces of Entry in org.forgerock.opendj.ldap.messages Modifier and Type Interface 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.Methods in org.forgerock.opendj.ldap.messages with parameters of type Entry Modifier and Type Method 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 transformfromEntry
into entrytoEntry
.static SearchResultEntry
Responses. newSearchResultEntry(Entry entry)
Creates a new search result entry backed by the provided entry. -
Uses of Entry in org.forgerock.opendj.ldap.schema
Methods in org.forgerock.opendj.ldap.schema that return Entry Modifier and Type Method Description Entry
Schema. toEntry(Entry entry)
Adds the definitions of all the schema elements contained in this schema to the provided subschema subentry.Methods in org.forgerock.opendj.ldap.schema that return types with arguments of type Entry Modifier and Type Method 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 Entry Modifier and Type Method 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)
Returnstrue
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.Method parameters in org.forgerock.opendj.ldap.schema with type arguments of type Entry Modifier and Type Method 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.Constructors in org.forgerock.opendj.ldap.schema with parameters of type Entry Constructor Description SchemaBuilder(Entry entry)
Creates a new schema builder containing all of the schema elements contained in the provided subschema subentry. -
Uses of Entry in org.forgerock.opendj.ldif
Methods in org.forgerock.opendj.ldif that return Entry Modifier and Type Method 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(String... ldifLines)
Builds an entry from the provided lines of LDIF.static Entry
Ldif. makeEntry(List<String> ldifLines)
Builds an entry from the provided lines of LDIF.Entry
EntryGenerator. readEntry()
Entry
EntryReader. readEntry()
Reads the next entry, blocking if necessary until an entry is available.Entry
LdifEntryReader. readEntry()
Reads the next entry, blocking if necessary until an entry is available.Methods in org.forgerock.opendj.ldif that return types with arguments of type Entry Modifier and Type Method Description static List<Entry>
Ldif. makeEntries(String... ldifLines)
Builds a list of entries from the provided lines of LDIF.static List<Entry>
Ldif. makeEntries(List<String> ldifLines)
Builds a list of entries from the provided lines of LDIF.static io.reactivex.rxjava3.core.Flowable<Entry>
Ldif. newEntryPublisher(io.reactivex.rxjava3.functions.Supplier<? extends EntryReader> factory)
Returns aFlowable
view of aEntryReader
, creating a new reader for each subscriber.Methods in org.forgerock.opendj.ldif with parameters of type Entry Modifier and Type Method 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 ofentry
.static String
LdifEntryWriter. toString(Entry entry)
Returns the LDIF string representation of the provided entry.ConnectionEntryWriter
ConnectionEntryWriter. writeEntry(Entry entry)
Writes an entry to the underlying connection using an Add request, blocking until the request completes.EntryWriter
EntryWriter. writeEntry(Entry entry)
Writes an entry.LdifEntryWriter
LdifEntryWriter. writeEntry(Entry entry)
Method parameters in org.forgerock.opendj.ldif with type arguments of type Entry Modifier and Type Method 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.
-