Uses of Interface
org.forgerock.opendj.ldap.Attribute
Package
Description
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.
Contains a number of API declarations for use throughout the Directory Server.
Contains the code for implementing Directory Server pluggable storage backends.
Contains the code for the Directory Server backend that provides an interface for executing administrative tasks.
Contains various classes that comprise the core of the Directory Server codebase.
Contains various implementations of Directory Server APIs that are not appropriate for other packages.
Contains various Directory Server monitor provider implementations.
Contains the implementation for the Directory Server connection handler that is responsible for interacting with
clients using HTTP.
Contains the implementation for the Directory Server connection handler that is responsible for interacting with
clients using LDAPv3.
This package contains the part of the Multi-master replication code that works on the Directory Server side.
This package contains the code used by the replication server and by the code running on the Directory Server side to
exchange their information.
This package contains the code for the Replication Server part of the Multimaster replication feature.
This package contains a file-based log implementation for the changelog database API.
Contains implementations of various Directory Server schema elements.
Contains implementations for a number of Directory Server data types.
Contains a number of interfaces that are implemented by the various types of Directory Server operations.
-
Uses of Attribute in org.forgerock.opendj.io
Modifier and TypeMethodDescriptionstatic Attribute
Ldap.readAttribute
(Asn1Reader reader, DecodeOptions options, Schema schema) Reads the next ASN.1 element from the providedASN1Reader
as anAttribute
.Modifier and TypeMethodDescriptionstatic void
Ldap.writeAttribute
(Asn1Writer writer, Attribute attribute) Writes anAttribute
to the providedAsn1Writer
. -
Uses of Attribute in org.forgerock.opendj.ldap
Modifier and TypeClassDescriptionclass
AbstractMapEntry<M extends Map<AttributeDescription,
Attribute>> Abstract implementation forMap
based entries.Modifier and TypeClassDescriptionclass
This class provides a skeletal implementation of theAttribute
interface, to minimize the effort required to implement this interface.final class
An implementation of theAttribute
interface with predictable iteration order.Modifier and TypeMethodDescriptionAbstractMapEntry.addAttributeIfAbsent
(Attribute attribute) default Attribute
Entry.addAttributeIfAbsent
(Attribute attribute) Adds the provided attribute if it is not already present in this Entry and returnsnull
.static Attribute
Attributes.emptyAttribute
(String attributeDescription) Returns a read-only empty attribute having the specified attribute description.static Attribute
Attributes.emptyAttribute
(AttributeDescription attributeDescription) Returns a read-only empty attribute having the specified attribute description.final Attribute
AbstractMapEntry.getAttribute
(AttributeDescription attributeDescription) default Attribute
Entry.getAttribute
(String attributeDescription) Returns the named attribute contained in this entry, ornull
if it is not included with this entry.default Attribute
Entry.getAttribute
(AttributeDescription attributeDescription) Returns the named attribute contained in this entry, ornull
if it is not included with this entry.Modification.getAttribute()
Returns the attribute containing the values to be modified.AbstractMapEntry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) default Attribute
Entry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) Adds the provided attribute if it is not already present in this Entry.default Attribute
Adds all of the provided attribute values to this attribute if they are not already present (optional operation).default Attribute
Attribute.put
(ByteString value) Addsvalue
to this attribute if it is not already present (optional operation).static Attribute
Attributes.renameAttribute
(Attribute attribute, String attributeDescription) Returns a view ofattribute
having a different attribute description.static Attribute
Attributes.renameAttribute
(Attribute attribute, AttributeDescription attributeDescription) Returns a view ofattribute
having a different attribute description.static Attribute
Attributes.singletonAttribute
(String attributeDescription, Object value) Returns a read-only single-valued attribute having the specified attribute description.static Attribute
Attributes.singletonAttribute
(AttributeDescription attributeDescription, Object value) Returns a read-only single-valued attribute having the specified attribute description and value.Ava.toAttribute()
Returns a single valued attribute having the same attribute type and value as this AVA.static Attribute
Attributes.unmodifiableAttribute
(Attribute attribute) Returns a read-only view ofattribute
.static Attribute
Attributes.virtualAttribute
(Attribute attribute) Returns a view ofattribute
that is virtual, i.e.static Attribute
Attributes.virtualAttribute
(AttributeDescription attributeDescription) Returns an empty virtual attribute.static Attribute
Attributes.virtualAttribute
(AttributeDescription attributeDescription, Supplier<Collection<?>> attributeValuesSupplier) Returns a virtual attribute whose values will be supplied by providedSupplier
.Modifier and TypeMethodDescriptionAbstractMapEntry.getAllAttributes()
Entries.NullEntry.getAllAttributes()
Entry.getAllAttributes()
Returns anIterable
containing all of the attributes in this entry.Entry.getAllAttributes
(String attributeDescription) Returns anIterable
containing all the attributes in this entry having an attribute description which is a sub-type of the provided attribute description.Entry.getAllAttributes
(AttributeDescription attributeDescription) Returns anIterable
containing all the attributes in this entry having an attribute description which is a sub-type of the provided attribute description.TreeMapEntry.getAllAttributes
(AttributeDescription attributeDescription) DecodeOptions.getAttributeFactory()
Returns the function which will be used for creating newAttribute
instances when decoding attributes.Modifier and TypeMethodDescriptionfinal boolean
AbstractMapEntry.addAttribute
(Attribute attribute, Collection<? super ByteString> duplicateValues) boolean
Entries.NullEntry.addAttribute
(Attribute attribute, Collection<? super ByteString> duplicateValues) default boolean
Entry.addAttribute
(Attribute attribute) Ensures that this entry contains the provided attribute and values (optional operation).default boolean
Entry.addAttribute
(Attribute attribute, Collection<? super ByteString> duplicateValues) Ensures that this entry contains the provided attribute and values (optional operation).AbstractMapEntry.addAttributeIfAbsent
(Attribute attribute) default Attribute
Entry.addAttributeIfAbsent
(Attribute attribute) Adds the provided attribute if it is not already present in this Entry and returnsnull
.default boolean
Entry.containsAttribute
(Attribute attribute, Collection<? super ByteString> missingValues) Returnstrue
if this entry contains all of the attribute values contained inattribute
.abstract boolean
Entries.DiffStrategy.isDifferent
(Attribute fromAttribute, Attribute toAttribute) Returnstrue
if the two attributes are different according to this strategy.default ConditionResult
Indicates whether the provided attribute should be considered a match for this assertion value according to the matching rule.AbstractMapEntry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) default Attribute
Entry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) Adds the provided attribute if it is not already present in this Entry.static ByteString
AbstractAttribute.normalizeValue
(Attribute attribute, ByteString value) Returns the normalized form ofvalue
normalized usingattribute
's equality matching rule.static AttributeParser
AttributeParser.parseAttribute
(Attribute attribute) Returns an attribute parser for the provided attribute.final boolean
AbstractMapEntry.removeAttribute
(Attribute attribute, Collection<? super ByteString> missingValues) default boolean
Entry.removeAttribute
(Attribute attribute, Collection<? super ByteString> missingValues) Removes all of the attribute values contained inattribute
from this entry if it is present (optional operation).static Attribute
Attributes.renameAttribute
(Attribute attribute, String attributeDescription) Returns a view ofattribute
having a different attribute description.static Attribute
Attributes.renameAttribute
(Attribute attribute, AttributeDescription attributeDescription) Returns a view ofattribute
having a different attribute description.boolean
AbstractMapEntry.replaceAttribute
(Attribute attribute) default boolean
Entry.replaceAttribute
(Attribute attribute) Adds all of the attribute values contained inattribute
to this entry, replacing any existing attribute values (optional operation).static Attribute
Attributes.unmodifiableAttribute
(Attribute attribute) Returns a read-only view ofattribute
.static Attribute
Attributes.virtualAttribute
(Attribute attribute) Returns a view ofattribute
that is virtual, i.e.Modifier and TypeMethodDescriptionMemoryBackend.addVirtualAttributes
(AttributeDescription attributeDescription, BiFunction<Dn, MemoryBackend, Attribute> virtualAttributeFactory) Adds a virtual attribute to the backend.AttributeFilter.filterAttributes
(Predicate<Attribute> filter) Registers a predicate which should be applied to attributes selected by this attribute filter.AttributeFilter.mapAttributes
(Function<Attribute, Attribute> mapper) Registers a mapping function which should be applied to attributes selected by this attribute filter.AttributeFilter.mapAttributes
(Function<Attribute, Attribute> mapper) Registers a mapping function which should be applied to attributes selected by this attribute filter.AbstractMapEntry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) AbstractMapEntry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) AbstractMapEntry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) default Attribute
Entry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) Adds the provided attribute if it is not already present in this Entry.default Attribute
Entry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) Adds the provided attribute if it is not already present in this Entry.default Attribute
Entry.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) Adds the provided attribute if it is not already present in this Entry.DecodeOptions.setAttributeFactory
(Function<AttributeDescription, Attribute> factory) Sets the function which will be used for creating newAttribute
instances when decoding attributes.ModifierConstructorDescriptionLinkedAttribute
(Attribute attribute) Creates a new attribute having the same attribute description and attribute values asattribute
.Modification
(ModificationType modificationType, Attribute attribute) Creates a new modification having the provided modification type and attribute values to be updated. -
Uses of Attribute in org.forgerock.opendj.ldap.controls
Modifier and TypeMethodDescriptionMatchedValuesRequestControl.keepMatchedValues
(Schema schema) Returns a mapping function which, given an attribute, returns a new attribute containing only the values matching the filters defined in this control, or an empty attribute if none of the values match.MatchedValuesRequestControl.keepMatchedValues
(Schema schema) Returns a mapping function which, given an attribute, returns a new attribute containing only the values matching the filters defined in this control, or an empty attribute if none of the values match. -
Uses of Attribute in org.forgerock.opendj.ldap.messages
Modifier and TypeMethodDescriptionAddRequest.addAttributeIfAbsent
(Attribute attribute) AddRequest.getAttribute
(String attributeDescription) AddRequest.getAttribute
(AttributeDescription attributeDescription) AddRequest.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) Modifier and TypeMethodDescriptionAddRequest.getAllAttributes()
AddRequest.getAllAttributes
(String attributeDescription) AddRequest.getAllAttributes
(AttributeDescription attributeDescription) Modifier and TypeMethodDescriptionboolean
AddRequest.addAttribute
(Attribute attribute) boolean
AddRequest.addAttribute
(Attribute attribute, Collection<? super ByteString> duplicateValues) AddRequest.addAttributeIfAbsent
(Attribute attribute) boolean
AddRequest.containsAttribute
(Attribute attribute, Collection<? super ByteString> missingValues) AddRequest.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) boolean
AddRequest.removeAttribute
(Attribute attribute, Collection<? super ByteString> missingValues) boolean
AddRequest.replaceAttribute
(Attribute attribute) Modifier and TypeMethodDescriptionAddRequest.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) AddRequest.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) AddRequest.mergeAttribute
(Attribute attribute, BiFunction<? super Attribute, ? super Attribute, ? extends Attribute> mergeFunction) -
Uses of Attribute in org.opends.server.api
Modifier and TypeMethodDescriptionabstract Attribute
VirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) Generates an unmodifiable attribute with the values for the provided entry.Modifier and TypeMethodDescriptionprotected void
ConnectionHandler.addAdditionalMonitorObjectClassNames
(Attribute ocAttr) Adds the object class names that should be included in the monitor entry related to this connection handler to the provided attribute.protected void
EntryCache.addMonitorObjectClassNames
(Attribute objectClassAttribute) protected void
KeyManagerProvider.CertificateMonitor.addMonitorObjectClassNames
(Attribute objectClassAttribute) protected abstract void
MonitorProvider.addMonitorObjectClassNames
(Attribute objectClassAttribute) Adds to the provided attribute the objectclass names that should be included in the monitor entry created from this monitor provider. -
Uses of Attribute in org.opends.server.backends.pluggable
Modifier and TypeMethodDescriptionprotected void
PluggableBackendMonitor.addMonitorObjectClassNames
(Attribute ocAttr) -
Uses of Attribute in org.opends.server.backends.task
Modifier and TypeMethodDescriptionprotected void
Task.replaceAttributes
(Attribute... replacements) Replaces attributes in the task entry. -
Uses of Attribute in org.opends.server.core
Modifier and TypeMethodDescriptionvoid
AddOperation.addAttribute
(Attribute attribute) void
AddOperation.replaceAttribute
(Attribute attribute) -
Uses of Attribute in org.opends.server.extensions
Modifier and TypeMethodDescriptionCollectiveAttributeSubentriesVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) EntityTagVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) EntryDNVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) EntryUUIDVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) GoverningStructureRuleVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) HasSubordinatesVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) IsMemberOfVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) MemberVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) NumSubordinatesVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) PasswordExpirationTimeVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) PasswordPolicySubentryVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) StructuralObjectClassVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) SubschemaSubentryVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) UserDefinedVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attrDesc) UserTemplateVirtualAttributeProvider.getAttribute
(Entry entry, AttributeDescription attributeDescription) -
Uses of Attribute in org.opends.server.monitors
Modifier and TypeMethodDescriptionprotected void
HealthStatusMonitorProvider.addMonitorObjectClassNames
(Attribute objectClassAttribute) protected void
JvmMonitorProvider.addMonitorObjectClassNames
(Attribute objectClassAttribute) protected void
LocalBackendMonitor.addMonitorObjectClassNames
(Attribute ocAttr) -
Uses of Attribute in org.opends.server.protocols.http
Modifier and TypeMethodDescriptionprotected void
HTTPConnectionHandler.addAdditionalMonitorObjectClassNames
(Attribute ocAttr) -
Uses of Attribute in org.opends.server.protocols.ldap
Modifier and TypeMethodDescriptionprotected void
LDAPConnectionHandler.addAdditionalMonitorObjectClassNames
(Attribute ocAttr) -
Uses of Attribute in org.opends.server.replication.plugin
Modifier and TypeClassDescriptionfinal class
A specializedAttribute
implementations that performs lazy conversion ofEntryHistorical
(ds-sync-hist) meta-data to its LDAP attribute representation as well as from its compact org.opends.server.backends.pluggable.ID2Entry representation.Modifier and TypeMethodDescriptionstatic boolean
EntryHistorical.isHistoricalAttribute
(Attribute attr) Check if a given attribute is an attribute used to store historical information. -
Uses of Attribute in org.opends.server.replication.protocol
Modifier and TypeMethodDescriptionAddMsg.getAttributes()
Get the attributes of this add msg.LDAPUpdateMsg.getEclIncludes()
Returns the list of entry attributes.Modifier and TypeMethodDescriptionvoid
LDAPUpdateMsg.setEclIncludes
(Collection<Attribute> entryAttrs) Set a provided list of entry attributes. -
Uses of Attribute in org.opends.server.replication.server
Modifier and TypeMethodDescriptionprotected void
ReplicationServerDomain.addMonitorObjectClassNames
(Attribute objectClassAttribute) -
Uses of Attribute in org.opends.server.replication.server.changelog.file
Modifier and TypeMethodDescriptionprotected void
FileChangelogDB.addMonitorObjectClassNames
(Attribute objectClassAttribute) -
Uses of Attribute in org.opends.server.schema
Modifier and TypeMethodDescriptionSchemaHandler.getExtraAttributes()
Returns the mapping (oid, attribute) for extra attributes stored in this schema handler.Modifier and TypeMethodDescriptionstatic void
SchemaHandler.updateExtraAttributes
(Map<String, Attribute> extraAttributes, Attribute attribute, Set<String> modifiedSchemaFiles) Updates the extra attributes map with the provided attribute, and make sure that the extra attributes get saved to the "99-user.ldif" file.Modifier and TypeMethodDescriptionstatic void
SchemaHandler.updateExtraAttributes
(Map<String, Attribute> extraAttributes, Attribute attribute, Set<String> modifiedSchemaFiles) Updates the extra attributes map with the provided attribute, and make sure that the extra attributes get saved to the "99-user.ldif" file.void
SchemaHandler.updateSchemaAndSchemaFiles
(Schema newSchema, Map<String, Attribute> newExtraAttributes, SortedSet<String> modifiedSchemaFileNames, AlertGenerator alertGenerator) Replaces the schema with the provided schema and updates the provided set of schema files. -
Uses of Attribute in org.opends.server.types
Modifier and TypeClassDescriptionfinal class
A compact attribute represents values using a hash array map trie (HAMT) index and an array of encoded values.Modifier and TypeMethodDescriptionVirtualAttributeRule.getAttribute
(Entry entry) Generates an attribute with the values for the provided entry.static Attribute
Entries.getRealAttributeOrNull
(Attribute attribute) Returns the provided attribute if it is real ornull
if it is virtual.Modifier and TypeMethodDescriptionCompactEntry.getAllAttributes()
SubEntry.getCollectiveAttributes()
Getter for collective attributes contained within this subentry.Modifier and TypeMethodDescriptionprotected void
Operation.checkAttributeConformsToSyntax
(Entry entry, Attribute attribute, LocalizableMessageDescriptor.Arg4<Object, Object, Object, Object> invalidSyntaxErrorMsg, LocalizableMessageDescriptor.Arg3<Object, Object, Object> invalidSyntaxNoValueErrorMsg, LocalizableMessageDescriptor.Arg1<Object> rejectErrorMsg) Checks whether an attribute's values conform to its syntax.static CompactAttribute
CompactAttribute.compactCopyOf
(Attribute attribute) Returns a compact read-only attribute having the same attribute description and attribute values asattribute
.static Attribute
Entries.getRealAttributeOrNull
(Attribute attribute) Returns the provided attribute if it is real ornull
if it is virtual. -
Uses of Attribute in org.opends.server.types.operation
Modifier and TypeMethodDescriptionPostCommitAddOperation.getAllAttributes()
Retrieves the set of attributes as read from the client request.PostOperationAddOperation.getAllAttributes()
Retrieves the set of processed user attributes for the entry to add.PostResponseAddOperation.getAllAttributes()
Retrieves the set of attributes as read from the client request.PostSynchronizationAddOperation.getAllAttributes()
Retrieves the set of attributes as read from the client request.PreOperationAddOperation.getAllAttributes()
Retrieves the set of attributes as read from the client request.PreParseAddOperation.getAllAttributes()
Retrieves the set of attributes as read from the client request.Modifier and TypeMethodDescriptionvoid
PreParseAddOperation.addAttribute
(Attribute attribute) Adds the provided attribute to the set of attributes for this add operation.void
PreOperationAddOperation.replaceAttribute
(Attribute attribute) Adds all of the attribute values contained inattribute
to this entry, replacing any existing attribute values (optional operation).