Uses of Class
org.forgerock.opendj.ldap.AttributeDescription

Packages that use AttributeDescription

Package	Description
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 AttributeDescription in org.forgerock.opendj.ldap

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

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

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

Modifier and Type	Method	Description
AttributeDescription	AttributeParser.asAttributeDescription()	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or null if the attribute does not contain any values.
AttributeDescription	AttributeParser.asAttributeDescription(String defaultValue)	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
AttributeDescription	AttributeParser.asAttributeDescription(AttributeDescription defaultValue)	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
static AttributeDescription	Functions.byteStringToAttributeDescription(ByteString value, Schema schema)	Parses a ByteString as an AttributeDescription using the provided schema.
static AttributeDescription	AttributeDescription.create(String attributeName, AttributeType attributeType)	Creates an attribute description having the provided attribute name, type and no options.
static AttributeDescription	AttributeDescription.create(AttributeType attributeType)	Creates an attribute description having the provided attribute type and no options.
static AttributeDescription	AttributeDescription.create(AttributeType attributeType, String option)	Creates an attribute description having the provided attribute type and single option.
static AttributeDescription	AttributeDescription.create(AttributeType attributeType, String... options)	Creates an attribute description having the provided attribute type and options.
static AttributeDescription	AttributeDescription.create(AttributeType attributeType, Collection<String> options)	Creates an attribute description having the provided attribute type and options.
AttributeDescription	Attribute.getAttributeDescription()	Returns the attribute description of this attribute, which includes its attribute type and any options.
AttributeDescription	LinkedAttribute.getAttributeDescription()
AttributeDescription	Matcher.getAttributeDescription()	Returns the attribute description for this comparison filter Matcher, which may be null if the filter is an extensible match filter specifying an extensible matching rule.
static AttributeDescription	AttributeDescription.maxKey(AttributeType attributeType)	Returns an attribute description having the provided attribute type and a set of options which sorts after any other set of options.
static AttributeDescription	AttributeDescription.objectClass()	Returns an attribute description representing the object class attribute type with no options.
static AttributeDescription	AttributeDescription.valueOf(String attributeDescription)	Parses the provided LDAP string representation of an attribute description using the default schema.
static AttributeDescription	AttributeDescription.valueOf(String attributeDescription, Schema schema)	Parses the provided LDAP string representation of an attribute description using the provided schema.
AttributeDescription	AttributeDescription.withOption(String option)	Returns an attribute description having the same attribute type and options as this attribute description as well as the provided option.
AttributeDescription	AttributeDescription.withOptions(Iterable<String> options)	Returns an attribute description having the same attribute type and options as this attribute description as well as the provided options.
AttributeDescription	AttributeDescription.withOptions(String... options)	Returns an attribute description having the same attribute type and options as this attribute description as well as the provided options.
AttributeDescription	AttributeDescription.withoutAnyOptions()	Returns an attribute description having the same attribute type as this attribute description except that all options has been removed.
AttributeDescription	AttributeDescription.withoutOption(String option)	Returns an attribute description having the same attribute type and options as this attribute description except for the provided option.

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

Modifier and Type	Method	Description
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription()	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or an empty set if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(String... defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(Collection<AttributeDescription> defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(AttributeDescription... defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
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 AttributeDescription

Modifier and Type	Method	Description
MemoryBackend	MemoryBackend.addVirtualAttributes(AttributeDescription attributeDescription, BiFunction<Dn,MemoryBackend,Attribute> virtualAttributeFactory)	Adds a virtual attribute to the backend.
AttributeDescription	AttributeParser.asAttributeDescription(AttributeDescription defaultValue)	Returns the first value decoded as an AttributeDescription using the schema associated with this parser, or defaultValue if the attribute does not contain any values.
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(AttributeDescription... defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
int	AttributeDescription.compareTo(AttributeDescription other)	Compares this attribute description to the provided attribute description.
default boolean	Entry.containsAnyAttributes(AttributeDescription attributeDescription)	Returns true if this entry contains any non-empty attributes having an attribute description which is a sub-type of the provided attribute description.
boolean	TreeMapEntry.containsAnyAttributes(AttributeDescription attributeDescription)
default boolean	Entry.containsAttribute(AttributeDescription attributeDescription, Object... values)	Returns true if this entry contains all of the attribute values contained in values.
<T> T	Assertion.createIndexQuery(AttributeDescription attributeDescription, IndexQueryFactory<T> factory)	Returns an index query appropriate for the provided attribute value assertion.
static Attribute	Attributes.emptyAttribute(AttributeDescription attributeDescription)	Returns a read-only empty attribute having the specified 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)
Attribute	AbstractMapEntry.getAttribute(AttributeDescription attributeDescription)
default Attribute	Entry.getAttribute(AttributeDescription attributeDescription)	Returns the named attribute contained in this entry, or null if it is not included with this entry.
AttributeFilter	AttributeFilter.includeAttribute(AttributeDescription attributeDescription)	Specifies that the named attribute should be included in filtered entries.
boolean	AttributeDescription.isSubTypeOf(AttributeDescription other)	Indicates whether this attribute description is a sub-type of the provided attribute description as defined in RFC 4512 section 2.5.
boolean	AttributeDescription.isSuperTypeOf(AttributeDescription other)	Indicates whether this attribute description is a super-type of the provided attribute description as defined in RFC 4512 section 2.5.
boolean	AttributeDescription.matches(AttributeDescription other)	Indicates whether the provided attribute description matches this attribute description.
boolean	AttributeFilter.matchesAttribute(AttributeDescription attributeDescription)	Returns true if this attribute filter matches the provided attribute description.
static LinkedAttribute	LinkedAttribute.newPreSizedLinkedAttribute(AttributeDescription attributeDescription, int expectedValues)	Creates a new attribute having the specified attribute description and expected number of values.
default AttributeParser	Entry.parseAttribute(AttributeDescription attributeDescription)	Returns a parser for the named attribute contained in this entry.
default boolean	Entry.removeAttribute(AttributeDescription attributeDescription)	Removes the named attribute from this entry if it is present (optional operation).
static Attribute	Attributes.renameAttribute(Attribute attribute, AttributeDescription attributeDescription)	Returns a view of attribute having a different attribute description.
static Attribute	Attributes.singletonAttribute(AttributeDescription attributeDescription, Object value)	Returns a read-only single-valued attribute having the specified attribute description and value.
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.

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

Modifier and Type	Method	Description
Set<AttributeDescription>	AttributeParser.asSetOfAttributeDescription(Collection<AttributeDescription> defaultValues)	Returns the values decoded as a set of AttributeDescriptions using the schema associated with this parser, or defaultValues if the attribute does not contain any values.
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 AttributeDescription

Constructor	Description
LinkedAttribute(AttributeDescription attributeDescription)	Creates a new attribute having the specified attribute description and no attribute values.
LinkedAttribute(AttributeDescription attributeDescription, Object value)	Creates a new attribute having the specified attribute description and single attribute value.
LinkedAttribute(AttributeDescription attributeDescription, Object... values)	Creates a new attribute having the specified attribute description and attribute values.
LinkedAttribute(AttributeDescription attributeDescription, Collection<?> values)	Creates a new attribute having the specified attribute description and attribute values.
SortKey(AttributeDescription attributeDescription, boolean isReverseOrder, MatchingRule orderingMatchingRule)	Creates a new sort key using the provided attribute description.

Uses of AttributeDescription in org.forgerock.opendj.ldap.controls

Methods in org.forgerock.opendj.ldap.controls with parameters of type AttributeDescription

Modifier and Type	Method	Description
static ServerSideSortResponseControl	ServerSideSortResponseControl.newControl(ResultCode result, AttributeDescription attributeDescription)	Creates a new server-side response control with the provided sort result and attribute description.

Uses of AttributeDescription in org.forgerock.opendj.ldap.messages

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

Modifier and Type	Method	Description
AttributeDescription	CompareRequest.getAttributeDescription()	Returns the name of the attribute to be compared.

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

Modifier and Type	Method	Description
Iterable<Attribute>	AddRequest.getAllAttributes(AttributeDescription attributeDescription)
Attribute	AddRequest.getAttribute(AttributeDescription attributeDescription)
static CompareRequest	Requests.newCompareRequest(Dn name, AttributeDescription attributeDescription, Object assertionValue)	Creates a new compare request using the provided distinguished name, attribute name, and assertion value.
boolean	AddRequest.removeAttribute(AttributeDescription attributeDescription)
CompareRequest	CompareRequest.setAttributeDescription(AttributeDescription attributeDescription)	Sets the name of the attribute to be compared.

Uses of AttributeDescription in org.forgerock.opendj.ldap.schema

Methods in org.forgerock.opendj.ldap.schema that return AttributeDescription

Modifier and Type	Method	Description
AttributeDescription	AttributeType.toAttributeDescription()	Returns the option-less attribute description corresponding to this attribute type.

Methods in org.forgerock.opendj.ldap.schema with parameters of type AttributeDescription

Modifier and Type	Method	Description
T	IndexQueryFactory.createExactMatchQuery(AttributeDescription attributeDescription, String indexId, ByteString key)	Returns a query requesting an index record matching the provided key.
T	IndexQueryFactory.createMatchAllQuery(AttributeDescription attributeDescription)	Returns a query requesting all index records.
T	IndexQueryFactory.createRangeMatchQuery(AttributeDescription attributeDescription, String indexId, ByteString lower, ByteString upper, boolean lowerIncluded, boolean upperIncluded)	Returns a query requesting all index records in the specified range.
IndexingOptions	IndexQueryFactory.getIndexingOptionsOrNull(AttributeDescription attributeDescription)	Returns the indexing options for the provided attribute, or null if the attribute is not indexed.

Uses of AttributeDescription in org.forgerock.opendj.ldif

Methods in org.forgerock.opendj.ldif with parameters of type AttributeDescription

Modifier and Type	Method	Description
LdifChangeRecordReader	LdifChangeRecordReader.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any change records that are read from LDIF.
LdifChangeRecordWriter	LdifChangeRecordWriter.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any change records that are written to LDIF.
LdifEntryReader	LdifEntryReader.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any entries that are read from LDIF.
LdifEntryWriter	LdifEntryWriter.setExcludeAttribute(AttributeDescription attributeDescription)	Excludes the named attribute from any entries that are written to LDIF.
LdifChangeRecordReader	LdifChangeRecordReader.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any change records that are read from LDIF.
LdifChangeRecordWriter	LdifChangeRecordWriter.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any change records that are written to LDIF.
LdifEntryReader	LdifEntryReader.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any entries that are read from LDIF.
LdifEntryWriter	LdifEntryWriter.setIncludeAttribute(AttributeDescription attributeDescription)	Ensures that the named attribute is not excluded from any entries that are written to LDIF.