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

Packages that use Attribute

Package	Description
org.forgerock.openam.ldap	This package contains utility methods to ease/unify development when using the OpenDJ LDAP SDK.
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.

Uses of Attribute in org.forgerock.openam.ldap

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

Modifier and Type	Method	Description
static void	LDAPUtils.addAttributeToMapAsByteArray(Attribute attribute, Map<String,byte[][]> map)	Converts the Attribute to an attribute name, 2-dimensional byte array map and adds it to the map passed in.
static void	LDAPUtils.addAttributeToMapAsString(Attribute attribute, Map<String,Set<String>> map)	Converts the Attribute to an attribute name, set of String values map and adds it to the map passed in.
static Set<String>	LDAPUtils.getAttributeValuesAsStringSet(Attribute attribute)	Converts all the attribute values to a String Set.

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 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)