Uses of Package
org.opends.server.api

Packages that use org.opends.server.api

Package	Description
org.forgerock.opendj.server.core	Classes implementing a Grizzly based ConnectionHandler using reactive api.
org.opends.server.api	Contains a number of API declarations for use throughout the Directory Server.
org.opends.server.api.plugin	Defines the Directory Server plugin API.
org.opends.server.authorization.dseecompat	Contains the Directory Server Sun Java System Directory Server Enterprise Edition (dseecompat) compatability access control handler implementation.
org.opends.server.authorization.policy	Contains the policy based access control handler implementation.
org.opends.server.backends	Contains various Directory Server backend implementations.
org.opends.server.backends.jeb	Contains the code for the Directory Server backend that uses the Berkeley DB Java Edition as the repository for storing entry and index information.
org.opends.server.backends.pluggable	Contains the code for implementing Directory Server pluggable storage backends.
org.opends.server.backends.task	Contains the code for the Directory Server backend that provides an interface for executing administrative tasks.
org.opends.server.config	Contains code used to interact with the Directory Server configuration.
org.opends.server.core	Contains various classes that comprise the core of the Directory Server codebase.
org.opends.server.crypto	This package implements the Directory Server cryptographic framework, which is described in the CrytpoManager design document.
org.opends.server.extensions	Contains various implementations of Directory Server APIs that are not appropriate for other packages.
org.opends.server.loggers	Contains implementations of Directory Server access, error, and debug loggers.
org.opends.server.monitors	Contains various Directory Server monitor provider implementations.
org.opends.server.plugins	Contains the implementation for various Directory Server plugins.
org.opends.server.plugins.profiler	Contains the implementation of the Directory Server plugin that acts as an embedded profiler that can be used for performance analysis of the server under load.
org.opends.server.protocols	Contains various Directory Server connection handler implementations which will be used to accept connections from and perform communication with clients over various protocols.
org.opends.server.protocols.http	Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using HTTP.
org.opends.server.protocols.http.rest2ldap	Contains the implementation for the HTTPEndpoint that is responsible for providing a REST interface to this LDAP server.
org.opends.server.protocols.jmx	Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using JMX.
org.opends.server.protocols.ldap	Contains the implementation for the Directory Server connection handler that is responsible for interacting with clients using LDAPv3.
org.opends.server.replication.plugin	This package contains the part of the Multi-master replication code that works on the Directory Server side.
org.opends.server.replication.protocol	This package contains the code used by the replication server and by the code running on the Directory Server side to exchange their information.
org.opends.server.replication.server	This package contains the code for the Replication Server part of the Multimaster replication feature.
org.opends.server.replication.server.changelog.file	This package contains a file-based log implementation for the changelog database API.
org.opends.server.replication.service	This package contains the generic of the Multi-Master replication code that works on the Directory Server side.
org.opends.server.schema	Contains implementations of various Directory Server schema elements.
org.opends.server.snmp	This package contains Simple Network Management Protocol (SNMP) connection handler, the required classes to support MIB 2605 objects and SNMP requests, and the SNMP adaptor that allows a SNMP manager to access OpenDS monitoring information.
org.opends.server.tasks	Contains implementations for various Directory Server tasks.
org.opends.server.tools	Contains various Directory Server tool implementations.
org.opends.server.types	Contains implementations for a number of Directory Server data types.
org.opends.server.types.operation	Contains a number of interfaces that are implemented by the various types of Directory Server operations.
org.opends.server.util	Contains implementations for various Directory Server utility classes and methods which may be used throughout the server but do not necessarily fit in elsewhere.

Classes in org.opends.server.api used by org.forgerock.opendj.server.core

Class and Description
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
RequestFilter Filters the request and/or responses of an LDAP exchange.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.api

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
AuthenticationPolicy An abstract authentication policy.
AuthenticationPolicyState The authentication policy context associated with a user's entry, which is responsible for managing the user's account, their password, as well as authenticating the user.
Backend Represents a directory server backend, which can be either local or remote (proxy).
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
ConnectionHandler This class defines the set of methods and structures that must be implemented by a Directory Server connection handler.
Group This class defines the set of methods that must be implemented by a Directory Server group.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackend.BackendOperation Enumeration of optional backend operations.
MeterRegistryHolder Decorator for a meter registry.
MonitorData This class is used to hold monitoring data, i.e.
MonitorProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.
RequestFilter Filters the request and/or responses of an LDAP exchange.
RequestFilterChain Filters and/or transforms the request and/or response of an LDAP exchange, multiple filters version.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.api.plugin

Class and Description
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.

Classes in org.opends.server.api used by org.opends.server.authorization.dseecompat

Class and Description
AccessControlHandler This class defines the set of methods and structures that must be implemented by a Directory Server access control handler.
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
Group This class defines the set of methods that must be implemented by a Directory Server group.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackendInitializationListener This interface defines a set of methods that may be used by server components to perform any processing that they might find necessary whenever a local backend is initialized and/or finalized.

Classes in org.opends.server.api used by org.opends.server.authorization.policy

Class and Description
AccessControlHandler This class defines the set of methods and structures that must be implemented by a Directory Server access control handler.
RequestFilter Filters the request and/or responses of an LDAP exchange.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.backends

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
Backend Represents a directory server backend, which can be either local or remote (proxy).
Backupable Represents an entity (storage, backend) that can be backed up.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackend.BackendOperation Enumeration of optional backend operations.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.backends.jeb

Class and Description
Backend Represents a directory server backend, which can be either local or remote (proxy).
Backupable Represents an entity (storage, backend) that can be backed up.
DiskSpaceMonitorHandler This interface defines the set of methods that must be implemented for a DiskSpaceMonitorHandler.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.backends.pluggable

Class and Description
Backend Represents a directory server backend, which can be either local or remote (proxy).
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackend.BackendOperation Enumeration of optional backend operations.
MonitorProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.backends.task

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
Backend Represents a directory server backend, which can be either local or remote (proxy).
DirectoryThread This class defines a generic thread that should be the superclass for all threads created by the Directory Server.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackend.BackendOperation Enumeration of optional backend operations.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.config

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
DirectoryServerMBean This interface must be implemented by all Directory Server components that interact with JMX in any way.
MonitorProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.

Classes in org.opends.server.api used by org.opends.server.core

Class and Description
AccessControlHandler This class defines the set of methods and structures that must be implemented by a Directory Server access control handler.
AccountStatusNotificationHandler This class defines the set of methods that must be implemented for an account status notification handler.
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
AlertHandler This interface defines the set of methods that must be implemented for a Directory Server alert handler.
AuthenticationPolicy An abstract authentication policy.
AuthenticationPolicyFactory A factory for creating configurable authentication policies.
AuthenticationPolicyState The authentication policy context associated with a user's entry, which is responsible for managing the user's account, their password, as well as authenticating the user.
Backend Represents a directory server backend, which can be either local or remote (proxy).
BackupTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever a backend backup task is about to begin or has just completed.
CertificateMapper This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required to uniquely map an SSL client certificate to a Directory Server user entry.
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
ConnectionHandler This class defines the set of methods and structures that must be implemented by a Directory Server connection handler.
DirectoryThread This class defines a generic thread that should be the superclass for all threads created by the Directory Server.
EntryCache This class defines the set of methods that must be implemented by a Directory Server entry cache.
ExportTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever an LDIF export task is about to begin or has just completed.
ExtendedOperationHandler This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more types of extended operations.
Group This class defines the set of methods that must be implemented by a Directory Server group.
IdentityMapper This class defines the set of methods and structures that must be implemented by a Directory Server identity mapper.
ImportTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever an LDIF import task is about to begin or has just completed.
InitializationCompletedListener This interface defines a method that may be used to notify various Directory Server components that the server initialization is completed.
KeyManagerProvider This class defines an API that may be used to obtain a set of javax.net.ssl.KeyManager objects for use when performing SSL communication.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackendInitializationListener This interface defines a set of methods that may be used by server components to perform any processing that they might find necessary whenever a local backend is initialized and/or finalized.
MonitorProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.
PasswordGenerator This class defines a set of methods and structures that must be implemented by a Directory Server module that may be used to generate user passwords.
PasswordStorageScheme This class defines the set of methods and structures that must be implemented by a Directory Server module that implements a password storage scheme.
PasswordValidator This class defines the set of methods and structures that must be implemented by a Directory Server module that may be used to determine whether a proposed password is acceptable for a user.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.
RestoreTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever a backend restore task is about to begin or has just completed.
SASLMechanismHandler This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more SASL mechanisms.
ServerShutdownListener This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.
SubentryChangeListener This interface defines a mechanism that Directory Server components may use if they need to be notified of changes that are being made to subentries in the Directory Server.
SynchronizationProvider This class defines the set of methods and structures that are available for use in a Directory Server synchronization provider.
TrustManagerProvider This class defines an API that may be used to obtain a set of javax.net.ssl.TrustManager objects for use when performing SSL/StartTLS negotiation.
WorkQueue This class defines the structure and methods that must be implemented by a Directory Server work queue.

Classes in org.opends.server.api used by org.opends.server.crypto

Class and Description
ExtendedOperationHandler This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more types of extended operations.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackendInitializationListener This interface defines a set of methods that may be used by server components to perform any processing that they might find necessary whenever a local backend is initialized and/or finalized.

Classes in org.opends.server.api used by org.opends.server.extensions

Class and Description
AccountStatusNotificationHandler This class defines the set of methods that must be implemented for an account status notification handler.
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
AlertHandler This interface defines the set of methods that must be implemented for a Directory Server alert handler.
AuthenticationPolicy An abstract authentication policy.
AuthenticationPolicyFactory A factory for creating configurable authentication policies.
CertificateMapper This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required to uniquely map an SSL client certificate to a Directory Server user entry.
DirectoryServerMBean This interface must be implemented by all Directory Server components that interact with JMX in any way.
DiskSpaceMonitorHandler This interface defines the set of methods that must be implemented for a DiskSpaceMonitorHandler.
EntryCache This class defines the set of methods that must be implemented by a Directory Server entry cache.
ExtendedOperationHandler This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more types of extended operations.
Group This class defines the set of methods that must be implemented by a Directory Server group.
IdentityMapper This class defines the set of methods and structures that must be implemented by a Directory Server identity mapper.
KeyManagerProvider This class defines an API that may be used to obtain a set of javax.net.ssl.KeyManager objects for use when performing SSL communication.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackendInitializationListener This interface defines a set of methods that may be used by server components to perform any processing that they might find necessary whenever a local backend is initialized and/or finalized.
MeterRegistryHolder Decorator for a meter registry.
MonitorProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.
PasswordGenerator This class defines a set of methods and structures that must be implemented by a Directory Server module that may be used to generate user passwords.
PasswordStorageScheme This class defines the set of methods and structures that must be implemented by a Directory Server module that implements a password storage scheme.
PasswordValidator This class defines the set of methods and structures that must be implemented by a Directory Server module that may be used to determine whether a proposed password is acceptable for a user.
SASLMechanismHandler This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more SASL mechanisms.
ServerShutdownListener This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.
TrustManagerProvider This class defines an API that may be used to obtain a set of javax.net.ssl.TrustManager objects for use when performing SSL/StartTLS negotiation.
VirtualAttributeProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more virtual attributes.
WorkQueue This class defines the structure and methods that must be implemented by a Directory Server work queue.

Classes in org.opends.server.api used by org.opends.server.loggers

Class and Description
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
RequestFilter Filters the request and/or responses of an LDAP exchange.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.

Classes in org.opends.server.api used by org.opends.server.monitors

Class and Description
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
MonitorProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.

Classes in org.opends.server.api used by org.opends.server.plugins

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
ImportTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever an LDIF import task is about to begin or has just completed.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
ServerShutdownListener This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.

Classes in org.opends.server.api used by org.opends.server.plugins.profiler

Class and Description
DirectoryThread This class defines a generic thread that should be the superclass for all threads created by the Directory Server.

Classes in org.opends.server.api used by org.opends.server.protocols

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
ConnectionHandler This class defines the set of methods and structures that must be implemented by a Directory Server connection handler.

Classes in org.opends.server.api used by org.opends.server.protocols.http

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
ConnectionHandler This class defines the set of methods and structures that must be implemented by a Directory Server connection handler.
HttpEndpoint Endpoint attach an HttpApplication to an URI.
MeterRegistryHolder Decorator for a meter registry.

Classes in org.opends.server.api used by org.opends.server.protocols.http.rest2ldap

Class and Description
HttpEndpoint Endpoint attach an HttpApplication to an URI.

Classes in org.opends.server.api used by org.opends.server.protocols.jmx

Class and Description
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
ConnectionHandler This class defines the set of methods and structures that must be implemented by a Directory Server connection handler.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.
ServerShutdownListener This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.

Classes in org.opends.server.api used by org.opends.server.protocols.ldap

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
ConnectionHandler This class defines the set of methods and structures that must be implemented by a Directory Server connection handler.
MeterRegistryHolder Decorator for a meter registry.
RequestFilter Filters the request and/or responses of an LDAP exchange.
RequestHandler Asynchronously handles a LDAP Request by producing an associated Response.
ServerShutdownListener This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.

Classes in org.opends.server.api used by org.opends.server.replication.plugin

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
BackupTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever a backend backup task is about to begin or has just completed.
ExportTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever an LDIF export task is about to begin or has just completed.
ImportTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever an LDIF import task is about to begin or has just completed.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
LocalBackendInitializationListener This interface defines a set of methods that may be used by server components to perform any processing that they might find necessary whenever a local backend is initialized and/or finalized.
MeterRegistryHolder Decorator for a meter registry.
OrderingMatchingRule Deprecated. since OPENDJ-1591 Migrate matching rules
RestoreTaskListener This interface defines a set of methods that may be used to notify various Directory Server components whenever a backend restore task is about to begin or has just completed.
ServerShutdownListener This interface defines a method that may be used to notify various Directory Server components that the server is shutting down.
SynchronizationProvider This class defines the set of methods and structures that are available for use in a Directory Server synchronization provider.

Classes in org.opends.server.api used by org.opends.server.replication.protocol

Class and Description
DirectoryThread This class defines a generic thread that should be the superclass for all threads created by the Directory Server.

Classes in org.opends.server.api used by org.opends.server.replication.server

Class and Description
DirectoryThread This class defines a generic thread that should be the superclass for all threads created by the Directory Server.
DiskSpaceMonitorHandler This interface defines the set of methods that must be implemented for a DiskSpaceMonitorHandler.
MonitorProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that can provide usage, performance, availability, or other kinds of monitor information to clients.

Classes in org.opends.server.api used by org.opends.server.replication.server.changelog.file

Class and Description
DirectoryThread This class defines a generic thread that should be the superclass for all threads created by the Directory Server.

Classes in org.opends.server.api used by org.opends.server.replication.service

Class and Description
MeterRegistryHolder Decorator for a meter registry.

Classes in org.opends.server.api used by org.opends.server.schema

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
OrderingMatchingRule Deprecated. since OPENDJ-1591 Migrate matching rules

Classes in org.opends.server.api used by org.opends.server.snmp

Class and Description
AlertGenerator This class defines an interface that may be used to define a set of alert notifications that may be generated by this Directory Server component.
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
ConnectionHandler This class defines the set of methods and structures that must be implemented by a Directory Server connection handler.

Classes in org.opends.server.api used by org.opends.server.tasks

Class and Description
DirectoryThread This class defines a generic thread that should be the superclass for all threads created by the Directory Server.

Classes in org.opends.server.api used by org.opends.server.tools

Class and Description
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.

Classes in org.opends.server.api used by org.opends.server.types

Class and Description
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.
LocalBackend This class defines the set of methods and structures that must be implemented for a Directory Server backend.
VirtualAttributeProvider This class defines the set of methods and structures that must be implemented by a Directory Server module that implements the functionality required for one or more virtual attributes.

Classes in org.opends.server.api used by org.opends.server.types.operation

Class and Description
ClientConnection This class defines the set of methods and structures that must be implemented by a Directory Server client connection.

Classes in org.opends.server.api used by org.opends.server.util

Class and Description
Backupable Represents an entity (storage, backend) that can be backed up.