Uses of Package
org.forgerock.opendj.ldap

Packages that use org.forgerock.opendj.ldap

Package	Description
com.sun.identity.idm	Provides classes for accessing the Identity Repository interfaces.
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.
org.forgerock.opendj.ldap.schema	Classes and interfaces for constructing and querying LDAP schemas.
org.forgerock.opendj.ldap.spi	Interfaces and classes for service providers.
org.forgerock.opendj.ldif	Classes and interfaces for reading and writing LDIF.
org.forgerock.opendj.security	An LDAP based security provider having the name "OpenDJ" and exposing an LDAP/LDIF based KeyStore service.

Classes in org.forgerock.opendj.ldap used by com.sun.identity.idm

Class and Description
ResultCode An operation result code as defined in RFC 4511 section 4.1.9 is used to indicate the final status of an operation.

Classes in org.forgerock.opendj.ldap used by org.forgerock.openam.ldap

Class and Description
Attribute An attribute, comprising of an attribute description and zero or more attribute values.
Connection A connection with a Directory Server over which read and update operations may be performed.
ConnectionFactory A connection factory provides an interface for obtaining a connection to a Directory Server.
Dn A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.
Filter A search filter as defined in RFC 4511.
LdapConnectionFactory A factory class which can be used to obtain connections to an LDAP Directory Server.
Rdn A relative distinguished name (RDN) as defined in RFC 4512 section 2.3 is the name of an entry relative to its immediate superior.
SearchScope A Search operation search scope as defined in RFC 4511 section 4.5.1.2 is used to specify the scope of a Search operation.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.io

Class and Description
Attribute An attribute, comprising of an attribute description and zero or more attribute values.
ByteSequence A ByteSequence is a readable sequence of byte values.
ByteSequenceReader An interface for iteratively reading data from a ByteSequence .
ByteString An immutable sequence of bytes backed by a byte array.
ByteStringBuilder A mutable sequence of bytes backed by a byte array.
DecodeOptions Decode options allow applications to control how requests and responses are decoded.
Entry An entry, comprising of a distinguished name and zero or more attributes.
Filter A search filter as defined in RFC 4511.
Modification A modification to be performed on an entry during a Modify operation.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.ldap

Class and Description
AbstractAttribute This class provides a skeletal implementation of the Attribute interface, to minimize the effort required to implement this interface.
AbstractConnection This class provides a skeletal implementation of the Connection interface, to minimize the effort required to implement this interface.
AbstractEntry This class provides a skeletal implementation of the Entry interface, to minimize the effort required to implement this interface.
AbstractMapEntry Abstract implementation for Map based entries.
AddressMask An address mask can be used to perform efficient comparisons against IP addresses to determine whether a particular IP address is in a given range.
Assertion A compiled attribute value assertion.
Attribute An attribute, comprising of an attribute description and zero or more attribute values.
AttributeDescription An attribute description as defined in RFC 4512 section 2.5.
AttributeFilter A configurable factory for filtering the attributes exposed by an entry.
AttributeParser A fluent API for parsing attributes as different types of object.
Ava An attribute value assertion (AVA) as defined in RFC 4512 section 2.3 consists of an attribute description with zero options and an attribute value.
ByteSequence A ByteSequence is a readable sequence of byte values.
ByteSequenceReader An interface for iteratively reading data from a ByteSequence .
ByteString An immutable sequence of bytes backed by a byte array.
ByteStringBuilder A mutable sequence of bytes backed by a byte array.
ConditionResult The result of a tri-state logical expression.
Connection A connection with a Directory Server over which read and update operations may be performed.
ConnectionEventListener An object that registers to be notified when a connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
ConnectionFactory A connection factory provides an interface for obtaining a connection to a Directory Server.
ConnectionPool An LDAP client which maintains and re-uses a pool of connections.
ConnectionSecurity Indicates whether LDAP client connections should use SSL or StartTLS.
ConsistentHashMap An implementation of "consistent hashing" supporting per-partition weighting.
DecodeException Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way.
DecodeOptions Decode options allow applications to control how requests and responses are decoded.
DereferenceAliasesPolicy A Search operation alias dereferencing policy as defined in RFC 4511 section 4.5.1.3 is used to indicate whether alias entries (as defined in RFC 4512) are to be dereferenced during stages of a Search operation.
Dn A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.
Entries.DiffStrategy Defines the available strategy to compute changes.
Entries.ReplaceStrategy Defines the available strategy to generate changes.
Entry An entry, comprising of a distinguished name and zero or more attributes.
EntryNotFoundException Thrown when the result code returned in a Result indicates that the Request failed because the target entry was not found by the Directory Server.
Filter A search filter as defined in RFC 4511.
Filter.FilterType This enumeration defines the set of possible filter types that may be used for search filters.
GeneralizedTime An LDAP generalized time as defined in RFC 4517.
GserParser This class implements a parser for strings which are encoded using the Generic String Encoding Rules (GSER) defined in RFC 3641.
IntermediateResponseHandler A completion handler for consuming intermediate responses returned from extended operations, or other operations for which an appropriate control was sent.
LdapClient An LDAP client provides an interface for obtaining a connection to a Directory Server.
LdapClientSocket A connection with a Directory Server over which read and update operations may be performed.
LdapException Thrown when the result code returned in a Result indicates that the Request was unsuccessful.
LdapPromise A handle which can be used to retrieve the Result of an asynchronous Request.
LdapSession Server side representation of a connected LDAP client.
LdapSessionCompletionListener A listener interface for handling LdapSession termination.
LdapUrl An LDAP URL as defined in RFC 4516.
LinkedHashMapEntry An implementation of the Entry interface which uses a LinkedHashMap for storing attributes.
LoadBalancerEventListener An object that registers to be notified when an LDAP client associated with a load-balancer changes state from offline to online or vice-versa.
Matcher A compiled search Filter which may be used for matching against entries.
Matcher.MatcherType The types of compiled matcher.
MemoryBackend A simple in-memory back-end which can be used for testing.
Modification A modification to be performed on an entry during a Modify operation.
ModificationType A Modify operation change type as defined in RFC 4511 section 4.6 is used to specify the type of modification being performed on an attribute.
ModificationType.Enum Contains equivalent values for the ModificationType values.
Rdn A relative distinguished name (RDN) as defined in RFC 4512 section 2.3 is the name of an entry relative to its immediate superior.
RequestHandle Provides the ability to terminate an asynchronous LDAP request.
ResultCode An operation result code as defined in RFC 4511 section 4.1.9 is used to indicate the final status of an operation.
ResultCode.Enum Contains equivalent values for the ResultCode values.
RootDse The root DSE is a DSA-specific Entry (DSE) and not part of any naming context (or any subtree), and which is uniquely identified by the empty DN.
SchemaResolver Schema resolvers are included with a set of DecodeOptions in order to allow application to control how Schema instances are selected when decoding requests and responses.
SearchResultHandler A completion handler for consuming the results of a Search operation.
SearchScope A Search operation search scope as defined in RFC 4511 section 4.5.1.2 is used to specify the scope of a Search operation.
SearchScope.Enum Contains equivalent values for the SearchScope values.
SortKey A search result sort key as defined in RFC 2891 is used to specify how search result entries should be ordered.
TimeoutScheduler.TimeoutEventListener Listener on timeout events.
TreeMapEntry An implementation of the Entry interface which uses a TreeMap for storing attributes.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.ldap.controls

Class and Description
AttributeDescription An attribute description as defined in RFC 4512 section 2.5.
ByteString An immutable sequence of bytes backed by a byte array.
DecodeException Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way.
DecodeOptions Decode options allow applications to control how requests and responses are decoded.
Dn A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.
Entry An entry, comprising of a distinguished name and zero or more attributes.
Filter A search filter as defined in RFC 4511.
ResultCode An operation result code as defined in RFC 4511 section 4.1.9 is used to indicate the final status of an operation.
SortKey A search result sort key as defined in RFC 2891 is used to specify how search result entries should be ordered.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.ldap.messages

Class and Description
Attribute An attribute, comprising of an attribute description and zero or more attribute values.
AttributeDescription An attribute description as defined in RFC 4512 section 2.5.
ByteString An immutable sequence of bytes backed by a byte array.
DecodeException Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way.
DecodeOptions Decode options allow applications to control how requests and responses are decoded.
DereferenceAliasesPolicy A Search operation alias dereferencing policy as defined in RFC 4511 section 4.5.1.3 is used to indicate whether alias entries (as defined in RFC 4512) are to be dereferenced during stages of a Search operation.
Dn A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.
Entry An entry, comprising of a distinguished name and zero or more attributes.
Filter A search filter as defined in RFC 4511.
LdapException Thrown when the result code returned in a Result indicates that the Request was unsuccessful.
Modification A modification to be performed on an entry during a Modify operation.
ModificationType A Modify operation change type as defined in RFC 4511 section 4.6 is used to specify the type of modification being performed on an attribute.
Rdn A relative distinguished name (RDN) as defined in RFC 4512 section 2.3 is the name of an entry relative to its immediate superior.
ResultCode An operation result code as defined in RFC 4511 section 4.1.9 is used to indicate the final status of an operation.
SearchScope A Search operation search scope as defined in RFC 4511 section 4.5.1.2 is used to specify the scope of a Search operation.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.ldap.schema

Class and Description
Assertion A compiled attribute value assertion.
AttributeDescription An attribute description as defined in RFC 4512 section 2.5.
ByteSequence A ByteSequence is a readable sequence of byte values.
ByteString An immutable sequence of bytes backed by a byte array.
Connection A connection with a Directory Server over which read and update operations may be performed.
DecodeException Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way.
Dn A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.
Entry An entry, comprising of a distinguished name and zero or more attributes.
LdapClientSocket A connection with a Directory Server over which read and update operations may be performed.
LdapException Thrown when the result code returned in a Result indicates that the Request was unsuccessful.
LdapPromise A handle which can be used to retrieve the Result of an asynchronous Request.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.ldap.spi

Class and Description
AttributeDescription An attribute description as defined in RFC 4512 section 2.5.
ByteSequence A ByteSequence is a readable sequence of byte values.
ByteString An immutable sequence of bytes backed by a byte array.
ConnectionEventListener An object that registers to be notified when a connection is closed by the application, receives an unsolicited notification, or experiences a fatal error.
DecodeException Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way.
LdapException Thrown when the result code returned in a Result indicates that the Request was unsuccessful.
LdapPromise A handle which can be used to retrieve the Result of an asynchronous Request.
LdapResultHandler A completion handler for consuming the result of an asynchronous operation or connection attempts.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.ldif

Class and Description
AttributeDescription An attribute description as defined in RFC 4512 section 2.5.
Connection A connection with a Directory Server over which read and update operations may be performed.
DecodeException Thrown when data from an input source cannot be decoded, perhaps due to the data being malformed in some way.
Dn A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.
Entry An entry, comprising of a distinguished name and zero or more attributes.
Filter A search filter as defined in RFC 4511.
LdapException Thrown when the result code returned in a Result indicates that the Request was unsuccessful.
SearchResultReferenceIOException Thrown when an iteration over a set of search results using a ConnectionEntryReader encounters a SearchResultReference.

Classes in org.forgerock.opendj.ldap used by org.forgerock.opendj.security

Class and Description
ByteSequence A ByteSequence is a readable sequence of byte values.
ConnectionFactory A connection factory provides an interface for obtaining a connection to a Directory Server.
Dn A distinguished name (DN) as defined in RFC 4512 section 2.3 is the concatenation of its relative distinguished name (RDN) and its immediate superior's DN.