@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 AlertHandlerCfg>	This interface defines the set of methods that must be implemented for a Directory Server alert handler.
AuthenticationPolicyFactory<T extends AuthenticationPolicyCfg>	A factory for creating configurable authentication policies.
BackendInitializationListener	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 backend is initialized and/or finalized.
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.
ConfigAddListener	This interface defines the methods that a Directory Server component should implement if it wishes to be able to receive notification of new entries added below a configuration entry.
ConfigChangeListener	This interface defines the methods that a Directory Server component should implement if it wishes to be able to receive notification of changes to a configuration entry.
ConfigDeleteListener	This interface defines the methods that a Directory Server component should implement if it wishes to be able to receive notification if entries below a configuration entry are removed.
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.
InvokableComponent	This class defines an interface that may be implemented by Directory Server components that have methods that may be invoked either via adding configuration entries (e.g., task plugins) or through JMX.
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.).
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 AccessControlHandlerCfg>	This class defines the set of methods and structures that must be implemented by a Directory Server access control handler.
AccountStatusNotificationHandler<T extends AccountStatusNotificationHandlerCfg>	This class defines the set of methods that must be implemented for an account status notification handler.
AttributeSyntax<T extends AttributeSyntaxCfg>	This class defines the set of methods and structures that must be implemented by a Directory Server module that implements an attribute syntax.
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 Configuration>	This class defines the set of methods and structures that must be implemented for a Directory Server backend.
CertificateMapper<T extends 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.
ConfigHandler<C extends BackendCfg>	This class defines the set of methods and structures that must be implemented by a Directory Server configuration handler.
ConnectionHandler<T extends 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 EntryCacheCfg>	This class defines the set of methods that must be implemented by a Directory Server entry cache.
ExtendedOperationHandler<T extends 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 GroupImplementationCfg>	This class defines the set of methods that must be implemented by a Directory Server group.
IdentityMapper<T extends IdentityMapperCfg>	This class defines the set of methods and structures that must be implemented by a Directory Server identity mapper.
KeyManagerProvider<T extends 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.
MatchingRuleFactory<T extends MatchingRuleCfg>	This class defines the set of methods and structures that must be implemented by a Directory Server module that implements a matching rule factory.
MonitorProvider<T extends 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 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 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 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.
SASLMechanismHandler<T extends 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 SynchronizationProviderCfg>	This class defines the set of methods and structures that are available for use in a Directory Server synchronization provider.
TrustManagerProvider<T extends 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.
VirtualAttributeProvider<T extends 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 WorkQueueCfg>	This class defines the structure and methods that must be implemented by a Directory Server work queue.

Enum Summary

Enum	Description
Backend.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.