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.ldif |
Classes and interfaces for reading and writing LDIF.
|
org.forgerock.opendj.rest2ldap |
APIs for implementing REST to LDAP gateways.
|
org.opends.guitools.controlpanel.ui |
Contains the panels and dialogs displayed in the Control Panel.
|
org.opends.server.api |
Contains a number of API declarations for use throughout the
Directory Server.
|
org.opends.server.core |
Contains various classes that comprise the core of the Directory Server codebase.
|
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.
|
org.opends.server.util |
Contains implementations for various Directory Server utility classes and methods which may be used throughout the
server but do not necessarily fit in elsewhere.
|
Modifier and Type | Method and 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(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. |
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. |
static AttributeDescription |
Functions.byteStringToAttributeDescription(ByteString value,
Schema schema)
Parses a
ByteString as an AttributeDescription using the provided schema. |
static AttributeDescription |
AttributeDescription.create(AttributeType attributeType)
Creates an attribute description having the provided attribute type and no options.
|
static AttributeDescription |
AttributeDescription.create(AttributeType attributeType,
Collection<String> options)
Creates an attribute description having the provided attribute type and options.
|
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,
String option)
Creates an attribute description having the provided attribute type and single option.
|
static AttributeDescription |
AttributeDescription.create(String attributeName,
AttributeType attributeType)
Deprecated.
This method may be removed at any time
|
static AttributeDescription |
AttributeDescription.create(String attributeName,
AttributeType attributeType,
Collection<String> options)
Deprecated.
This method may be removed at any time
|
static AttributeDescription |
AttributeDescription.create(String attributeName,
AttributeType attributeType,
String... options)
Deprecated.
This method may be removed at any time
|
static AttributeDescription |
AttributeDescription.create(String attributeName,
AttributeType attributeType,
String option)
Deprecated.
This method may be removed at any time
|
AttributeDescription |
LinkedAttribute.getAttributeDescription() |
AttributeDescription |
Attribute.getAttributeDescription()
Returns the attribute description of this attribute, which includes its
attribute type and any options.
|
abstract AttributeDescription |
AbstractAttribute.getAttributeDescription() |
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.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.
|
Modifier and Type | Method and Description |
---|---|
Set<AttributeDescription> |
AttributeParser.asSetOfAttributeDescription()
Returns the values decoded as a set of
AttributeDescription s
using the schema associated with this parser, or an empty set if the
attribute does not contain any values. |
Set<AttributeDescription> |
AttributeParser.asSetOfAttributeDescription(AttributeDescription... defaultValues)
Returns the values decoded as a set of
AttributeDescription s
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
AttributeDescription s
using the schema associated with this parser, or defaultValues if
the attribute does not contain any values. |
Set<AttributeDescription> |
AttributeParser.asSetOfAttributeDescription(String... defaultValues)
Returns the values decoded as a set of
AttributeDescription s
using the schema associated with this parser, or defaultValues if
the attribute does not contain any values. |
Modifier and Type | Method and Description |
---|---|
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
AttributeDescription s
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.
|
static Attribute |
Attributes.emptyAttribute(AttributeDescription attributeDescription)
Returns a read-only empty attribute having the specified attribute
description.
|
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> |
AbstractEntry.getAllAttributes(AttributeDescription attributeDescription) |
Attribute |
Entry.getAttribute(AttributeDescription attributeDescription)
Returns the named attribute contained in this entry, or
null if
it is not included with this entry. |
Attribute |
AbstractEntry.getAttribute(AttributeDescription attributeDescription) |
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. |
Attribute |
AttributeFactory.newAttribute(AttributeDescription attributeDescription)
Creates an attribute using the provided attribute description and no
values.
|
AttributeParser |
Entry.parseAttribute(AttributeDescription attributeDescription)
Returns a parser for the named attribute contained in this entry.
|
AttributeParser |
AbstractEntry.parseAttribute(AttributeDescription attributeDescription) |
boolean |
Entry.removeAttribute(AttributeDescription attributeDescription)
Removes the named attribute from this entry if it is present (optional
operation).
|
boolean |
AbstractEntry.removeAttribute(AttributeDescription attributeDescription) |
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.
|
Modifier and Type | Method and Description |
---|---|
Set<AttributeDescription> |
AttributeParser.asSetOfAttributeDescription(Collection<AttributeDescription> defaultValues)
Returns the values decoded as a set of
AttributeDescription s
using the schema associated with this parser, or defaultValues if
the attribute does not contain any values. |
Constructor and Description |
---|
LinkedAttribute(AttributeDescription attributeDescription)
Creates a new attribute having the specified attribute description and no
attribute values.
|
LinkedAttribute(AttributeDescription attributeDescription,
Collection<?> values)
Creates a new attribute having the specified attribute description and
attribute values.
|
LinkedAttribute(AttributeDescription attributeDescription,
Object... values)
Creates a new attribute having the specified attribute description and
attribute values.
|
LinkedAttribute(AttributeDescription attributeDescription,
Object value)
Creates a new attribute having the specified attribute description and
single attribute value.
|
SortKey(AttributeDescription attributeDescription,
boolean isReverseOrder,
MatchingRule orderingMatchingRule)
Creates a new sort key using the provided attribute description.
|
Modifier and Type | Method and Description |
---|---|
AttributeDescription |
ServerSideSortResponseControl.getAttributeDescription()
Returns the first attribute description specified in the list of sort
keys that was in error, or
null if the attribute description was
not included with this control. |
Modifier and Type | Method and Description |
---|---|
static ServerSideSortResponseControl |
ServerSideSortResponseControl.newControl(ResultCode result,
AttributeDescription attributeDescription)
Creates a new server-side response control with the provided sort result
and attribute description.
|
Modifier and Type | Method and Description |
---|---|
AttributeDescription |
CompareRequest.getAttributeDescription()
Returns the name of the attribute to be compared.
|
Modifier and Type | Method and Description |
---|---|
Iterable<Attribute> |
SearchResultEntry.getAllAttributes(AttributeDescription attributeDescription) |
Iterable<Attribute> |
AddRequest.getAllAttributes(AttributeDescription attributeDescription) |
Attribute |
SearchResultEntry.getAttribute(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 |
SearchResultEntry.removeAttribute(AttributeDescription attributeDescription) |
boolean |
AddRequest.removeAttribute(AttributeDescription attributeDescription) |
CompareRequest |
CompareRequest.setAttributeDescription(AttributeDescription attributeDescription)
Sets the name of the attribute to be compared.
|
Modifier and Type | Method and Description |
---|---|
LdifEntryWriter |
LdifEntryWriter.setExcludeAttribute(AttributeDescription attributeDescription)
Excludes the named attribute from any entries that are written to LDIF.
|
LdifEntryReader |
LdifEntryReader.setExcludeAttribute(AttributeDescription attributeDescription)
Excludes the named attribute from any entries that are read from LDIF.
|
LdifChangeRecordWriter |
LdifChangeRecordWriter.setExcludeAttribute(AttributeDescription attributeDescription)
Excludes the named attribute from any change records that are written to
LDIF.
|
LdifChangeRecordReader |
LdifChangeRecordReader.setExcludeAttribute(AttributeDescription attributeDescription)
Excludes the named attribute from any change records 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.
|
LdifEntryReader |
LdifEntryReader.setIncludeAttribute(AttributeDescription attributeDescription)
Ensures that the named attribute is not excluded from any entries 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.
|
LdifChangeRecordReader |
LdifChangeRecordReader.setIncludeAttribute(AttributeDescription attributeDescription)
Ensures that the named attribute is not excluded from any change records
that are read from LDIF.
|
Modifier and Type | Method and Description |
---|---|
static JsonPropertyMapper |
Rest2Ldap.json(AttributeDescription attribute)
Returns a property mapper which provides a mapping from a JSON value to a LDAP attribute having the JSON syntax.
|
static ReferencePropertyMapper |
Rest2Ldap.reference(AttributeDescription attribute,
String baseDnTemplate,
AttributeDescription primaryKey,
PropertyMapper mapper)
Returns a property mapper which provides a mapping from a JSON value to a single DN valued LDAP attribute.
|
static SimplePropertyMapper |
Rest2Ldap.simple(AttributeDescription attribute)
Returns a property mapper which provides a simple mapping from a JSON value to a single LDAP attribute.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
ViewEntryPanel.isEditable(AttributeDescription attrDesc,
Schema schema)
Returns whether the provided attribute name is an editable attribute.
|
Modifier and Type | Method and Description |
---|---|
protected Iterable<Map.Entry<byte[],AttributeDescription>> |
CompressedSchema.getAllAttributes()
Returns a view of the encoded attributes in this compressed schema which can be used for saving the entire
content to disk.
|
Modifier and Type | Method and Description |
---|---|
protected void |
CompressedSchema.storeAttribute(byte[] encodedAttribute,
AttributeDescription attrDesc)
Persists the provided encoded attribute.
|
Modifier and Type | Method and Description |
---|---|
AttributeDescription |
CompareOperationBasis.getAttributeDescription() |
AttributeDescription |
CompareOperation.getAttributeDescription()
Retrieves the attribute description for this compare operation.
|
Modifier and Type | Method and Description |
---|---|
protected void |
DefaultCompressedSchema.storeAttribute(byte[] encodedAttribute,
AttributeDescription attrDesc) |
Modifier and Type | Method and Description |
---|---|
AttributeDescription |
VirtualAttribute.getAttributeDescription() |
AttributeDescription |
CollectiveVirtualAttribute.getAttributeDescription() |
AttributeDescription |
Attribute.getAttributeDescription()
Retrieves the attribute description for this attribute.
|
Modifier and Type | Method and Description |
---|---|
static Attribute |
Attributes.create(AttributeDescription attributeDescription,
ByteString value)
Creates a new single-valued attribute with the specified attribute description and value.
|
Iterable<Attribute> |
Entry.getAllAttributes(AttributeDescription attributeDescription)
Retrieves the requested attribute element(s) for the specified attribute description.
|
Attribute |
Entry.getAttribute(AttributeDescription attributeDescription)
Retrieves the requested attribute element for the specified attribute type and options or
null if this
entry does not contain an attribute with the specified attribute type and options. |
List<Attribute> |
Entry.getOperationalAttribute(AttributeDescription attributeDescription)
Retrieves the requested operational attribute element(s) for the specified attribute type.
|
boolean |
Entry.hasAttribute(AttributeDescription attributeDescription)
Indicates whether this entry contains the specified attribute with all of the options in the provided set.
|
boolean |
Entry.hasValue(AttributeDescription attributeDescription,
ByteString value)
Indicates whether this entry contains the specified attribute value.
|
boolean |
AttributeBuilder.optionsEqual(AttributeDescription attributeDescription)
Indicates whether this attribute builder has exactly the specified set of options.
|
Constructor and Description |
---|
AttributeBuilder(AttributeDescription attributeDescription)
Creates a new attribute builder with the specified description.
|
SearchFilter(FilterType filterType,
Collection<SearchFilter> filterComponents,
SearchFilter notComponent,
AttributeDescription attributeDescription,
ByteString assertionValue,
ByteString subInitialElement,
List<ByteString> subAnyElements,
ByteString subFinalElement,
String matchingRuleID,
boolean dnAttributes)
Creates a new search filter with the provided information.
|
Modifier and Type | Method and Description |
---|---|
AttributeDescription |
PreOperationCompareOperation.getAttributeDescription()
Retrieves the attribute description for this compare operation.
|
AttributeDescription |
PostResponseCompareOperation.getAttributeDescription()
Retrieves the attribute description for this compare operation.
|
AttributeDescription |
PostOperationCompareOperation.getAttributeDescription()
Retrieves the attribute description for this compare operation.
|
Modifier and Type | Method and Description |
---|---|
static AttributeDescription |
LDIFReader.parseAttrDescription(String attrDescr)
Parse an AttributeDescription (an attribute type name and its options).
|
Copyright 2010-2020 ForgeRock AS.