Uses of Interface
org.forgerock.opendj.ldap.Attribute

Packages that use Attribute

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.opends.server.api	Contains a number of API declarations for use throughout the Directory Server.
org.opends.server.backends.pluggable	Contains the code for implementing Directory Server pluggable storage backends.
org.opends.server.backends.task	Contains the code for the Directory Server backend that provides an interface for executing administrative tasks.
org.opends.server.core	Contains various classes that comprise the core of the Directory Server codebase.
org.opends.server.extensions	Contains various implementations of Directory Server APIs that are not appropriate for other packages.
org.opends.server.monitors	Contains various Directory Server monitor provider implementations.
org.opends.server.protocols.http	Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using HTTP.
org.opends.server.protocols.ldap	Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using LDAPv3.
org.opends.server.replication.plugin	This package contains the part of the Multi-master replication code that works on the Directory Server side.
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.server	This package contains the code for the Replication Server part of the Multimaster replication feature.
org.opends.server.schema	Contains implementations of various Directory Server schema elements.
org.opends.server.types	Contains implementations for a number of Directory Server data types.
org.opends.server.types.operation	Contains a number of interfaces that are implemented by the various types of Directory Server operations.

Uses of Attribute in org.forgerock.opendj.io

Methods in org.forgerock.opendj.io that return Attribute

Modifier and Type	Method	Description
static Attribute	Ldap.readAttribute(Asn1Reader reader, DecodeOptions options, Schema schema)	Reads the next ASN.1 element from the provided ASN1Reader as an Attribute.

Methods in org.forgerock.opendj.io with parameters of type Attribute

Modifier and Type	Method	Description
static void	Ldap.writeAttribute(Asn1Writer writer, Attribute attribute)	Writes an Attribute to the provided Asn1Writer.

Uses of Attribute in org.forgerock.opendj.ldap

Classes in org.forgerock.opendj.ldap with type parameters of type Attribute

Modifier and Type	Class	Description
class	AbstractMapEntry<M extends Map<AttributeDescription,Attribute>>	Abstract implementation for Map based entries.

Classes in org.forgerock.opendj.ldap that implement Attribute

Modifier and Type	Class	Description
class	AbstractAttribute	This class provides a skeletal implementation of the Attribute interface, to minimize the effort required to implement this interface.
class	LinkedAttribute	An implementation of the Attribute interface with predictable iteration order.

Methods in org.forgerock.opendj.ldap that return Attribute

Modifier and Type	Method	Description
Attribute	AbstractMapEntry.addAttributeIfAbsent(Attribute attribute)
default Attribute	Entry.addAttributeIfAbsent(Attribute attribute)	Adds the provided attribute if it is not already present in this Entry and returns null.
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.
Attribute	AbstractMapEntry.getAttribute(AttributeDescription attributeDescription)
default Attribute	Entry.getAttribute(String attributeDescription)	Returns the named attribute contained in this entry, or null if it is not included with this entry.
default Attribute	Entry.getAttribute(AttributeDescription attributeDescription)	Returns the named attribute contained in this entry, or null if it is not included with this entry.
Attribute	Modification.getAttribute()	Returns the attribute containing the values to be modified.
Attribute	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	Attribute.put(Object... values)	Adds all of the provided attribute values to this attribute if they are not already present (optional operation).
default Attribute	Attribute.put(ByteString value)	Adds value to this attribute if it is not already present (optional operation).
static Attribute	Attributes.renameAttribute(Attribute attribute, String attributeDescription)	Returns a view of attribute having a different attribute description.
static Attribute	Attributes.renameAttribute(Attribute attribute, AttributeDescription attributeDescription)	Returns a view of attribute 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.
Attribute	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 of attribute.
static Attribute	Attributes.virtualAttribute(Attribute attribute)	Returns a view of attribute 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 provided Supplier.

Methods in org.forgerock.opendj.ldap that return types with arguments of type Attribute

Modifier and Type	Method	Description
Iterable<Attribute>	AbstractMapEntry.getAllAttributes()
Iterable<Attribute>	Entries.NullEntry.getAllAttributes()
Iterable<Attribute>	Entry.getAllAttributes()	Returns an Iterable containing all of the attributes in this entry.
default Iterable<Attribute>	Entry.getAllAttributes(String attributeDescription)	Returns an Iterable containing all the attributes in this entry having an attribute description which is a sub-type of the provided attribute description.
default Iterable<Attribute>	Entry.getAllAttributes(AttributeDescription attributeDescription)	Returns an Iterable containing all the attributes in this entry having an attribute description which is a sub-type of the provided attribute description.
Iterable<Attribute>	TreeMapEntry.getAllAttributes(AttributeDescription attributeDescription)
Function<AttributeDescription,Attribute>	DecodeOptions.getAttributeFactory()	Returns the function which will be used for creating new Attribute instances when decoding attributes.

Methods in org.forgerock.opendj.ldap with parameters of type Attribute

Modifier and Type	Method	Description
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).
Attribute	AbstractMapEntry.addAttributeIfAbsent(Attribute attribute)
default Attribute	Entry.addAttributeIfAbsent(Attribute attribute)	Adds the provided attribute if it is not already present in this Entry and returns null.
default boolean	Entry.containsAttribute(Attribute attribute, Collection<? super ByteString> missingValues)	Returns true if this entry contains all of the attribute values contained in attribute.
Attribute	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 of value normalized using attribute's equality matching rule.
static AttributeParser	AttributeParser.parseAttribute(Attribute attribute)	Returns an attribute parser for the provided attribute.
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 in attribute from this entry if it is present (optional operation).
static Attribute	Attributes.renameAttribute(Attribute attribute, String attributeDescription)	Returns a view of attribute having a different attribute description.
static Attribute	Attributes.renameAttribute(Attribute attribute, AttributeDescription attributeDescription)	Returns a view of attribute having a different attribute description.
boolean	AbstractMapEntry.replaceAttribute(Attribute attribute)
default boolean	Entry.replaceAttribute(Attribute attribute)	Adds all of the attribute values contained in attribute to this entry, replacing any existing attribute values (optional operation).
static Attribute	Attributes.unmodifiableAttribute(Attribute attribute)	Returns a read-only view of attribute.
static Attribute	Attributes.virtualAttribute(Attribute attribute)	Returns a view of attribute that is virtual, i.e.

Method parameters in org.forgerock.opendj.ldap with type arguments of type Attribute

Modifier and Type	Method	Description
MemoryBackend	MemoryBackend.addVirtualAttributes(AttributeDescription attributeDescription, BiFunction<Dn,MemoryBackend,Attribute> virtualAttributeFactory)	Adds a virtual attribute to the backend.
AttributeFilter	AttributeFilter.filterAttributes(Predicate<Attribute> filter)	Registers a predicate which should be applied to attributes selected by this attribute filter.
AttributeFilter	AttributeFilter.mapAttributes(Function<Attribute,Attribute> mapper)	Registers a mapping function which should be applied to attributes selected by this attribute filter.
AttributeFilter	AttributeFilter.mapAttributes(Function<Attribute,Attribute> mapper)	Registers a mapping function which should be applied to attributes selected by this attribute filter.
Attribute	AbstractMapEntry.mergeAttribute(Attribute attribute, BiFunction<? super Attribute,? super Attribute,? extends Attribute> mergeFunction)
Attribute	AbstractMapEntry.mergeAttribute(Attribute attribute, BiFunction<? super Attribute,? super Attribute,? extends Attribute> mergeFunction)
Attribute	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	DecodeOptions.setAttributeFactory(Function<AttributeDescription,Attribute> factory)	Sets the function which will be used for creating new Attribute instances when decoding attributes.

Constructors in org.forgerock.opendj.ldap with parameters of type Attribute

Constructor	Description
LinkedAttribute(Attribute attribute)	Creates a new attribute having the same attribute description and attribute values as attribute.
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

Methods in org.forgerock.opendj.ldap.controls that return types with arguments of type Attribute

Modifier and Type	Method	Description
Function<Attribute,Attribute>	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.
Function<Attribute,Attribute>	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

Methods in org.forgerock.opendj.ldap.messages that return Attribute

Modifier and Type	Method	Description
Attribute	AddRequest.getAttribute(String attributeDescription)
Attribute	AddRequest.getAttribute(AttributeDescription attributeDescription)

Methods in org.forgerock.opendj.ldap.messages that return types with arguments of type Attribute

Modifier and Type	Method	Description
Iterable<Attribute>	AddRequest.getAllAttributes()
Iterable<Attribute>	AddRequest.getAllAttributes(String attributeDescription)
Iterable<Attribute>	AddRequest.getAllAttributes(AttributeDescription attributeDescription)

Methods in org.forgerock.opendj.ldap.messages with parameters of type Attribute

Modifier and Type	Method	Description
boolean	AddRequest.addAttribute(Attribute attribute)
boolean	AddRequest.addAttribute(Attribute attribute, Collection<? super ByteString> duplicateValues)
boolean	AddRequest.containsAttribute(Attribute attribute, Collection<? super ByteString> missingValues)
boolean	AddRequest.removeAttribute(Attribute attribute, Collection<? super ByteString> missingValues)
boolean	AddRequest.replaceAttribute(Attribute attribute)

Uses of Attribute in org.opends.server.api

Methods in org.opends.server.api that return Attribute

Modifier and Type	Method	Description
abstract Attribute	VirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)	Generates an unmodifiable attribute with the values for the provided entry.

Methods in org.opends.server.api with parameters of type Attribute

Modifier and Type	Method	Description
protected 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

Methods in org.opends.server.backends.pluggable with parameters of type Attribute

Modifier and Type	Method	Description
protected void	PluggableBackendMonitor.addMonitorObjectClassNames(Attribute ocAttr)

Uses of Attribute in org.opends.server.backends.task

Methods in org.opends.server.backends.task with parameters of type Attribute

Modifier and Type	Method	Description
protected void	Task.replaceAttributes(Attribute... replacements)	Replaces attributes in the task entry.

Uses of Attribute in org.opends.server.core

Methods in org.opends.server.core that return types with arguments of type Attribute

Modifier and Type	Method	Description
Iterable<Attribute>	AddOperation.getAllAttributes()

Methods in org.opends.server.core with parameters of type Attribute

Modifier and Type	Method	Description
void	AddOperation.addAttribute(Attribute attribute)
void	AddOperation.replaceAttribute(Attribute attribute)

Uses of Attribute in org.opends.server.extensions

Methods in org.opends.server.extensions that return Attribute

Modifier and Type	Method	Description
Attribute	CollectiveAttributeSubentriesVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	EntityTagVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	EntryDNVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	EntryUUIDVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	GoverningStructureRuleVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	HasSubordinatesVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	IsMemberOfVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	MemberVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	NumSubordinatesVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	PasswordExpirationTimeVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	PasswordPolicySubentryVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	StructuralObjectClassVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	SubschemaSubentryVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)
Attribute	UserDefinedVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attrDesc)
Attribute	UserTemplateVirtualAttributeProvider.getAttribute(Entry entry, AttributeDescription attributeDescription)

Uses of Attribute in org.opends.server.monitors

Methods in org.opends.server.monitors with parameters of type Attribute

Modifier and Type	Method	Description
protected 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

Methods in org.opends.server.protocols.http with parameters of type Attribute

Modifier and Type	Method	Description
protected void	HTTPConnectionHandler.addAdditionalMonitorObjectClassNames(Attribute ocAttr)

Uses of Attribute in org.opends.server.protocols.ldap

Methods in org.opends.server.protocols.ldap with parameters of type Attribute

Modifier and Type	Method	Description
protected void	LDAPConnectionHandler.addAdditionalMonitorObjectClassNames(Attribute ocAttr)

Uses of Attribute in org.opends.server.replication.plugin

Classes in org.opends.server.replication.plugin that implement Attribute

Modifier and Type	Class	Description
class	EntryHistoricalAttribute	A specialized Attribute implementations that performs lazy conversion of EntryHistorical (ds-sync-hist) meta-data to its LDAP attribute representation as well as from its compact org.opends.server.backends.pluggable.ID2Entry representation.

Methods in org.opends.server.replication.plugin with parameters of type Attribute

Modifier and Type	Method	Description
static 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

Methods in org.opends.server.replication.protocol that return types with arguments of type Attribute

Modifier and Type	Method	Description
List<Attribute>	AddMsg.getAttributes()	Get the attributes of this add msg.
List<Attribute>	LDAPUpdateMsg.getEclIncludes()	Returns the list of entry attributes.

Method parameters in org.opends.server.replication.protocol with type arguments of type Attribute

Modifier and Type	Method	Description
void	LDAPUpdateMsg.setEclIncludes(Collection<Attribute> entryAttrs)	Set a provided list of entry attributes.

Uses of Attribute in org.opends.server.replication.server

Methods in org.opends.server.replication.server with parameters of type Attribute

Modifier and Type	Method	Description
protected void	ReplicationServerDomain.addMonitorObjectClassNames(Attribute objectClassAttribute)

Uses of Attribute in org.opends.server.schema

Methods in org.opends.server.schema that return types with arguments of type Attribute

Modifier and Type	Method	Description
Map<String,Attribute>	SchemaHandler.getExtraAttributes()	Returns the mapping (oid, attribute) for extra attributes stored in this schema handler.

Methods in org.opends.server.schema with parameters of type Attribute

Modifier and Type	Method	Description
static 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.

Method parameters in org.opends.server.schema with type arguments of type Attribute

Modifier and Type	Method	Description
static 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

Classes in org.opends.server.types that implement Attribute

Modifier and Type	Class	Description
class	CompactAttribute	A compact attribute represents values using a hash array map trie (HAMT) index and an array of encoded values.

Methods in org.opends.server.types that return Attribute

Modifier and Type	Method	Description
Attribute	VirtualAttributeRule.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 or null if it is virtual.

Methods in org.opends.server.types that return types with arguments of type Attribute

Modifier and Type	Method	Description
Iterable<Attribute>	CompactEntry.getAllAttributes()
List<Attribute>	SubEntry.getCollectiveAttributes()	Getter for collective attributes contained within this subentry.

Methods in org.opends.server.types with parameters of type Attribute

Modifier and Type	Method	Description
protected 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 as attribute.
static Attribute	Entries.getRealAttributeOrNull(Attribute attribute)	Returns the provided attribute if it is real or null if it is virtual.

Uses of Attribute in org.opends.server.types.operation

Methods in org.opends.server.types.operation that return types with arguments of type Attribute

Modifier and Type	Method	Description
Iterable<Attribute>	PostCommitAddOperation.getAllAttributes()	Retrieves the set of attributes as read from the client request.
Iterable<Attribute>	PostOperationAddOperation.getAllAttributes()	Retrieves the set of processed user attributes for the entry to add.
Iterable<Attribute>	PostResponseAddOperation.getAllAttributes()	Retrieves the set of attributes as read from the client request.
Iterable<Attribute>	PostSynchronizationAddOperation.getAllAttributes()	Retrieves the set of attributes as read from the client request.
Iterable<Attribute>	PreOperationAddOperation.getAllAttributes()	Retrieves the set of attributes as read from the client request.
Iterable<Attribute>	PreParseAddOperation.getAllAttributes()	Retrieves the set of attributes as read from the client request.

Methods in org.opends.server.types.operation with parameters of type Attribute

Modifier and Type	Method	Description
void	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 in attribute to this entry, replacing any existing attribute values (optional operation).