All Classes and Interfaces
Class
Description
The Abandon operation allows a client to request that the server abandon an
uncompleted operation.
An abstract
ASN1Reader which can be used as the basis for
implementing new ASN1 reader implementations.An abstract
ASN1Writer which can be used as the basis for
implementing new ASN1 writer implementations.An abstract connection whose synchronous methods are implemented in terms of
asynchronous methods.
This class provides a skeletal implementation of the
Attribute
interface, to minimize the effort required to implement this interface.This class provides a skeletal implementation of the
Connection
interface, to minimize the effort required to implement this interface.An abstract base class from which connection wrappers may be easily
implemented.
This class provides a skeletal implementation of the
Entry interface,
to minimize the effort required to implement this interface.An abstract Extended request which can be used as the basis for implementing
new Extended operations.
An abstract Extended result which can be used as the basis for implementing
new Extended operations.
This class provides a skeletal implementation of the
ExtendedResultDecoder interface, to minimize the effort required to
implement this interface.An abstract filter visitor whose default implementation for all
Visitor methods is to invoke AbstractFilterVisitor.visitDefaultFilter(Object).An abstract Intermediate response which can be used as the basis for
implementing new Intermediate responses.
This class provides a skeletal implementation of the
LDAPMessageHandler interface, in order to minimize the effort
required to implement this interface.An abstract connection whose asynchronous methods are implemented in terms of
synchronous methods.
The Add operation allows a client to request the addition of an entry into
the Directory.
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.
The persistent search request control for Active Directory as defined by
Microsoft.
The anonymous SASL bind request as defined in RFC 4505.
This class contains various static factory methods for creating ASN.1 readers
and writers.
An interface for decoding ASN.1 elements from a data source.
An interface for encoding ASN.1 elements to a data source.
A compiled attribute value assertion.
Thrown when the result code returned in a Result indicates that the Request
failed because the filter contained in an assertion control failed to match
the target entry.
The assertion request control as defined in RFC 4528.
An attribute, comprising of an attribute description and zero or more
attribute values.
An attribute description as defined in RFC 4512 section 2.5.
Attribute factories are included with a set of
DecodeOptions in order
to allow application to control how Attribute instances are created
when decoding requests and responses.A configurable factory for filtering the attributes exposed by an entry.
A fluent API for parsing attributes as different types of object.
This class contains methods for creating and manipulating attributes.
This class defines a data structure for storing and interacting with an
attribute type, which contains information about the format of an attribute
and the syntax and matching rules that should be used when interacting with
it.
A fluent API for incrementally constructing attribute type.
This enumeration defines the set of possible attribute usage values that may
apply to an attribute type, as defined in RFC 2252.
Thrown when the result code returned in a Result indicates that the Bind
Request failed due to an authentication failure.
Thrown when the result code returned in a Result indicates that the Request
failed due to an authorization failure.
The authorization request control as defined in RFC 3829.
The authorization response control as defined in RFC 3829.
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.
This class provides methods for performing base64 encoding and decoding.
An authentication client which can be used to bind to a server.
The Bind operation allows authentication information to be exchanged between
the client and server.
A Bind result indicates the status of the client's request for
authentication.
Bind result promise implementation.
A
ByteSequence is a readable sequence of byte values.An interface for iteratively reading data from a
ByteSequence .An immutable sequence of bytes backed by a byte array.
A mutable sequence of bytes backed by a byte array.
The cancel extended request as defined in RFC 3909.
Thrown when the result code returned in a Result indicates that the Request
was cancelled.
An object that registers to be notified when a cancellation request has been
received and processing of the request should be aborted if possible.
A request to modify the content of the Directory in some way.
An interface for reading change records from a data source, typically an LDIF
file.
A visitor of
ChangeRecords, in the style of the visitor design
pattern.An interface for writing change records to a data source, typically an LDIF
file.
Common options for LDAP clients and listeners.
The Compare operation allows a client to compare an assertion value with the
values of a particular attribute in a particular entry in the Directory.
An Compare result indicates the final status of an Compare operation.
The result of a tri-state logical expression.
Thrown when addition of a schema element to a schema builder fails because
the OID of the schema element conflicts with an existing schema element and
the caller explicitly requested not to override existing schema elements.
A connection with a Directory Server over which read and update operations
may be performed.
A
ConnectionChangeRecordWriter is a bridge from Connections
to ChangeRecordWriters.A
ConnectionEntryReader is a bridge from Connections to
EntryReaders.A
ConnectionEntryWriter is a bridge from Connections to
EntryWriters.An object that registers to be notified when a connection is closed by the
application, receives an unsolicited notification, or experiences a fatal
error.
Thrown when the result code returned in a Result indicates that the Request
was unsuccessful because of a connection failure.
A connection factory provides an interface for obtaining a connection to a
Directory Server.
A connection factory which maintains and re-uses a pool of connections.
This class contains methods for creating and manipulating connection
factories and connections.
An interface for providing additional connection security to a connection.
This class can be used to manage the internal state of a connection, ensuring
valid and atomic state transitions, as well as connection event listener
notification.
An implementation of "consistent hashing" supporting per-partition weighting.
Thrown when the result code returned in a Result indicates that the update
Request failed because it would have left the Directory in an inconsistent
state.
Controls provide a mechanism whereby the semantics and arguments of existing
LDAP operations may be extended.
A factory interface for decoding a control as a control of specific type.
The OpenDJ SDK core schema contains standard LDAP RFC schema elements.
Provides a map of supported locale tags to OIDs.
The CRAM-MD5 SASL bind request as defined in draft-ietf-sasl-crammd5.
Thrown when data from an input source cannot be decoded, perhaps due to the
data being malformed in some way.
Decode options allow applications to control how requests and responses are
decoded.
The Delete operation allows a client to request the removal of an entry from
the Directory.
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.
The DIGEST-MD5 SASL bind request as defined in RFC 2831.
This class defines a DIT content rule, which defines the set of allowed,
required, and prohibited attributes for entries with a given structural
objectclass, and also indicates which auxiliary classes may be included in
the entry.
A fluent API for incrementally constructing DIT content rule.
This class defines a DIT structure rule, which is used to indicate the types
of children that entries may have.
A fluent API for incrementally constructing DIT structure rules.
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.
This class contains methods for creating and manipulating entries.
Options for controlling the behavior of the
diffEntries
method.An entry, comprising of a distinguished name and zero or more attributes.
The entry change notification response control as defined in
draft-ietf-ldapext-psearch.
Entry factories are included with a set of
DecodeOptions in order to
allow application to control how Entry instances are created when
decoding requests and responses.A template driven entry generator, as used by the makeldif tool.
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.
An interface for reading entries from a data source, typically an LDIF file.
An interface for writing entries to a data source, typically an LDIF file.
The Extended operation allows additional operations to be defined for
services not already available in the protocol; for example, to implement an
operation which installs transport layer security (see
StartTLSExtendedRequest).A factory interface for decoding a generic extended request as an extended
request of specific type.
A Extended result indicates the status of an Extended operation and any
additional information associated with the Extended operation, including the
optional response name and value.
A factory interface for decoding a generic extended result as an extended
result of specific type.
Extended result promise implementation.
A service provider interface for externalizing the strategy used for wrapping individual private/secret keys.
The External SASL bind request as defined in RFC 4422.
A search filter as defined in RFC 4511.
A visitor of
Filters, in the style of the visitor design pattern.Common
Function implementations which may be used when parsing
attributes.An LDAP generalized time as defined in RFC 4517.
A generic Bind request which should be used for unsupported authentication
methods.
A generic control which can be used to represent arbitrary raw request and
response controls.
A generic Extended request which should be used for unsupported extended
operations.
A Generic Extended result indicates the final status of an Generic Extended
operation.
A Generic Intermediate response provides a mechanism for communicating
unrecognized or unsupported Intermediate responses to the client.
A partial implementation of the get effective rights request control as
defined in draft-ietf-ldapext-acl-model.
This class implements a parser for strings which are encoded using the
Generic String Encoding Rules (GSER) defined in RFC 3641.
The GSSAPI SASL bind request as defined in RFC 2831.
This class is registered with a Backend and it provides callbacks
for indexing attribute values.
Contains options indicating how indexing must be performed.
A factory for creating arbitrarily complex index queries.
An Intermediate response provides a general mechanism for defining
single-request/multiple-response operations.
A completion handler for consuming intermediate responses returned from
extended operations, or other operations for which an appropriate control was
sent.
This class contains methods for creating common types of key manager.
An in memory representation of a LDAP key store object.
A service provider interface for implementing key store caches.
The parameters which configure how the LDAP key store will be accessed.
This class contains various static utility methods encoding and decoding LDAP
protocol elements.
An LDAP client which has connected to a
ServerConnectionFactory.A listener interface for handling LDAPClientContext state changes.
A factory class which can be used to obtain connections to an LDAP Directory Server.
Interface for all classes that implement
LDAPConnectionFactory.LDAP connection interface which implementations of
LDAPConnectionFactoryImpl should implement.Thrown when the result code returned in a Result indicates that the Request
was unsuccessful.
An LDAP server connection listener which waits for LDAP connection requests
to come in over the network and binds them to a
ServerConnection
created using the provided ServerConnectionFactory.Interface for all classes that actually implement
LDAPListener.An interface for handling LDAP messages decoded using an
LDAPReader.Contains static methods to create ldap messages.
Represents a Ldap Request envelope containing an encoded Request.
Represents a
Response and its envelope.A handle which can be used to retrieve the Result of an asynchronous Request.
This class provides an implementation of the
LdapPromise.Utility methods for creating and composing
LdapPromises.Reads LDAP messages from an underlying ASN.1 reader.
A completion handler for consuming the result of an asynchronous operation or
connection attempts.
An LDAP URL as defined in RFC 4516.
Writes LDAP messages to an underlying ASN.1 writer.
This class contains common utility methods for creating and manipulating
readers and writers.
An LDIF change record reader reads change records using the LDAP Data
Interchange Format (LDIF) from a user defined source.
An LDIF change record writer writes change records using the LDAP Data
Interchange Format (LDIF) to a user defined destination.
An LDIF entry reader reads attribute value records (entries) using the LDAP
Data Interchange Format (LDIF) from a user defined source.
An LDIF entry writer writes attribute value records (entries) using the LDAP
Data Interchange Format (LDIF) to a user defined destination.
An implementation of the
Attribute interface with predictable
iteration order.An implementation of the
Entry interface which uses a
LinkedHashMap for storing attributes.An object that registers to be notified when a connection factory associated
with a load-balancer changes state from offline to online or vice-versa.
The ManageDsaIT request control as defined in RFC 3296.
The matched values request control as defined in RFC 3876.
An interface for determining whether entries match a
Filter.This class defines a data structure for storing and interacting with matching
rules, which are used by servers to compare attribute values against
assertion values when performing Search and Compare operations.
A fluent API for incrementally constructing matching rules.
This interface defines the set of methods that must be implemented to define
a new matching rule.
This class defines a data structure for storing and interacting with a
matching rule use definition, which may be used to restrict the set of
attribute types that may be used for a given matching rule.
A fluent API for incrementally constructing matching rule uses.
A simple in memory back-end which can be used for testing.
A modification to be performed on an entry during a Modify operation.
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.
Contains equivalent values for the ModificationType values.
The Modify DN operation allows a client to change the Relative Distinguished
Name (RDN) of an entry in the Directory and/or to move a subtree of entries
to a new location in the Directory.
The Modify operation allows a client to request that a modification of an
entry be performed on its behalf by a server.
Thrown when the result code returned in a Result indicates that the requested
single entry search operation or read operation failed because the Directory
Server returned multiple matching entries (or search references) when only a
single matching entry was expected.
This class defines a data structure for storing and interacting with a name
form, which defines the attribute type(s) that must and/or may be used in the
RDN of an entry with a given structural objectclass.
A fluent API for incrementally constructing name forms.
This class defines a data structure for storing and interacting with an
objectclass, which contains a collection of attributes that must and/or may
be present in an entry with that objectclass.
A fluent API for incrementally constructing object classes.
This enumeration defines the set of possible objectclass types that may be
used, as defined in RFC 2252.
The OpenDJ LDAP security provider which exposes an LDAP/LDIF based
KeyStore
service, as well as providing utility methods facilitating construction of LDAP/LDIF based key stores.Utility methods for accessing the LDAP schema elements required in order to support the OpenDJ security provider.
The Netscape password expired response control as defined in
draft-vchu-ldap-pwd-policy.
The Netscape password expiring response control as defined in
draft-vchu-ldap-pwd-policy.
The password modify extended request as defined in RFC 3062.
The password modify extended result as defined in RFC 3062.
A password policy error type as defined in draft-behera-ldap-password-policy
is used to indicate problems concerning a user's account or password.
The password policy request control as defined in
draft-behera-ldap-password-policy.
The password policy response control as defined in
draft-behera-ldap-password-policy.
A password policy warning type as defined in
draft-behera-ldap-password-policy is used to indicate the current state of a
user's password.
The Microsoft defined permissive modify request control.
A persistent search change type as defined in draft-ietf-ldapext-psearch is
used to indicate the type of update operation that caused an entry change
notification to occur.
The persistent search request control as defined in
draft-ietf-ldapext-psearch.
The Plain SASL bind request as defined in RFC 4616.
The post-read request control as defined in RFC 4527.
The post-read response control as defined in RFC 4527.
The pre-read request control as defined in RFC 4527.
The pre-read response control as defined in RFC 4527.
Interface for providers, which provide an implementation of one or more interfaces.
Exception thrown when a provider of a service can't be found.
The proxy authorization v1 request control as defined in
draft-weltman-ldapv3-proxy-04.
The proxy authorization v2 request control as defined in RFC 4370.
A relative distinguished name (RDN) as defined in RFC 4512 section 2.3 is the
name of an entry relative to its immediate superior.
Thrown when the result code returned in a Result indicates that the Request
could not be processed by the Directory Server because the target entry is
located on another server.
A listener interface which is notified whenever a change record cannot be
applied to an entry.
A listener interface which is notified whenever LDIF records are skipped,
malformed, or fail schema validation.
The base class of all Requests provides methods for querying and manipulating
the set of Controls included with a Request.
The context associated with a request currently being processed by a request
handler.
A handler interface for processing client requests.
A handler interface for accepting new connections from clients.
This class contains various methods for creating and manipulating requests.
The base class of all Responses provides methods for querying and
manipulating the set of Controls included with a Response.
This class contains various methods for creating and manipulating responses.
A Result is used to indicate the status of an operation performed by the
server.
An operation result code as defined in RFC 4511 section 4.1.9 is used to
indicate the final status of an operation.
Contains equivalent values for the ResultCode values.
This class provides an implementation of the
LdapPromise.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.
The SASL authentication method of the Bind operation allows clients to
authenticate using one of the SASL authentication methods defined in RFC
4513.
This class defines a data structure that holds information about the
components of the LDAP schema.
Schema builders should be used for incremental construction of new schemas.
Allows to perform modifications on element's builders before adding the result to this schema builder.
Interface for schema elements.
Common options for LDAP schemas.
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.This class provides various schema validation policy options for controlling
how entries should be validated against the directory schema.
An enumeration of the possible actions which can be performed when a
schema validation failure is encountered.
A call-back which will be called during DIT structure rule schema
validation in order to retrieve the parent of the entry being validated.
The Search operation is used to request a server to return, subject to access
controls and other restrictions, a set of entries matching a complex search
criterion.
A Search Result Entry represents an entry found during a Search operation.
A completion handler for consuming the results of a Search operation.
Search result promise implementation.
A Search Result Reference represents an area not yet explored during a Search
operation.
Thrown when an iteration over a set of search results using a
ConnectionEntryReader encounters a SearchResultReference.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.
Contains equivalent values for the SearchScope values.
Deprecated.
will be removed as part of OPENDJ-3467.
Deprecated.
will be removed as part of OPENDJ-3467.
The server-side sort request control as defined in RFC 2891.
The server-side sort response control as defined in RFC 2891.
The simple authentication method of the Bind Operation provides three
authentication mechanisms:
An anonymous authentication mechanism, in which both the name and
password are zero length.
The simple paged results request and response control as defined in RFC 2696.
A search result sort key as defined in RFC 2891 is used to specify how search
result entries should be ordered.
An SSL context builder provides an interface for incrementally constructing
SSLContext instances for use when securing connections with SSL or
the StartTLS extended operation.The start TLS extended request as defined in RFC 4511.
The sub-entries request control as defined in RFC 3672.
The tree delete request control as defined in draft-armijo-ldap-treedelete.
This class defines a data structure for storing and interacting with an LDAP
syntaxes, which constrain the structure of attribute values stored in an LDAP
directory, and determine the representation of attribute and assertion values
transferred in the LDAP protocol.
A fluent API for incrementally constructing syntaxes.
This interface defines the set of methods and structures that must be
implemented to define a new attribute syntax.
Checks
TimeoutEventListener listeners for events that have timed out.Listener on timeout events.
Thrown when the result code returned in a Result indicates that the Request
was aborted because it did not complete in the required time out period.
Interface for transport providers, which provide implementation
for
LDAPConnectionFactory and LDAPListener classes,
using a specific transport.An implementation of the
Entry interface which uses a TreeMap
for storing attributes.This class contains methods for creating common types of trust manager.
The Unbind operation allows a client to terminate an LDAP session.
Thrown when a schema query fails because the requested schema element could
not be found or is ambiguous.
The virtual list view request control as defined in
draft-ietf-ldapext-ldapv3-vlv.
The virtual list view response control as defined in
draft-ietf-ldapext-ldapv3-vlv.
The who am I extended request as defined in RFC 4532.
The who am I extended result as defined in RFC 4532.