See: Description
Interface | Description |
---|---|
Assertion |
A compiled attribute value assertion.
|
Attribute |
An attribute, comprising of an attribute description and zero or more attribute values.
|
ByteSequence |
A
ByteSequence is a readable sequence of byte values. |
CancelRequestListener |
An object that registers to be notified when a cancellation request has been
received and processing of the request should be aborted if possible.
|
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.
|
Entry |
An entry, comprising of a distinguished name and zero or more attributes.
|
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.
|
LdapPromise<S> |
A handle which can be used to retrieve the Result of an asynchronous Request.
|
LdapResultHandler<S> |
A completion handler for consuming the result of an asynchronous operation or
connection attempts.
|
LdapSession |
Server side representation of a connected LDAP client.
|
LdapSessionCompletionListener |
A listener interface for handling
LdapSession termination. |
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.
|
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.
|
TimeoutScheduler.TimeoutEventListener |
Listener on timeout events.
|
Class | Description |
---|---|
AbstractAsynchronousConnection |
An abstract connection whose synchronous methods are implemented in terms of
asynchronous methods.
|
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. |
AbstractConnectionWrapper<C extends Connection> |
An abstract base class from which connection wrappers may be easily
implemented.
|
AbstractEntry |
This class provides a skeletal implementation of the
Entry interface, to minimize the effort required to
implement this interface. |
AbstractMapEntry<M extends Map<AttributeDescription,Attribute>> |
Abstract implementation for
Map based entries. |
AbstractSynchronousConnection |
An abstract connection whose asynchronous methods are implemented in terms of
synchronous methods.
|
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.
|
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.
|
Attributes |
This class contains methods for creating and manipulating attributes.
|
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.
|
Base64 |
This class provides methods for performing base64 encoding and decoding.
|
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.
|
Connections |
This class contains methods for creating and manipulating LDAP clients and connections.
|
ConsistentHashMap<P> |
An implementation of "consistent hashing" supporting per-partition weighting.
|
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 |
This class contains methods for creating and manipulating entries.
|
Entries.NullEntry |
An
Entry which implements the null object pattern. |
Filter |
A search filter as defined in RFC 4511.
|
Functions |
Common
Function implementations which may be used when parsing attributes. |
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.
|
LdapClients |
This class contains methods for creating and manipulating LDAP clients and connections.
|
LdapConnectionFactory |
A factory class which can be used to obtain connections to an LDAP Directory Server.
|
LdapServer |
An LDAP server connection listener which waits for LDAP connection requests to come in over the network and binds
them to a server connection created using the provided server connection factory.
|
LdapUrl |
An LDAP URL as defined in RFC 4516.
|
LinkedAttribute |
An implementation of the
Attribute interface with predictable iteration order. |
LinkedHashMapEntry |
An implementation of the
Entry interface which uses a LinkedHashMap for storing attributes. |
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.
|
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.
|
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.
|
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.
|
SortKey |
A search result sort key as defined in RFC 2891 is used to specify how search
result entries should be ordered.
|
TimeoutScheduler |
Invokes
TimeoutScheduler.TimeoutEventListener at a regular interval. |
TreeMapEntry |
An implementation of the
Entry interface which uses a TreeMap for storing attributes. |
Utils |
This class provides utility functions.
|
Enum | Description |
---|---|
ConditionResult |
The result of a tri-state logical expression.
|
ConnectionSecurity |
Indicates whether LDAP client connections should use SSL or StartTLS.
|
Entries.DiffStrategy |
Defines the available strategy to compute changes.
|
Entries.ReplaceStrategy |
Defines the available strategy to generate changes.
|
Filter.FilterType |
This enumeration defines the set of possible filter types that may be used for search filters.
|
Matcher.MatcherType |
The types of compiled matcher.
|
ModificationType.Enum |
Contains equivalent values for the ModificationType values.
|
ResultCode.Enum |
Contains equivalent values for the ResultCode values.
|
SearchScope.Enum |
Contains equivalent values for the SearchScope values.
|
Exception | Description |
---|---|
AssertionFailureException |
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.
|
AuthenticationException |
Thrown when the result code returned in a Result indicates that the Bind
Request failed due to an authentication failure.
|
AuthorizationException |
Thrown when the result code returned in a Result indicates that the Request
failed due to an authorization failure.
|
CancelledResultException |
Thrown when the result code returned in a Result indicates that the Request
was cancelled.
|
ConnectionException |
Thrown when the result code returned in a Result indicates that the Request
was unsuccessful because of a connection failure.
|
ConstraintViolationException |
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.
|
DecodeException |
Thrown when data from an input source cannot be decoded, perhaps due to the
data being malformed in some way.
|
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.
|
LdapException |
Thrown when the result code returned in a Result indicates that the Request
was unsuccessful.
|
MultipleEntriesFoundException |
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.
|
ProviderNotFoundException |
Exception thrown when a provider of a service can't be found.
|
ReferralException |
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.
|
SearchResultReferenceIOException |
Thrown when an iteration over a set of search results using a
ConnectionEntryReader encounters a SearchResultReference . |
TimeoutResultException |
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.
|
Copyright 2010-2022 ForgeRock AS.