Package com.unboundid.ldap.sdk.unboundidds

This package and its subordinate packages contain a set of classes which provide enhanced functionality for interacting with the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server products.

See: Description

Interface Summary

Interface	Description
MoveSubtreeListener	This interface defines an API that may be implemented by classes which wish to be notified of processing performed in the course of moving a subtree between servers.

Class Summary

Class	Description
ActiveAlertsLDAPConnectionPoolHealthCheck	This class provides an LDAP connection pool health check implementation that will attempt to retrieve the general monitor entry from a Ping Identity Directory Server instance to determine if it has any degraded and/or unavailable alert types.
AES256EncodedPassword	This class provides a mechanism that can be used to encrypt and decrypt passwords using the same mechanism that the Ping Identity Directory Server uses for the AES256 password storage scheme (for clients that know the passphrase used to generate the encryption key).
AES256EncodedPasswordSecretKey	This class provides a data structure that may be used to hold a reusable secret key for use in conjunction with AES256EncodedPassword objects.
AlarmEntry	This class provides a data structure for representing an administrative entry as exposed by the alarms backend in the Directory Server.
AlertEntry	This class provides a data structure for representing an administrative entry as exposed by the alerts backend in the Directory Server.
ChangeLogEntryAttributeExceededMaxValuesCount	This class provides a data structure for holding information read from a value of the ds-changelog-attr-exceeded-max-values-count attribute.
DeliverOneTimePassword	This class provides a utility that may be used to request that the Directory Server deliver a one-time password to a user through some out-of-band mechanism.
DeliverPasswordResetToken	This class provides a utility that may be used to request that the Directory Server deliver a single-use password reset token to a user through some out-of-band mechanism.
Launcher	This class provides an entry point that may be used to launch other tools provided as part of the LDAP SDK.
LDAPConnectionHandlerConfiguration	This class provides a data structure that holds information about an LDAP connection handler defined in the configuration of a Ping Identity Directory Server instance.
LockdownModeLDAPConnectionPoolHealthCheck	This class provides an LDAP connection pool health check implementation that can determine whether a Ping Identity Directory Server instance is currently in lockdown mode.
ModifiablePasswordPolicyStateJSON	This class provides support for reading and decoding the value of the ds-pwp-modifiable-state-json virtual attribute, which may be used to manipulate elements of a user's password policy state.
ModifiablePasswordPolicyStateJSONBuilder	This class provides support for generating a JSON object that may be included in a REPLACE modification to the ds-pwp-modifiable-state-json operational attribute to manipulate elements in the user's password policy state.
MoveSubtree	This class provides a utility that may be used to move a single entry or a small subtree of entries from one server to another.
MoveSubtreeProperties	This class defines a number of properties that can be used when attempting to move a subtree from one Ping Identity Directory Server instance to another Ping Identity Directory Server instance using restricted subtree accessibility.
MoveSubtreeResult	This class provides a data structure that holds information about the result of a move subtree operation.
OneTimePassword	This class provides support for a number of one-time password algorithms.
PasswordPolicyStateJSON	This class provides support for reading and decoding the value of the ds-pwp-state-json virtual attribute, which holds information about a user's password policy state.
RegisterYubiKeyOTPDevice	This class provides a utility that may be used to register a YubiKey OTP device for a specified user so that it may be used to authenticate that user.
ReplicationBacklogLDAPConnectionPoolHealthCheck	This class provides an LDAP connection pool health check implementation that can be used to examine the replication backlog (reflecting changes that have been made in other replicas but have not yet been applied in the local instance) of a Ping Identity Directory Server instance.
ReusableTOTPBindRequest	This class provides an implementation of the UNBOUNDID-TOTP SASL bind request that may be used to repeatedly generate one-time password values.
SingleUseTOTPBindRequest	This class provides an implementation of the UNBOUNDID-TOTP SASL bind request that contains a point-in-time version of the one-time password and can be used for a single bind but is not suitable for repeated use.
SoftDeletedEntry	This class provides a data structure for representing information about a soft-deleted entry, which results from a soft delete operation that has caused the entry to be hidden so that it is not accessible to clients under normal circumstances, rather than causing the entry to be completely removed from the server.
TopologyRegistryTrustManager	This class provides an implementation of an X.509 trust manager that can be used to trust certificates listed in the topology registry of a Ping Identity Directory Server instance.
TopologyRegistryTrustManagerProperties	This class defines a number of configuration properties that may be used by the TopologyRegistryTrustManager.
UnboundIDCertificatePlusPasswordBindRequest	This class provides support for an UnboundID-proprietary SASL mechanism that provides multifactor authentication using the combination of a client certificate (presented during SSL/TLS negotiation) and a static password.
UnboundIDChangeLogEntry	This class provides an implementation of a changelog entry which provides support for all standard changelog entry attributes as well as those unique to the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server.
UnboundIDDeliveredOTPBindRequest	This class provides support for an UnboundID-proprietary SASL mechanism that allows for multifactor authentication using a one-time password that has been delivered to the user via some out-of-band mechanism as triggered by the DeliverOneTimePasswordExtendedRequest (which requires the user to provide an authentication ID and a static password).
UnboundIDExternallyProcessedAuthenticationBindRequest	This class provides support for an UnboundID-proprietary SASL mechanism that may be used to indicate that a user has attempted authentication, whether successfully or not, through some mechanism that is external to the Directory Server.
UnboundIDRootDSE	This class provides an enhanced implementation of the RootDSE class that provides access to additional attributes that may be included in the root DSE of a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server.
UnboundIDTOTPBindRequest	This class provides support for an UnboundID-proprietary SASL mechanism that uses the time-based one-time password mechanism (TOTP) as described in RFC 6238, optionally (based on the server configuration) in conjunction with a static password for a form of multifactor authentication.
UnboundIDYubiKeyOTPBindRequest	This class provides an implementation of a SASL bind request that may be used to authenticate to a Directory Server using the UNBOUNDID-YUBIKEY-OTP mechanism.

Enum Summary

Enum	Description
AlarmSeverity	This class provides information about the types of alarm severities that may be included in alarm entries.
AlertSeverity	This class provides information about the types of alert severities that may be included in alert entries.
ModifiablePasswordPolicyStateJSONField	This enum defines the set of fields that are supported for use with the ModifiablePasswordPolicyStateJSON object.
PasswordPolicyStateJSONField	This enum defines the set of fields that are supported for use with the PasswordPolicyStateJSON object.

Exception Summary

Exception	Description
ChangeLogEntryAttributeExceededMaxValuesException	This class provides an exception that may be thrown when attempting to obtain the value of an updated attribute as it appeared before or after a change was processed, but the number of values for that attribute exceeded the maximum number to include in a changelog entry.

Package com.unboundid.ldap.sdk.unboundidds Description

This package and its subordinate packages contain a set of classes which provide enhanced functionality for interacting with the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server products. These classes are not supported for use with any other type of 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.