@PublicAPI(stability=VOLATILE)

Package org.opends.server.api

Contains a number of API declarations for use throughout the Directory Server.

See: Description

Interface Summary

Interface	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.
AlertHandler<T extends org.forgerock.opendj.server.config.server.AlertHandlerCfg>	This interface defines the set of methods that must be implemented for a Directory Server alert handler.
AuthenticationPolicyFactory<T extends org.forgerock.opendj.server.config.server.AuthenticationPolicyCfg>	A factory for creating configurable authentication policies.
Backupable	Represents an entity (storage, backend) that can be backed up.
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.
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.
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.
InitializationCompletedListener	This interface defines a method that may be used to notify various Directory Server components that the server initialization is completed.
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.
OrderingMatchingRule	Deprecated since OPENDJ-1591 Migrate matching rules
ProtocolElement	This interface defines a set of methods that must be implemented by any class that forms the basis for a protocol element (e.g., an ASN.1 element, an LDAP message, etc.).
RequestFilter	Filters the request and/or responses of an LDAP exchange.
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.
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.

Class Summary

Class	Description
AccessControlHandler<T extends org.forgerock.opendj.server.config.server.AccessControlHandlerCfg>	This class defines the set of methods and structures that must be implemented by a Directory Server access control handler.
AccountStatusNotificationHandler<T extends org.forgerock.opendj.server.config.server.AccountStatusNotificationHandlerCfg>	This class defines the set of methods that must be implemented for an account status notification handler.
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<C extends org.forgerock.opendj.config.Configuration>	Represents a directory server backend, which can be either local or remote (proxy).
CertificateMapper<T extends org.forgerock.opendj.server.config.server.CertificateMapperCfg>	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.
CompressedSchema	This class provides a utility for interacting with compressed representations of schema elements.
ConnectionHandler<T extends org.forgerock.opendj.server.config.server.ConnectionHandlerCfg>	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.
DirectoryThread.Factory	A factory which can be used by thread pool based services such as Executors to dynamically create new DirectoryThread instances.
DITCacheMap<T>	The DITCacheMap class implements custom Map for structural storage of arbitrary objects in Directory Information Tree (DIT) like structure.
EntryCache<T extends org.forgerock.opendj.server.config.server.EntryCacheCfg>	This class defines the set of methods that must be implemented by a Directory Server entry cache.
ExtendedOperationHandler<T extends org.forgerock.opendj.server.config.server.ExtendedOperationHandlerCfg>	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<T extends org.forgerock.opendj.server.config.server.GroupImplementationCfg>	This class defines the set of methods that must be implemented by a Directory Server group.
HttpEndpoint<C extends org.forgerock.opendj.server.config.server.HttpEndpointCfg>	Endpoint attach an HttpApplication to an URI.
IdentityMapper<T extends org.forgerock.opendj.server.config.server.IdentityMapperCfg>	This class defines the set of methods and structures that must be implemented by a Directory Server identity mapper.
KeyManagerProvider<T extends org.forgerock.opendj.server.config.server.KeyManagerProviderCfg>	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<C extends org.forgerock.opendj.config.Configuration>	This class defines the set of methods and structures that must be implemented for a Directory Server backend.
MonitorData	This class is used to hold monitoring data, i.e.
MonitorProvider<T extends org.forgerock.opendj.server.config.server.MonitorProviderCfg>	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<T extends org.forgerock.opendj.server.config.server.PasswordGeneratorCfg>	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<T extends org.forgerock.opendj.server.config.server.PasswordStorageSchemeCfg>	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<T extends org.forgerock.opendj.server.config.server.PasswordValidatorCfg>	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.
RequestFilterChain	Filters and/or transforms the request and/or response of an LDAP exchange, multiple filters version.
SASLMechanismHandler<T extends org.forgerock.opendj.server.config.server.SaslMechanismHandlerCfg>	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.
SynchronizationProvider<T extends org.forgerock.opendj.server.config.server.SynchronizationProviderCfg>	This class defines the set of methods and structures that are available for use in a Directory Server synchronization provider.
TrustManagerProvider<T extends org.forgerock.opendj.server.config.server.TrustManagerProviderCfg>	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.
TypedProtocolOpFilter	Base class for implementing RequestFilters whose behavior depends on the type of Request and Response.
TypedRequestFilter	Base class for implementing RequestFilters whose behavior depends on the type of Request.
TypedRequestHandler	Base class for implementing RequestHanders whose behavior depends on the type of Request.
VirtualAttributeProvider<T extends org.forgerock.opendj.server.config.server.VirtualAttributeCfg>	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<T extends org.forgerock.opendj.server.config.server.WorkQueueCfg>	This class defines the structure and methods that must be implemented by a Directory Server work queue.

Enum Summary

Enum	Description
LocalBackend.BackendOperation	Enumeration of optional backend operations.

Package org.opends.server.api Description

Contains a number of API declarations for use throughout the Directory Server. Whenever possible, these APIs should be declared using abstract classes rather than interfaces so that they can be altered in future versions without impacting backward compatibility.

Note that the mere existence of a class or interface in this package does not in itself imply that it is intended for use by third party code. Please refer to the official product documentation to indicate which APIs may be safely used by anyone other than the core Directory Server developers. Failure to heed this warning may result in code that could have unintended side effects or that does not work properly across different Directory Server versions.