Package com.unboundid.ldap.sdk.unboundidds.extensions
This package contains implementations for a number of LDAP extended
operations which are specific to the Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 Directory Server products. In some cases, they
may be based on standard extended operations which have not yet reached a
sufficient stability level to make them available for general use against any
kind of server, while in other cases they may be defined specifically for use
with the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory
Server.
NOTE: The classes within this package, and elsewhere within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and
Nokia/Alcatel-Lucent 8661 server products. These classes provide support
for proprietary functionality or for external specifications that are not
considered stable or mature enough to be guaranteed to work in an
interoperable way with other types of LDAP servers.
-
Interface Summary Interface Description ChangelogEntryListener This interface defines a set of methods that will be invoked when an intermediate response is returned in the course of processing a get changelog batch extended operation.CollectSupportDataIntermediateResponseListener This interface provide an API that may be used to handle intermediate response messages returned as part of processing for anCollectSupportDataExtendedRequest
. -
Class Summary Class Description AllAttributesChangeSelectionCriteria This class provides an implementation of a get changelog batch change selection criteria value that indicates that the server should only return changes which target all or more of the specified attributes.AnyAttributesChangeSelectionCriteria This class provides an implementation of a get changelog batch change selection criteria value that indicates that the server should only return changes which target one or more of the specified attributes.BeginningOfChangelogStartingPoint This class provides an implementation of a changelog batch starting point which may be used to start a batch of changes at the first change available in the changelogs of all servers in the replication topology.CertificateDataReplaceCertificateKeyStoreContent This class provides aReplaceCertificateKeyStoreContent
implementation to indicate that the certificate chain and private key (in either PEM or DER format) are provided directly in the extended request.ChangelogBatchChangeSelectionCriteria This class defines an API that should be implemented by classes which may represent a way to pare down the changelog entries that should be returned (e.g., so that they only include changes to a particular attribute or set of attributes) when using theGetChangelogBatchExtendedRequest
.ChangelogBatchStartingPoint This class defines the API that should be implemented by classes which may represent a way to identify the start of a batch of changes to retrieve using theGetChangelogBatchExtendedRequest
.ChangelogEntryIntermediateResponse This class provides an implementation of an intermediate response which provides information about a changelog entry returned from a Directory Server.ChangeTimeStartingPoint This class provides an implementation of a changelog batch starting point which may be used to start a batch of changes at a specified time.ClearMissedNotificationChangesAlarmExtendedRequest This class provides an extended request that may be used to clear a server alarm condition about missed change notifications.CollectSupportDataArchiveFragmentIntermediateResponse This class provides an implementation of an intermediate response that can provide the client with a portion of the support data archive generated in response to aCollectSupportDataExtendedRequest
.CollectSupportDataExtendedRequest This class provides an implementation of an extended request that may be used to invoke the collect-support data tool in a Ping Identity Directory Server and stream the output (usingCollectSupportDataOutputIntermediateResponse
messages) and the resulting support data archive (usingCollectSupportDataArchiveFragmentIntermediateResponse
messages) back to the client before the finalCollectSupportDataExtendedResult
response.CollectSupportDataExtendedRequestProperties This class defines a set of properties that may be used when creating aCollectSupportDataExtendedRequest
.CollectSupportDataExtendedResult This class provides an implementation of an extended result that provides information about the result of processing aCollectSupportDataExtendedRequest
.CollectSupportDataLogCaptureWindow This class defines an API that may be used to indicate how the tool should determine which log content to include in the support data archive when processing aCollectSupportDataExtendedRequest
.CollectSupportDataOutputIntermediateResponse This class provides an implementation of an intermediate response that can provide the client with output from the collect-support-data tool in response to aCollectSupportDataExtendedRequest
.ConsumeSingleUseTokenExtendedRequest This class provides an implementation of an extended request that can be used to consume a single-use token that was generated and provided to the user through the deliver single-use token extended operation.DeleteNotificationDestinationExtendedRequest This class provides an extended request that may be used to delete a notification destination.DeleteNotificationSubscriptionExtendedRequest This class provides an extended request that may be used to delete a notification subscription.DeliverOneTimePasswordExtendedRequest This class provides an implementation of an extended request that may be used to request that the Directory Server deliver a one-time password to an end user that they may use to authenticate via anUnboundIDDeliveredOTPBindRequest
.DeliverOneTimePasswordExtendedResult This class provides an implementation of an extended result that may be used to provide information about the result of processing for a deliver one-time password extended request.DeliverPasswordResetTokenExtendedRequest This class provides an implementation of an extended request that can be used to trigger the delivery of a temporary one-time password reset token to a specified user.DeliverPasswordResetTokenExtendedResult This class provides an implementation of an extended result that may be used to provide information about the result of processing for a deliver password reset token extended request.DeliverSingleUseTokenExtendedRequest This class provides an implementation of an extended request that can be used to trigger the delivery of a temporary single-use token to a specified user via some out-of-band mechanism.DeliverSingleUseTokenExtendedResult This class provides an implementation of an extended result that may be used to provide information about the result of processing for a deliver single-use token extended request.DeregisterYubiKeyOTPDeviceExtendedRequest This class provides an implementation of an extended request that may be used to deregister a YubiKey OTP device with the Directory Server so that it may no longer used to authenticate using the UNBOUNDID-YUBIKEY-OTP SASL mechanism.DurationCollectSupportDataLogCaptureWindow This class provides a collect support data log capture window implementation that indicates that the tool should capture information for a specified length of time up to the time theCollectSupportDataExtendedRequest
was received.EndAdministrativeSessionExtendedRequest This class provides an implementation of the end administrative session extended request, which indicates that an administrative session created via with theStartAdministrativeSessionExtendedRequest
should be ended.EndBatchedTransactionExtendedRequest This class provides an implementation of the end batched transaction extended request.EndBatchedTransactionExtendedResult This class provides an implementation of the end batched transaction extended result.EndOfChangelogStartingPoint This class provides an implementation of a changelog batch starting point which may be used to start a batch of changes at the end of the changelog.GeneratedPassword This class defines a data structure that holds information about a password generated by the server and returned to the client in aGeneratePasswordExtendedResult
.GeneratePasswordExtendedRequest This class provides an implementation of an extended request that may be used to request that the server suggest one or more passwords that the client may use in new entries, password changes, or administrative password resets.GeneratePasswordExtendedResult This class provides an implementation of an extended result that may be used provide the client with the passwords generated by the server in response to aGeneratePasswordExtendedRequest
.GenerateTOTPSharedSecretExtendedRequest This class provides an implementation of an extended request that may be used to generate a shared secret for use in generating TOTP authentication codes (as per RFC 6238, for example, using the mechanism provided in theOneTimePassword
class), which can be used to authenticate to the server via theUnboundIDTOTPBindRequest
.GenerateTOTPSharedSecretExtendedResult This class provides an implementation of an extended result that may be used to provide the client with a TOTP shared secret generated by the server in response to aGenerateTOTPSharedSecretExtendedRequest
.GetBackupCompatibilityDescriptorExtendedRequest This class provides an implementation of an extended request that can be used to retrieve backup compatibility data for a Directory Server backend.GetBackupCompatibilityDescriptorExtendedResult This class provides an implementation of an extended result that can be used to retrieve backup compatibility data for a Directory Server backend.GetChangelogBatchExtendedRequest This class provides an implementation of an extended request which may be used to retrieve a batch of changes from a Directory Server.GetChangelogBatchExtendedResult This class provides an extended result that may be used to obtain information about the results of processing a get changelog batch extended request.GetConfigurationExtendedRequest This class provides an implementation of an extended request that can be used to retrieve a version of the server configuration.GetConfigurationExtendedResult This class provides an implementation of an extended result that can be used to retrieve a version of the server configuration.GetConnectionIDExtendedRequest This class provides an implementation of the get connection ID extended operation as used in the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server.GetConnectionIDExtendedResult This class implements a data structure for storing the information from an extended result for the get connection ID extended request.GetPasswordQualityRequirementsExtendedRequest This class provides an implementation of an extended request that may be used to retrieve the set of password quality requirements that the Directory Server will impose for a specified operation, which may include adding a new user (including a password), a user changing his/her own password (a self change), or one user changing the password for another user (an administrative reset).GetPasswordQualityRequirementsExtendedResult This class provides an implementation of an extended result that can provide information about the requirements that the server will enforce for operations that change or replace a user's password, including adding a new user, a user changing his/her own password, and an administrator resetting another user's password.GetSubtreeAccessibilityExtendedRequest This class provides an implementation of the get subtree accessibility extended request, which may be used to request information about all subtree accessibility restrictions currently defined in the server, including for subtrees that are hidden or read-only.GetSubtreeAccessibilityExtendedResult This class provides an implementation of an extended result that holds information about the response returned from aGetSubtreeAccessibilityExtendedRequest
.GetSupportedOTPDeliveryMechanismsExtendedRequest This class provides an implementation of an extended request that can be used to retrieve information about which one-time password delivery mechanisms are supported for a user.GetSupportedOTPDeliveryMechanismsExtendedResult This class provides an implementation of an extended result that may be used to provide information about which one-time password delivery mechanisms are supported for a user.HeadAndTailSizeCollectSupportDataLogCaptureWindow This class provides a collect support data log capture window implementation that indicates that the tool should capture a specified amount of data (in kilobytes) from the beginning and end of each log file when processing aCollectSupportDataExtendedRequest
.IdentifyBackupCompatibilityProblemsExtendedRequest This class provides an implementation of an extended request that can be used to identify potential incompatibility problems between two backup compatibility descriptor values.IdentifyBackupCompatibilityProblemsExtendedResult This class provides an implementation of an extended result that can be used to identify potential incompatibility problems between two backup compatibility descriptor values.IgnoreAttributesChangeSelectionCriteria This class provides an implementation of a get changelog batch change selection criteria value that indicates that the server should not return changes which target only the specified attributes.JVMDefaultReplaceCertificateTrustBehavior This class provides aReplaceCertificateTrustBehavior
implementation to indicate that the listener certificate should be trusted by the JVM's default trust manager.KeyStoreDataReplaceCertificateKeyStoreContent This class provides aReplaceCertificateKeyStoreContent
implementation to indicate that the server should use a certificate key store whose content (that is, the bytes that comprise the key store file) is provided directly in the extended request.KeyStoreFileReplaceCertificateKeyStoreContent This class provides aReplaceCertificateKeyStoreContent
implementation to indicate that the server should use a certificate key store file contained on the server filesystem.ListConfigurationsExtendedRequest This class provides an implementation of an extended request that can be used to retrieve a list of all available versions of the configuration within a server.ListConfigurationsExtendedResult This class provides an implementation of an extended result that can be used to retrieve a list of all available versions of the configuration within a server.ListNotificationSubscriptionsExtendedRequest This class provides an extended request that may be used to retrieve a list of the subscriptions associated with a specified notification manager, optionally restricted to a specified set of destinations.ListNotificationSubscriptionsExtendedResult This class provides an implementation of an extended result that can be used to provide information about the notification subscriptions defined in the target server.MissingChangelogEntriesIntermediateResponse This class provides an implementation of an intermediate response which indicates that the Directory Server may have already purged information about one or more changes.MultiUpdateExtendedRequest This class provides an implementation of an extended request that can be used to send multiple update requests to the server in a single packet, optionally processing them as a single atomic unit.MultiUpdateExtendedResult This class provides an implementation of an extended result that can be used to provide information about the processing for aMultiUpdateExtendedRequest
.NotificationDestinationChangeSelectionCriteria This class provides an implementation of a get changelog batch change selection criteria value that indicates that the server should only return changes that are associated with a specified notification destination, as specified by the entryUUID for the notification destination to target.NotificationDestinationDetails This class represents a data structure with information about a notification destination defined in a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server instance.NotificationSubscriptionDetails This class represents a data structure with information about a notification subscription defined in a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server instance.PasswordPolicyStateAccountUsabilityError This class defines a data structure that will provide information about errors that may affect an account's usability.PasswordPolicyStateAccountUsabilityNotice This class defines a data structure that will provide information about notices pertaining to a user's password policy state (items that might be of interest, but do not necessarily represent a current or imminent problem with the account).PasswordPolicyStateAccountUsabilityWarning This class defines a data structure that will provide information about warnings that may affect an account's usability.PasswordPolicyStateExtendedRequest This class provides an implementation of the password policy state extended request as used in the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server.PasswordPolicyStateExtendedResult This class implements a data structure for storing the information from an extended result for the password policy state extended request as used in the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server.PasswordPolicyStateOperation This class defines an operation that may be used in conjunction with the password policy state extended operation.PasswordQualityRequirement This class provides a data structure that describes a requirement that passwords must satisfy in order to be accepted by the server.PurgeRetiredInterServerCertificatesExtendedRequest This class defines an extended request that may be used to request that a Ping Identity Directory Server instance (or related Ping Identity server product) purge information about any retired inter-server certificates from its topology registry.PurgeRetiredInterServerCertificatesExtendedResult This class implements an extended result that may be returned in response to aPurgeRetiredInterServerCertificatesExtendedRequest
.PurgeRetiredListenerCertificatesExtendedRequest This class defines an extended request that may be used to request that a Ping Identity Directory Server instance (or related Ping Identity server product) purge information about any retired listener certificates from its topology registry.PurgeRetiredListenerCertificatesExtendedResult This class implements an extended result that may be returned in response to aPurgeRetiredListenerCertificatesExtendedRequest
.RegisterYubiKeyOTPDeviceExtendedRequest This class provides an implementation of an extended request that may be used to register a YubiKey OTP device with the Directory Server so that it may be used to authenticate using the UNBOUNDID-YUBIKEY-OTP SASL mechanism.ReplaceCertificateExtendedResult This class defines the superclass for extended results that may be returned in response to the replace certificate extended requests, includingReplaceListenerCertificateExtendedRequest
,ReplaceInterServerCertificateExtendedRequest
,PurgeRetiredListenerCertificatesExtendedRequest
, andPurgeRetiredInterServerCertificatesExtendedRequest
.ReplaceCertificateKeyStoreContent This class acts as a superclass for objects that may be used to indicate how a certificate key store may be made available to a server instance when replacing listener or inter-server certificates.ReplaceCertificateTrustBehavior This class acts as a superclass for objects that may be used to indicate how the server should handle updating trust information for a new listener certificate chain.ReplaceInterServerCertificateExtendedRequest This class defines an extended request that may be used to request that a Ping Identity Directory Server instance (or related Ping Identity server product) replace its inter-server certificate.ReplaceInterServerCertificateExtendedResult This class implements an extended result that may be returned in response to aReplaceInterServerCertificateExtendedRequest
.ReplaceListenerCertificateExtendedRequest This class defines an extended request that may be used to request that a Ping Identity Directory Server instance (or related Ping Identity server product) replace its listener certificate.ReplaceListenerCertificateExtendedResult This class implements an extended result that may be returned in response to aReplaceListenerCertificateExtendedRequest
.ResumeWithCSNStartingPoint This class provides an implementation of a changelog batch starting point which may be used to start a batch of changes at a change identified by a replication CSN.ResumeWithTokenStartingPoint This class provides an implementation of a changelog batch starting point which may be used to start a batch of changes at a point where a previous batch ended.RevokeTOTPSharedSecretExtendedRequest This class provides an implementation of an extended request that may be used to revoke one or all of the TOTP shared secrets for a user so that they may no longer be used to authenticate.SetNotificationDestinationExtendedRequest This class provides an extended request that may be used to create or update a notification destination.SetNotificationSubscriptionExtendedRequest This class provides an extended request that may be used to create or update a notification subscription.SetSubtreeAccessibilityExtendedRequest This class provides an implementation of an extended request that may be used to set the accessibility of one or more subtrees in the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server.StartAdministrativeSessionExtendedRequest This class provides an implementation of the start administrative session extended request, which clients may use to indicate that they are going to perform a set of administrative operations in the server.StartAdministrativeSessionPostConnectProcessor This class provides an implementation of a post-connect processor that can be used to start an administrative session on a connection that is meant to be part of a connection pool.StartBatchedTransactionExtendedRequest This class provides an implementation of the start batched transaction extended request.StartBatchedTransactionExtendedResult This class implements a data structure for storing the information from an extended result for the start batched transaction extended request.StreamDirectoryValuesExtendedRequest This class provides an implementation of the stream directory values extended request as used in the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server.StreamDirectoryValuesIntermediateResponse This class provides an implementation of the stream directory values intermediate response, which may be used to provide a partial or complete list of the values for a specified attribute, or DNs of entries contained in a specified portion of the server DIT.StreamProxyValuesBackendSet This class provides a data structure for holding information about the configuration of backend sets as used by the stream proxy values extended request.StreamProxyValuesBackendSetValue This class provides a data structure for holding a value included in the stream proxy values intermediate response.StreamProxyValuesExtendedRequest This class provides an implementation of the stream proxy values extended request as used in the Ping Identity, UnboundID, Nokia/Alcatel-Lucent 8661 Directory Proxy Server.StreamProxyValuesIntermediateResponse This class provides an implementation of the stream proxy values intermediate response, which may be used to provide a partial or complete list of the values for a specified attribute, or DNs of entries contained in a specified portion of the server DIT.SubtreeAccessibilityRestriction This class defines a data structure with information about a subtree with restricted access, as may be included in aGetSubtreeAccessibilityExtendedResult
.SupportedOTPDeliveryMechanismInfo This class provides a data structure with information about a one-time password delivery mechanism that is supported by the Directory Server and may or may not be supported for a particular user.TimeWindowCollectSupportDataLogCaptureWindow This class provides a collect support data log capture window implementation that indicates that the tool should capture information for a specified window of time (between start and end times, inclusive) when processing aCollectSupportDataExtendedRequest
.ToolDefaultCollectSupportDataLogCaptureWindow This class provides a collect support data log capture window implementation that indicates that the tool should use its default logic when determining which log content to include in the support data archive when processing aCollectSupportDataExtendedRequest
.TrustManagerProviderReplaceCertificateTrustBehavior This class provides aReplaceCertificateTrustBehavior
implementation to indicate that the server should update a specified trust manager provider.ValidateTOTPPasswordExtendedRequest This class provides an implementation of an extended request which may be used to validate a TOTP password for a user. -
Enum Summary Enum Description CollectSupportDataOutputStream This enum defines the output stream values that may be used in conjunction with theCollectSupportDataOutputIntermediateResponse
.GeneratePasswordPolicySelectionType This enum describes the mechanism that the server should use when selecting the password policy to use (for its password generator and validators) while processing aGeneratePasswordExtendedRequest
.GetConfigurationType This enum defines the types of configurations that may be obtained using the get configuration extended operation.GetPasswordQualityRequirementsTargetType This enum specifies the modes in which the get password quality requirements extended operation may determine the type of password update operation that will be performed and the way in which the server should determine which password policy to use in order to obtain the password quality requirements.MultiUpdateChangesApplied This enum defines the set of possible values for the element of a multi-update result which indicates whether any updates were applied to server data.MultiUpdateErrorBehavior This enum defines the set of possible error behavior values that may be used in the multi-update extended request.SetNotificationDestinationChangeType This enum defines a set of change type values that may be used in conjunction with the set notification destination extended request.SubtreeAccessibilityState This enum defines the set of allowed accessibility states that may be used with theSetSubtreeAccessibilityExtendedRequest
.