Package com.unboundid.directory.sdk.ds.api

This package defines a number of abstract classes and interfaces which may be extended or implemented by third-party code in order to create extensions primarily intended for use in the Ping Identity Directory Server (also referred to as the Directory Server), although some of the APIs defined in this package may apply to other Ping Identity products in certain contexts.

See: Description

Interface Summary

Interface	Description
ChangeListener	This interface defines a set of methods that may be implemented by an extension which should be used to receive information about changes processed within the server as the result of add, delete, modify, or modify DN operations.

Class Summary

Class	Description
AccountStatusNotificationHandler	This class defines an API that must be implemented by extensions which have the ability to process notifications about events that occur that could change the status of a user account.
BackendInitializationListener	This interface defines a set of methods that may be used by extensions to perform any processing that they might find necessary whenever a backend is initialized and/or finalized.
CertificateMapper	This class defines an API that must be implemented by extensions which attempt to map a certificate presented by a client (e.g., via SSL or StartTLS) to a user defined in the server.
ChangeSubscriptionHandler	This class defines an API that must be implemented by extensions which receive notification of changes of interest processed within the server.
CipherStreamProvider	This class defines an API that must be implemented by extensions which provide access to cipher input streams and cipher output streams to be used by the server in order to read and write encrypted data.
ConnectionCriteria	This class defines an API that must be implemented by extensions which can be used to classify client connections.
EnhancedPasswordStorageScheme	This class defines an API that may be implemented by extensions which provide enhanced password storage scheme support.
ExtendedOperationHandler	This class defines an API that must be implemented by extensions which are used to process extended operations within the server.
IdentityMapper	This class defines an API that must be implemented by extensions which attempt to map a username to a user defined in the server.
NotificationManager	This class defines an API that must be implemented by extensions which wish to deliver notification of changes of interest processed within the server.
OneTimePasswordDeliveryMechanism	This class defines an API that must be implemented by extensions which attempt to deliver one-time passwords (OTPs) to end users through some out-of-band mechanism.
PassThroughAuthenticationHandler	This class defines an API that must be implemented by extensions that attempt to pass through authentication to an external service.
PasswordGenerator	This class defines an API that must be implemented by extensions which generate user passwords.
PasswordStorageScheme	NOTE: The EnhancedPasswordStorageScheme class provides both a simpler and more functional API for interacting with passwords.
PasswordValidator	This class defines an API that must be implemented by extensions which attempt to determine whether a proposed user password is acceptable.
Plugin	This class defines an API that must be implemented by extensions which act as server plugins.
RecurringTask	This class defines an API that must be implemented by extensions that may be used to schedule administrative tasks on a recurring basis.
RequestCriteria	This class defines an API that must be implemented by extensions which can be used to classify client requests.
ResultCriteria	This class defines an API that must be implemented by extensions which can be used to classify client results.
SASLMechanismHandler	This class defines an API that must be implemented by extensions which add support for custom SASL mechanisms to the server, which can provide support for custom authentication (and optionally, authorization) methods.
SearchEntryCriteria	This class defines an API that must be implemented by extensions which can be used to classify client search result entries.
SearchReferenceCriteria	This class defines an API that must be implemented by extensions which can be used to classify client search result entries.
Task	This class defines an API that must be implemented by extensions which may be used as administrative tasks.
UncachedAttributeCriteria	This class defines an API that must be implemented by extensions which have the ability to determine which attributes should be stored in the uncached-id2entry database of a local DB backend, while the remainder of the entry is stored in the id2entry database.
UncachedEntryCriteria	This class defines an API that must be implemented by extensions which have the ability to determine which entries should be stored in the uncached-id2entry database of a local DB backend, rather than in the id2entry database.
VirtualAttributeProvider	This class defines an API that must be implemented by extensions which construct attribute values which may be included in entries instead of or in addition to real values which are actually stored in the backend.

Package com.unboundid.directory.sdk.ds.api Description

This package defines a number of abstract classes and interfaces which may be extended or implemented by third-party code in order to create extensions primarily intended for use in the Ping Identity Directory Server (also referred to as the Directory Server), although some of the APIs defined in this package may apply to other Ping Identity products in certain contexts.