@PublicAPI(stability=VOLATILE)
See: Description
Interface | Description |
---|---|
Attribute |
This class defines a data structure for storing and interacting
with an attribute that may be used in the Directory Server.
|
CryptoManager |
This interface defines the methods to call to access cryptographic
services including encryption and hashing; in particular, when the
ciphertext or HMAC is produced on one directory server instance and
is to be consumed on another.
|
Operation |
This interface defines a generic operation that may be processed by
the Directory Server.
|
SchemaFileElement |
This interface defines a set of methods that must be provided by a
schema file element, which is a schema element that is loaded from
a schema configuration file.
|
SynchronizationProviderResult |
This class defines a data structure that holds information about
the result of processing by a synchronization provider.
|
Class | Description |
---|---|
AbstractAttribute |
An abstract base class for implementing new types of
Attribute . |
AbstractOperation |
This class defines a generic operation that may be processed by the
Directory Server.
|
AccountStatusNotification |
This class defines a data type for storing information associated
with an account status notification.
|
AdditionalLogItem |
An additional log item for an operation which may be processed in the access
log.
|
AttributeBuilder |
This class provides an interface for creating new non-virtual
Attribute s, or "real" attributes. |
AttributeParser |
A fluent API for parsing attributes as different types of object.
|
Attributes | |
AttributeType |
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.
|
AuthenticationInfo |
This class defines a data structure that may be used to store
information about an authenticated user.
|
BackupConfig |
This class defines a data structure for holding configuration
information to use when performing a backup of a Directory Server
backend.
|
BackupDirectory |
This class defines a data structure for holding information about a
filesystem directory that contains data for one or more backups associated
with a backend.
|
BackupInfo |
This class defines a data structure for holding information about a
backup that is available in a backup directory.
|
CacheEntry |
This class defines a Directory Server cache entry, which is simply
used to store an entry with its associated backend and entry ID.
|
CancelRequest |
This class defines a data structure that can be used to hold
information about a request to cancel or abandon an operation in
progress.
|
CancelResult |
This enumeration defines the set of possible outcomes that can
result from processing a cancel request.
|
CollectiveVirtualAttribute |
This class defines a collective virtual attribute, which is a
special kind of attribute whose values do not actually exist
in persistent storage but rather are obtained dynamically
from applicable collective attribute subentry.
|
CommonSchemaElements |
An abstract base class for LDAP schema definitions which contain an
OID, optional names, description, an obsolete flag, and an optional
set of extra properties.
|
Control |
This class defines a data structure that holds information about a
control that can be included in a request or response.
|
DirectoryConfig |
This interface defines a set of methods that may be used by
third-party code to obtain information about the core Directory
Server configuration and the instances of various kinds of
components that have registered themselves with the server.
|
DirectoryEnvironmentConfig |
This class provides a set of properties that may control various
aspects of the server environment.
|
DITContentRule |
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 that may be included in the entry.
|
DITStructureRule |
This class defines a DIT structure rule, which is used to indicate
the types of children that entries may have.
|
DN |
This class defines a data structure for storing and interacting
with the distinguished names associated with entries in the
Directory Server.
|
Entry |
This class defines a data structure for a Directory Server entry.
|
EntryEncodeConfig |
This class defines a data structure that contains configuration
information about how an entry should be encoded.
|
FilePermission |
This class provides a mechanism for setting file permissions in a
more abstract manner than is provided by the underlying operating
system and/or filesystem.
|
HostPort |
This class defines a data structure that combines an address and port number,
as may be used to accept a connection from or initiate a connection to a
remote system.
|
IntermediateResponse |
This class defines a data structure for holding information that
may be sent to the client in the form of an intermediate response.
|
InvokableMethod |
This class defines a data structure that holds information about a
method that may be invoked for an invokable component.
|
LDAPSyntaxDescription |
This class defines a data structure for storing and interacting
with an ldap syntax, which defines the custom ldap syntaxes.
|
LDAPURL |
This class defines a data structure that represents the components
of an LDAP URL, including the scheme, host, port, base DN,
attributes, scope, filter, and extensions.
|
LDIFExportConfig |
This class defines a data structure for holding configuration
information to use when performing an LDIF export.
|
LDIFImportConfig |
This class defines a data structure for holding configuration
information to use when performing an LDIF import.
|
LDIFImportResult |
This class defines a data structure for providing information about
the state of a completed LDIF import, including the total number of
entries read, skipped, and rejected.
|
LockManager |
A lock manager coordinates directory update operations so that the DIT structure remains in a
consistent state, as well as providing repeatable read isolation.
|
MatchingRuleUse |
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.
|
MemberList |
This class defines a mechanism that may be used to iterate over the
members of a group.
|
Modification |
This class defines a data structure for storing and interacting
with a modification that may be requested of an entry in the Directory Server.
|
NamedCharacterSet |
This class provides a data structure that makes it possible to
associate a name with a given set of characters.
|
NameForm |
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.
|
NullOutputStream |
This class defines a custom output stream that simply discards any
data written to it.
|
ObjectClass |
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.
|
OperationConfig |
Base for data structures that define configuration
for operations.
|
RawAttribute |
This class defines a raw attribute, which has a type (which may
include zero or more options), and zero or more values.
|
RawFilter |
This class defines the data structures and methods to use when
interacting with a raw search filter, which defines a set of
criteria for locating entries in a search request.
|
RawModification |
This class defines the data structures and methods to use when
interacting with a raw modification, which describes a change that
should be made to an attribute.
|
RDN |
This class defines a data structure for storing and interacting
with the relative distinguished names associated with entries in
the Directory Server.
|
RecordingInputStream |
A wrapper InputStream that will record all reads from an underlying
InputStream.
|
RecordingOutputStream |
A wrapper OutputStream that will record all writes to an underlying
OutputStream.
|
RestoreConfig |
This class defines a data structure for holding configuration
information to use when restoring a backup of a Directory Server
backend.
|
Schema |
This class defines a data structure that holds information about
the components of the Directory Server schema.
|
SearchFilter |
This class defines a data structure for storing and interacting
with a search filter that may serve as criteria for locating
entries in the Directory Server.
|
SearchResultEntry |
This class defines a data structure for storing information about
an entry that matches a given set of search criteria and should be
returned to the client.
|
SearchResultReference |
This class defines a data structure for storing information about a
referral returned while processing a search request.
|
SmallMap<K,V> |
A small map of values.
|
SortKey |
This class defines a data structure that may be used as a sort key.
|
SortOrder |
This class defines a data structure that defines a set of sort
criteria that may be used to order entries in a set of search
results.
|
SubEntry |
This class represents RFC 3672 subentries and RFC 3671
collective attribute subentries objects.
|
SubtreeSpecification |
An RFC 3672 subtree specification.
|
SubtreeSpecification.AndRefinement |
RFC 3672 subtree specification AND refinement.
|
SubtreeSpecification.FilterRefinement |
A refinement which uses a search filter.
|
SubtreeSpecification.ItemRefinement |
RFC 3672 subtree specification Item refinement.
|
SubtreeSpecification.NotRefinement |
RFC 3672 subtree specification NOT refinement.
|
SubtreeSpecification.OrRefinement |
RFC 3672 subtree specification OR refinement.
|
SubtreeSpecification.Parser |
Internal utility class which can be used by sub-classes to help
parse string representations.
|
SubtreeSpecification.Refinement |
Abstract interface for RFC3672 specification filter refinements.
|
SynchronizationProviderResult.ContinueProcessing |
Defines a continue processing synchronization provider result.
|
SynchronizationProviderResult.StopProcessing |
Defines a stop processing synchronization provider result.
|
VirtualAttribute |
This class defines a virtual attribute, which is a special kind of
attribute whose values do not actually exist in persistent storage
but rather are computed or otherwise obtained dynamically.
|
VirtualAttributeRule |
This class defines a virtual attribute rule, which associates a
virtual attribute provider with its associated configuration,
including the attribute type for which the values should be
generated; the base DN(s), group DN(s), and search filter(s) that
should be used to identify which entries should have the virtual
attribute, and how conflicts between real and virtual values should
be handled.
|
Enum | Description |
---|---|
AcceptRejectWarn |
This class implements an enumeration that may be used for
configuration items that may have three possible values: accept,
reject, or warn.
|
AccountStatusNotificationProperty |
This class implements an enumeration that holds the possible set of
additional properties that can be included in an account status
notification.
|
AccountStatusNotificationType |
This class implements an enumeration that holds the possible event
types that can trigger an account status notification.
|
AuthenticationType |
This enumeration defines the set of possible authentication types
that may be used for a bind request.
|
DisconnectReason |
This enumeration defines the set of possible reasons for the
closure of a connection between a client and the Directory Server.
|
ExistingFileBehavior |
This enumeration defines the set of possible behaviors that should
be taken when attempting to write to a file that already exists.
|
FilterType |
This enumeration defines the set of possible filter types that may
be used for search filters.
|
IndexType |
This class implements an enumeration that may be used to define the
ways in which an attribute may be indexed within the server.
|
LockType |
This enumeration defines a set of lock types that can be used when
requesting that a lock be obtained for an entry or some other
object.
|
OperationType |
This enumeration defines the set of possible operation types that
may be processed by the Directory Server.
|
Privilege |
This class implements an enumeration that defines the set of
privileges available in the Directory Server.
|
SSLClientAuthPolicy |
This enumeration defines a policy that indicates how the server
should deal with SSL/TLS-based client connections.
|
StabilityLevel |
This class implements an enumeration whose values may be used to
indicate the stability level of API classes and/or methods.
|
SubEntry.CollectiveConflictBehavior |
Defines the set of permissible values for the conflict behavior.
|
WritabilityMode |
This class implements an enumeration that may be used to control
the writability mode for the entire server or for a specific
backend.
|
Exception | Description |
---|---|
CanceledOperationException |
This class defines an exception that may be thrown if the operation
being processed is cancelled for some reason (e.g., an abandon or
cancel request from the client).
|
CryptoManagerException |
This class defines an exception that is thrown in the case of
problems with encryption key management, and is a wrapper for a
variety of other cipher related exceptions.
|
DirectoryException |
This class defines an exception that may be thrown if a problem
occurs in the Directory Server.
|
IdentifiedException |
This class defines a base exception that should be extended by any
exception that exposes a unique identifier for the associated
message.
|
InitializationException |
This class defines an exception that may be thrown if a problem
occurs while trying to initialize a Directory Server component.
|
LDAPException |
This class defines an exception that may be thrown if a problem
occurs while interacting with an LDAP protocol element.
|
MembershipException |
This class defines an exception that may be thrown if a problem
occurs while attempting to iterate across the members of a group.
|
OpenDsException |
This class defines a base exception for OpenDS exceptions.
|
Annotation Type | Description |
---|---|
PublicAPI |
This class defines an annotation type that can be used to describe
the position of a package, class, or method in the OpenDS public
API (including to denote that the associated code should NOT be
considered part of the public API).
|
Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.