See: Description
Interface | Description |
---|---|
Assertion |
A compiled attribute value assertion.
|
Attribute |
An attribute, comprising of an attribute description and zero or more
attribute values.
|
AttributeFactory |
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. |
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 |
A connection factory which maintains and re-uses a pool of connections.
|
ConnectionSecurityLayer |
An interface for providing additional connection security to a connection.
|
Entry |
An entry, comprising of a distinguished name and zero or more attributes.
|
EntryFactory |
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. |
FilterVisitor<R,P> |
A visitor of
Filter s, in the style of the visitor design pattern. |
IntermediateResponseHandler |
A completion handler for consuming intermediate responses returned from
extended operations, or other operations for which an appropriate control was
sent.
|
LDAPClientContext |
An LDAP client which has connected to a
ServerConnectionFactory . |
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.
|
LoadBalancerEventListener |
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.
|
RequestContext |
The context associated with a request currently being processed by a request
handler.
|
RequestHandler<C> |
A handler interface for processing client requests.
|
RequestHandlerFactory<C,R extends RequestContext> |
A handler interface for accepting new connections from clients.
|
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.
|
ServerConnection<C> |
A handler interface for interacting with client connections.
|
ServerConnectionFactory<C,R> |
A handler interface for accepting new connections from clients.
|
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. |
AbstractFilterVisitor<R,P> |
An abstract filter visitor whose default implementation for all
Visitor methods is to invoke AbstractFilterVisitor.visitDefaultFilter(Object) . |
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.
|
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 connection
factories and connections.
|
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.DiffOptions |
Options for controlling the behavior of the
diffEntries
method. |
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.
|
KeyManagers |
This class contains methods for creating common types of key manager.
|
LDAPConnectionFactory |
A factory class which can be used to obtain connections to an LDAP Directory Server.
|
LDAPListener |
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 . |
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 |
An interface for determining whether entries match a
Filter . |
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.
|
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.
|
SSLContextBuilder |
An SSL context builder provides an interface for incrementally constructing
SSLContext instances for use when securing connections with SSL or
the StartTLS extended operation. |
TimeoutChecker |
Checks
TimeoutEventListener listeners for events that have timed out. |
TreeMapEntry |
An implementation of the
Entry interface which uses a TreeMap
for storing attributes. |
TrustManagers |
This class contains methods for creating common types of trust manager.
|
Enum | Description |
---|---|
ConditionResult |
The result of a tri-state logical expression.
|
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-2017 ForgeRock AS.