All Classes and Interfaces

Class
Description
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an abandon request forwarded to a backend server.
This class provides a data structure that holds information about an abandon forward access log message.
This class provides a data structure that holds information about an abandon forward failed access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an abandon request received from a client.
This class provides a data structure that holds information about an abandon request access log message.
This class provides an implementation of an LDAP abandon request protocol op.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of an abandon operation processed by the Directory Server.
This class provides a data structure that holds information about an abandon operation result access log message.
This class provides an implementation of the aborted transaction extended result as defined in RFC 5805, which is used as an unsolicited notification to indicate that the server has aborted an LDAP transaction without the client's explicit request.
This class provides the base class for LDAP connection pool implementations provided by the LDAP SDK for Java.
This class provides a common matching rule framework that may be extended by matching rule implementations in which equality, ordering, and substring matching can all be made based on byte-for-byte comparisons of the normalized value, and any value is acceptable.
This class provides a request control that can be included in any type of request to indicate that the server should include one or more fields, specified as name-value pairs, that should appear in the Ping Identity Directory Server's access log message for the operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log.
This class provides a data structure that holds information about an access log message.
This enum defines the set of access log message types.
This enum defines the set of access log operation types.
This class provides a mechanism for reading messages from a Directory Server access log.
This class defines an API for reading access log messages.
This class provides a request handler that may be used to log each request and result using the Java logging framework.
This class provides an implementation of the account usable request control.
This class provides an implementation of the account usable response control, which may be returned with search result entries to provide information about the usability of the associated user accounts.
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.
This class provides support for a control that may be used to poll an Active Directory Server for information about changes that have been processed.
This class defines a monitor entry that provides information about the operations currently being processed by the Directory Server.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of replication assurance processing for an add operation.
This class provides a data structure that holds information about an add assurance completed access log message.
This class provides an implementation of an entry transformation that will add a specified attribute with a given set of values to any entry that does not already contain that attribute and matches a specified set of criteria.
This class provides a data structure that holds information about an audit log message that represents an add operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an add request forwarded to a backend server.
This class provides a data structure that holds information about an add forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an add request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about an add forward failed access log message.
This class implements the processing necessary to perform an LDAPv3 add operation, which creates a new entry in the directory.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an add request received from a client.
This class provides a data structure that holds information about an add request access log message.
This class provides an implementation of an LDAP add request protocol op.
This class provides an implementation of an add response protocol op.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of an add operation processed by the Directory Server.
This class provides a data structure that holds information about an add operation result access log message.
This class defines a Directory Server task that can be used to add the contents of one or more files to the server schema.
This class provides an implementation of a Directory Server control that may be used to indicate that the associated operation is used for performing some administrative operation within the server rather than one that was requested by a "normal" client.
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).
This class provides a data structure that may be used to hold a reusable secret key for use in conjunction with AES256EncodedPassword objects.
This class provides an implementation of a control that can be used to establish an affinity for one or more operations through a ForgeRock Directory Proxy Server.
This class provides an input stream implementation that can aggregate multiple input streams.
This class provides an LDAPConnectionPoolHealthCheck implementation that may be used to invoke a series of subordinate health checks and ensure that all of them consider a connection valid before indicating that the connection is valid.
This class provides an implementation of an LDIF reader change record translator that can be used to invoke multiple LDIF reader change record translators for each record to be processed.
This class provides an implementation of an LDIF reader entry translator that can be used to invoke multiple LDIF reader entry translators for each entry to be processed.
This class provides an implementation of an LDIF writer change record translator that can be used to invoke multiple LDIF writer change record translators for each record to be processed.
This class provides an implementation of an LDIF writer entry translator that can be used to invoke multiple LDIF writer entry translators for each entry to be processed.
This class provides an implementation of a post-connect processor that makes it possible to invoke multiple post-connect processors as a single unit.
This class provides an SSL trust manager that has the ability to delegate the determination about whether to trust a given certificate to one or more other trust managers.
This class provides a data structure for representing an administrative entry as exposed by the alarms backend in the Directory Server.
This class provides information about the types of alarm severities that may be included in alarm entries.
This class provides a data structure for representing an administrative entry as exposed by the alerts backend in the Directory Server.
This class provides information about the types of alert severities that may be included in alert entries.
This class defines a Directory Server task that can be used to cause the server to generate administrative alerts, or to manage the set of degraded or unavailable alert types.
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.
This class provides an implementation of a JSON object filter that can perform a logical AND across the result obtained from a number of filters.
This class provides a SASL ANONYMOUS bind request implementation as described in RFC 4505.
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.
This class defines a generic command line argument, which provides functionality applicable to all argument types.
This class defines an exception that may be thrown if a problem occurs while parsing command line arguments or preparing the argument parser.
This class defines an argument whose values are intended to be argument strings as might be provided to a command-line application (e.g., "--arg1 arg1value --arg2 --arg3 arg3value").
This class provides an argument parser, which may be used to process command line arguments provided to Java applications.
This class defines an API that may be used to create argument value validators, which can be used to enforce additional constraints on the values provided to an argument.
This class provides an ASN.1 integer element that is backed by a Java BigInteger and whose value can be represented as an integer of any magnitude.
This class provides an ASN.1 bit string element, whose value represents a series of zero or more bits, where each bit is either one or zero.
This class provides an ASN.1 Boolean element, whose value is a single byte and represents either "TRUE" or "FALSE".
This class provides a mechanism for writing one or more ASN.1 elements into a byte string buffer.
This class provides a data structure which is used in the course of writing an ASN.1 sequence to an ASN.1 buffer.
This class provides a data structure which is used in the course of writing an ASN.1 set to an ASN.1 buffer.
This class defines a generic ASN.1 BER element, which has a type and value.
This class provides an ASN.1 enumerated element.
This class defines an exception that can be thrown if a problem occurs while interacting with ASN.1 BER elements.
This class provides an ASN.1 generalized time element, which represents a timestamp in the generalized time format.
This class provides an ASN.1 IA5 string element that can hold any empty or non-empty string comprised only of the ASCII characters (including ASCII control characters).
This class provides an ASN.1 integer element that is backed by a Java int, which is a signed 32-bit value and can represent any integer between -2147483648 and 2147483647.
This class provides an ASN.1 integer element that is backed by a Java long, which is a signed 64-bit value and can represent any integer between -9223372036854775808 and 9223372036854775807.
This class provides an ASN.1 null element, which does not hold a value.
This class provides an ASN.1 numeric string element that can hold any empty or non-empty string comprised only of the ASCII numeric digits '0' through '9' and the ASCII space.
This class provides an ASN.1 object identifier element, whose value represents a numeric OID.
This class provides an ASN.1 octet string element, whose value is simply comprised of zero or more bytes.
This class provides an ASN.1 printable string element that can hold any empty or non-empty string comprised only of the characters listed below.
This class provides an ASN.1 sequence element, which is used to hold an ordered set of zero or more other elements (potentially including additional "envelope" element types like other sequences and/or sets).
This class provides an ASN.1 set element, which is used to hold a set of zero or more other elements (potentially including additional "envelope" element types like other sequences and/or sets) in which the order of those elements should not be considered significant.
This class provides a mechanism for ASN.1 elements (including sequences and sets) from an input stream in a manner that allows the data to be decoded on the fly without constructing ASN1Element objects if they are not needed.
This class provides a data structure which is used in the course of reading an ASN.1 sequence from an ASN.1 stream reader.
This class provides a data structure which is used in the course of reading an ASN.1 set from an ASN.1 stream reader.
This class provides an ASN.1 UTC time element, which represents a timestamp with a string representation in the format "YYMMDDhhmmssZ".
This class provides an ASN.1 UTF-8 string element that can hold any string value that can be represented in the UTF-8 encoding.
This class provides an efficient mechanism for writing ASN.1 elements to output streams.
This class provides an implementation of the LDAP assertion request control as defined in RFC 4528.
This class provides a data structure that holds information about an assurance completed access log message.
This enum defines an assurance level that may be used for servers in the same location as the server receiving the change.
This enum defines an assurance level that may be used for servers in different locations from the server receiving the change.
This class provides an implementation of an LDAP control that can be included in add, bind, modify, modify DN, and certain extended requests to indicate the level of replication assurance desired for the associated operation.
This class provides an implementation of an LDAP control that can be included in add, bind, modify, modify DN, and certain extended responses to provide information about the result of replication assurance processing for that operation.
This class defines a data structure that provides information about the result of assured replication processing, either on a replication server (if that is all that is needed to satisfy the desired level of assurance) or on a directory server (if required by the desired level of assurance).
This enum defines the set of result code values that may be included in a an assured replication server result.
This interface provides a mechanism for notifying a client when the result for an asynchronous compare operation has been received.
This class defines an object that provides information about a request that was initiated asynchronously.
This interface provides a mechanism for notifying a client when the result for an asynchronous operation has been received.
This interface provides a mechanism for notifying a client when the search result done message for an asynchronous search operation has been received.
This class provides a data structure for holding information about an LDAP attribute, which includes an attribute name (which may include a set of attribute options) and zero or more values.
This class provides an implementation of an argument value validator that is expected to be used with a string argument and ensures that all values for the argument are valid attribute type names (or numeric OIDs) or attribute descriptions (a name or OID with attribute options).
This enum contains the set of possible attribute-level rights that may be described for an attribute in an entry retrieved with the get effective rights control.
This class provides a data structure that describes an LDAP attribute syntax schema element.
This class provides a data structure that describes an LDAP attribute type schema element.
This enum defines the set of attribute type usages that are defined in the LDAP protocol.
This class defines a Directory Server task that can be used to cause the server to initiate a data security audit, which can look for potential issues in the environment that can impact the security of the directory environment.
This class defines an exception that may be thrown if a problem occurs while attempting to parse an audit log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server audit log.
This class provides a mechanism for reading messages from a Directory Server audit log.
This class defines a data structure that will provide information about errors that could cause an authentication attempt to fail.
This class provides an implementation of the authority key identifier X.509 certificate extension as described in RFC 5280 section 4.2.1.1.
This class provides an implementation of the authorization identity bind request control as described in RFC 3829.
This class provides an implementation of the authorization identity bind response control as defined in RFC 3829.
This class provides a tool that can be used to test authentication processing in an LDAP directory server using multiple threads.
This class defines a monitor entry that provides general information about a Directory Server backend.
This class defines a Directory Server task that can be used to back up one or more Directory Server backends.
This class provides methods for encoding and decoding data in base32 as defined in RFC 4648.
This class provides methods for encoding and decoding data in base64 as defined in RFC 4648.
This class defines a set of properties that can be used to indicate which types of optional base64-encoding should be performed by the LDAP SDK.
This class provides an implementation of a password encoder output formatter that will format the encoded password using the base64 mechanism described in RFC 4648.
This class provides a tool that can be used to perform base64 encoding and decoding from the command line.
This class provides a basic implementation of the AsyncCompareResultListener interface that will merely set the result object to a local variable that can be accessed through a getter method.
This class provides a basic implementation of the AsyncResultListener interface that will merely set the result object to a local variable that can be accessed through a getter method.
This class provides a basic implementation of the AsyncSearchResultListener interface that will merely set the result object to a local variable that can be accessed through a getter method.
This class provides an implementation of the basic constraints X.509 certificate extension as described in RFC 5280 section 4.2.1.9.
This class provides an implementation of the batched transaction specification request control, which may be used to indicate that the associated add, delete, modify, modify DN, or password modify operation is part of a batched transaction.
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.
This enum defines a set of size units that can be used to represent data sizes in varying units (bytes, kilobytes, megabytes, gigabytes, etc.).
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a bind request forwarded to a backend server.
This class provides a data structure that holds information about a bind forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a bind request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about a bind forward failed access log message.
This class provides an API that is used to represent an LDAP bind request.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a bind request received from a client.
This class provides a data structure that holds information about a bind request access log message.
This enum defines the set of authentication types that may appear in log messages about bind operations.
This class provides an implementation of an LDAP bind request protocol op.
This class provides an implementation of a bind response protocol op.
This class provides a data structure for holding information about the result of processing a bind operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of a bind operation processed by the Directory Server.
This class provides a data structure that holds information about a bind operation result access log message.
Creates a new argument that is intended to represent Boolean states based on whether it was present in the provided set of command-line arguments.
This class defines a log field syntax for Boolean values.
This class provides an implementation of a matching rule that performs equality comparisons against Boolean values, which should be either "TRUE" or "FALSE".
Creates a new argument that is intended to represent Boolean states based on the value provided for this argument.
This interface defines a set of methods for treating a value as either a string or byte array.
This class provides a growable byte array to which data can be appended.
This class provides a mechanism for creating ByteString values.
This class provides an implementation of a NameResolver that will cache lookups to potentially improve performance and provide a degree of resiliency against name service outages.
This class provides an implementation of the LDAP cancel extended request as defined in RFC 3909.
This class provides a very simple LDAP listener request handler implementation that simply returns a canned response to the client for each type of operation.
This class provides an implementation of a matching rule that uses case-sensitive matching that also treats multiple consecutive (non-escaped) spaces as a single space.
This class provides an implementation of a matching rule that may be used to process values containing lists of items, in which each item is separated by a dollar sign ($) character.
This class provides an implementation of a matching rule that uses case-insensitive matching that also treats multiple consecutive (non-escaped) spaces as a single space.
This class defines an exception that can be thrown if a problem is encountered while performing certificate processing.
This class provides a ReplaceCertificateKeyStoreContent implementation to indicate that the certificate chain and private key (in either PEM or DER format) are provided directly in the extended request.
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 the GetChangelogBatchExtendedRequest.
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 the GetChangelogBatchExtendedRequest.
This class provides a data structure for representing a changelog entry as described in draft-good-ldap-changelog.
This class provides a data structure for holding information read from a value of the ds-changelog-attr-exceeded-max-values-count attribute.
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.
This class provides an implementation of an intermediate response which provides information about a changelog entry returned from a Directory Server.
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.
This class provides an implementation of a control that may be used to request that the server return the replication change sequence number (CSN) that it has assigned to the associated add, delete, modify, or modify DN operation.
This class provides an implementation of a control that may be used to provide the replication change sequence number (CSN) in the response to an add, delete, modify, or modify DN request that included the change sequence number request control.
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.
This enum defines a set of change types that are associated with operations that may be processed in an LDAP directory server.
This class provides an implementation of an in-memory directory server password encoder that leaves the password in the clear.
This class provides an extended request that may be used to clear a server alarm condition about missed change notifications.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a client certificate that has been presented to the server.
This class provides a data structure that holds information about a client certificate access log message.
This class defines a monitor entry that provides general information about the client connections currently established.
This class provides an implementation of a reentrant lock that can be used with the Java try-with-resources facility.
This class provides an implementation of a reentrant read-write lock that can be used with the Java try-with-resources facility.
This class provides a command-line tool that may be used to invoke the collect-support-data utility in the Ping Identity Directory Server and related server products.
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 a 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 (using CollectSupportDataOutputIntermediateResponse messages) and the resulting support data archive (using CollectSupportDataArchiveFragmentIntermediateResponse messages) back to the client before the final CollectSupportDataExtendedResult response.
This class defines a set of properties that may be used when creating a CollectSupportDataExtendedRequest.
This class provides an implementation of an extended result that provides information about the result of processing a CollectSupportDataExtendedRequest.
This interface provide an API that may be used to handle intermediate response messages returned as part of processing for an CollectSupportDataExtendedRequest.
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 a CollectSupportDataExtendedRequest.
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 a CollectSupportDataExtendedRequest.
This enum defines the output stream values that may be used in conjunction with the CollectSupportDataOutputIntermediateResponse.
This enum defines the security level values that may be used in conjunction with the collect-support-data tool (and the corresponding administrative task and extended operation).
This class defines a Directory Server task that can be used to invoke the collect-support-data tool to capture a variety of information that may help monitor the state of the server or diagnose potential problems.
This class defines a set of properties that may be used when creating a CollectSupportDataTask.
This class provides an LDAPResultWriter instance that uses a ColumnFormatter to output search result entries in a format like CSV or tab-delimited text.
This class provides a utility for formatting output in multiple columns.
This class defines a log field syntax for values that are a comma-delimited list of strings.
This class provides a framework for developing command-line tools that use the argument parser provided as part of the UnboundID LDAP SDK for Java.
This class provides a data structure that represents a compact version of an entry.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a compare request forwarded to a backend server.
This class provides a data structure that holds information about a compare forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a compare request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about a compare forward failed access log message.
This class implements a command-line tool that can be used to retrieve the schemas from two LDAP servers and identify any differences between them.
This class implements the processing necessary to perform an LDAPv3 compare operation, which may be used to determine whether a specified entry contains a given attribute value.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a compare request received from a client.
This class provides a data structure that holds information about a compare request access log message.
This class provides an implementation of an LDAP compare request protocol op.
This class provides an implementation of a compare response protocol op.
This class provides a data structure for holding information about the result of processing a compare operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of a compare operation processed by the Directory Server.
This class provides a data structure that holds information about a compare operation result access log message.
This class provides an implementation of an LDAP listener request handler that can be used to limit the number of requests that may be processed concurrently.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a connection that has been established.
This class provides a data structure that holds information about a connect access log message.
This class defines a monitor entry that provides general information about a Directory Server connection handler.
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.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects containing a specified field, optionally restricting it by the data type of the value.
This class provides an implementation of the LDAP content synchronization done control as defined in RFC 4533.
This class provides an implementation of the sync info message, which is an intermediate response message used by the content synchronization operation as defined in RFC 4533.
This enum defines the synchronization states for entries returned with the content synchronization state control.
This class provides an implementation of the LDAP content synchronization request control as defined in RFC 4533.
This enum defines the modes which may be used with the content synchronization request control.
This enum defines the synchronization states for entries returned with the content synchronization state control.
This class provides an implementation of the LDAP content synchronization state control as defined in RFC 4533.
This class provides a data structure that represents an LDAP control.
This class defines an argument that is intended to hold information about one or more LDAP controls.
This class provides a SASL CRAM-MD5 bind request implementation as described in draft-ietf-sasl-crammd5.
This class implements a data structure that provides information about a CRL distribution point for use in conjunction with the CRLDistributionPointsExtension.
This enum defines a set of reasons for which a CRL distribution point may revoke a certificate.
This class provides an implementation of the CRL distribution points X.509 certificate extension as described in RFC 5280 section 4.2.1.13.
This class provides a means of enabling and configuring debugging in the LDAP SDK.
This enumeration defines a set of debugging types that are used by the LDAP SDK.
This enum defines a set of size units that can be used to represent data sizes in varying units (bytes, kilobytes, megabytes, gigabytes, etc.).
This interface defines a method that may be implemented by controls that may be included in the response from a directory server.
This class defines the parent class for a decoded private key that may appear in a PKCS #8 private key object.
This class defines the parent class for a decoded public key that may appear in an X.509 certificate.
This class provides a default implementation of a NameResolver that simply uses the JVM-default name resolution functionality.
This class provides the default implementation of an ObjectEncoder object that will be used when encoding and decoding fields to be written to or read from an LDAP directory server.
This class provides an OID allocator implementation that will generate OIDs which are equal to the lowercase name of the associated attribute type or object class followed by "-oid".
This class defines a Directory Server task that simply sleeps for a specified length of time or until a given condition occurs.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of replication assurance processing for a delete operation.
This class provides a data structure that holds information about a delete assurance completed access log message.
This class provides a data structure that holds information about an audit log message that represents a delete operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a delete request forwarded to a backend server.
This class provides a data structure that holds information about a delete forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a delete request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about a delete forward failed access log message.
This class provides an extended request that may be used to delete a notification destination.
This class provides an extended request that may be used to delete a notification subscription.
This class implements the processing necessary to perform an LDAPv3 delete operation, which removes an entry from the directory.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a delete request received from a client.
This class provides a data structure that holds information about a delete request access log message.
This class provides an implementation of an LDAP delete request protocol op.
This class provides an implementation of a delete response protocol op.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of a delete operation processed by the Directory Server.
This class provides a data structure that holds information about a delete operation result access log message.
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.
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 an UnboundIDDeliveredOTPBindRequest.
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.
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.
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.
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.
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.
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.
This class defines a data type for dereference policy values.
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.
This class provides a SASL DIGEST-MD5 bind request implementation as described in RFC 2831.
This class provides a data structure that may be used to hold a number of properties that may be used during processing for a SASL DIGEST-MD5 bind operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a connection that has been closed.
This class provides a data structure that holds information about a disconnect access log message.
This class defines a Directory Server task that can be used to request that the server terminate a client connection.
This interface defines an API that may be implemented by a class that should be notified whenever an LDAP connection is closed for any reason.
This enum defines a set of disconnect types that may be used to provide general information about the reason that an LDAPConnection was disconnected.
This class provides a data structure that may be used to hold information about disk space information for a Directory Server component.
This class defines a monitor entry that provides information about the disk space usage of the Directory Server.
This class provides an implementation of a matching rule that performs equality comparisons against values that should be distinguished names.
This class provides a data structure that describes an LDAP DIT content rule schema element.
This class provides a data structure that describes an LDAP DIT structure rule schema element.
This class provides a data structure for holding information about an LDAP distinguished name (DN).
This class defines an argument that is intended to hold one or more distinguished name values.
This class provides an EntrySource that will retrieve entries referenced by a provided set of DNs.
This class defines a set of properties that can be used to indicate which types of optional escaping should be performed by the LDAP SDK when constructing the string representation of DNs and RDNs.
This class provides a mechanism for reading DNs from a file.
This class defines a log field syntax for distinguished name values.
This class provides an implementation of an argument value validator that ensures that values can be parsed as valid DNS host names.
This class provides an LDAPResultWriter instance that simply prints the DNs of the entries that are returned, with a separate DN per line.
This class provides a server set implementation that can discover information about available directory servers through DNS SRV records as described in RFC 2782.
This class provides an implementation of the LDAP don't use copy control as defined in RFC 6171.
This enum defines a set of error types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy-10.
This class provides an implementation of the password policy request control as described in draft-behera-ldap-password-policy-10.
This class provides an implementation of the password policy response control as described in draft-behera-ldap-password-policy-10.
This enum defines a set of warning types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy-10.
This class represents an entry that holds information about an abandon operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about an add operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about a bind operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about a compare operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about a delete operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class serves as the base class for entries that hold information about operations processed by an LDAP server, much like LDAP-accessible access log messages.
This class represents an entry that holds information about an extended operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about a modify DN operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about a modify operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about a search operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class represents an entry that holds information about an unbind operation processed by an LDAP server, as per the specification described in draft-chu-ldap-logschema-00.
This class provides an implementation of the LDAP subentries request control as defined in draft-ietf-ldup-subentry.
This class provides an implementation of the LDAP no-op control as defined in draft-zeilenga-ldap-noop-12.
This class provides an implementation of the LDAP relax rules request control as defined in draft-zeilenga-ldap-relax-03.
This class defines a Directory Server task that can be used to dump information about the contents of a backend which stores its data in a Berkeley DB Java Edition database.
This class provides a utility that uses the stream directory values extended operation in order to obtain a listing of all entry DNs below a specified base DN in the Directory Server.
This enum defines a set of possible behaviors that may be exhibited by the LDIF reader when encountering entries with duplicate attribute values.
Creates a new argument that is intended to represent a duration.
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 the CollectSupportDataExtendedRequest was received.
This class provides a mechanism for extracting the effective rights information from an entry returned for a search request that included the get effective rights request control.
This class provides a data structure for representing the information contained in an elliptic curve private key.
This class provides a data structure for representing the information contained in an elliptic curve public key in an X.509 certificate.
This class provides an implementation of the end administrative session extended request, which indicates that an administrative session created via with the StartAdministrativeSessionExtendedRequest should be ended.
This class provides an implementation of the end batched transaction extended request.
This class provides an implementation of the end batched transaction extended result.
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.
This class provides an implementation of the end transaction extended request as defined in RFC 5805.
This class provides an implementation of the end transaction extended result as defined in RFC 5805.
This class defines a Directory Server task that can be used to cause the server to enter lockdown mode, in which case it will only allow requests from users with the lockdown-mode privilege.
This class provides a data structure for holding information about an LDAP entry.
This class defines a monitor entry that provides general information about the state of the Directory Server entry cache.
This class provides an implementation of the entry change notification control as defined in draft-ietf-ldapext-psearch.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a the beginning of an entry rebalancing operation.
This class provides a data structure that holds information about an entry rebalancing request access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a the result of an entry rebalancing operation.
This class provides a data structure that holds information about an entry rebalancing result access log message.
This enum contains the set of possible entry-level rights that may be described in an entry retrieved with the get effective rights control.
This class provides a mechanism for client-side entry sorting.
This class defines an API that may be implemented by a class that provides access to a sequence of entries, one entry at a time (e.g., entries read from an LDIF file, or returned as part of an LDAP search).
This class defines an exception that may be thrown if a problem occurs while trying to access an entry in an entry source (e.g., because the entry source is no longer available, because an entry could not be parsed, or because the next element returned was a search result reference rather than a search result entry).
This class defines an API that may be used to apply some kind of transformation to an entry to alter its contents or suppress it from further processing.
This class provides a mechanism for validating entries against a schema.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a specified field whose value matches one of specified set of values.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a particular value for a specified field.
This enum contains the set of error log categories defined in the Directory Server.
This class provides a data structure that holds information about a log message that may appear in the Directory Server error log.
This class provides a mechanism for reading messages from a Directory Server error log.
This enum contains the set of error log severities defined in the Directory Server.
This class provides access to a form of a command-line argument that is safe to use in a shell.
This class provides an entry transformation that will simply suppress all entries.
This class provides an implementation of an entry and LDIF change record transformation that will remove a specified set of attributes from entries or change records.
This class provides a request control which may be used to request that entries below one or more base DNs be excluded from the results returned to a client while processing a search operation.
This class provides an LDIF change record transformation that can exclude change records that can exclude LDIF change records that match any of a provided set of change types.
This class provides an implementation of an entry transformation that will return null for any entry that matches (or alternately, does not match) a given set of criteria and should therefore be excluded from the data set.
This class defines a Directory Server task that can be used to cause the server to execute a specified command with a given set of arguments.
An enum that defines the possible values that may be used for the expectedType element of a ContainsFieldJSONObjectFilter.
This class defines a Directory Server task that can be used to export the contents of a backend to LDIF.
This class defines a set of properties that may be used in conjunction with an LDIF export administrative task.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an extended request forwarded to a backend server.
This class provides a data structure that holds information about an extended forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an extended request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about an extended forward failed access log message.
This class provides an implementation of the extended key usage X.509 certificate extension as described in RFC 5280 section 4.2.1.12.
This enum defines a set of OIDs that are known to be used in the ExtendedKeyUsageExtension.
This class provides a data structure that provides information about the result codes associated with various types of extended operations.
This class implements the processing necessary to perform an LDAPv3 extended operation, which provides a way to request actions not included in the core LDAP protocol.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an extended request received from a client.
This class provides a data structure that holds information about an extended request access log message.
This class provides an implementation of an LDAP extended request protocol op.
This class provides an implementation of a extended response protocol op.
This class provides a data structure for holding information about the result of processing an extended operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of an extended operation processed by the Directory Server.
This class provides a data structure that holds information about an extended operation result access log message.
This class provides an implementation of a control which can be used to request that the Directory Server include extended information when returning a subschema subentry.
This annotation type may be used to mark a class or interface as one that may be safely extended or implemented by third-party code.
This class provides a SASL EXTERNAL bind request implementation as described in RFC 4422.
This class defines a failed dependency action, which controls how a task should behave if any of its dependencies fails.
This class provides a server set implementation that will attempt to establish connections to servers in the order they are provided.
This class provides a server set implementation that will attempt to establish connections to all associated servers in parallel, keeping the one that was first to be successfully established and closing all others.
This class provides a server set implementation that will establish a connection to the server with the fewest established connections previously created by the same server set instance.
This class provides a data structure that holds information about an annotated field.
This class defines a monitor entry that provides information about the sate of a FIFO entry cache in the Directory Server.
This class defines an argument that is intended to hold values which refer to files on the local filesystem.
This class defines a Directory Server task that can be used to identify files in a specified directory that match a given pattern, and delete any of those files that are outside of a provided set of retention criteria.
This enum defines the set of allowed timestamp formats for use in conjunction with the file retention task.
This class provides a data structure that represents an LDAP search filter.
This class defines an argument that is intended to hold one or more search filter values.
This class provides a comparator that may be used to define a relative order for search filters.
This class provides a mechanism for reading LDAP search filters from a file.
This class defines a log field syntax for search filter values.
This enumeration defines a set of options that indicate how the value of a field or getter method may be used in the process of constructing a search filter.
This class provides an OutputStream implementation that writes data to a provided byte array.
Instances of this class are used to ensure that certain actions are performed at a fixed rate per interval (e.g.
This class provides an implementation of an entry transformation that will alter DNs below a specified base DN to ensure that they are exactly one level below the specified base DN.
This class defines a log field syntax for values that are floating-point numbers.
This class provides a data structure with information about a column to use with the ColumnFormatter.
This interface defines a set of methods that are available for objects that may be used to communicate with an LDAP directory server (or something that simulates an LDAP directory server).
This class defines the base class for gauge monitor entries, which provide information common to all types of gauges.
This class provides support for decoding the values of the SubjectAlternativeNameExtension and IssuerAlternativeNameExtension extensions as described in RFC 5280 sections 4.2.1.6 and 4.2.1.7.
This class defines a log field syntax for values that are timestamps represented in the generalized time format.
This class provides an implementation of a matching rule that performs equality and ordering comparisons against values that should be timestamps in the generalized time syntax.
This class defines a monitor entry that provides general information about the state of the Directory Server.
This class provides a data structure that represents a GeneralNames element that may appear in a number of X.509 certificate extensions, including SubjectAlternativeNameExtension, IssuerAlternativeNameExtension, AuthorityKeyIdentifierExtension, and CRLDistributionPointsExtension.
This class provides a request control that can be included in a bind request to indicate that if the bind succeeds, the server should generate an access token that can be used in the OAUTHBEARERBindRequest to authenticate as the user for subsequent authentication attempts.
This class provides a response control that may be used to convey the access token (and other associated information) generated in response to a GenerateAccessTokenRequestControl for a successful bind operation.
This class defines a data structure that holds information about a password generated by the server and returned to the client in a GeneratePasswordExtendedResult.
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.
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 a GeneratePasswordExtendedRequest.
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 a GeneratePasswordExtendedRequest.
This class provides a request control that can be included in an add request to indicate that the server should generate a password for the new account.
This class provides a response control that may be used to convey the password (and other associated information) generated in response to a GeneratePasswordRequestControl.
This class provides a tool which can be used to generate LDAP attribute type and object class definitions which may be used to store objects created from a specified Java class.
This class defines a Directory Server task that can be used to cause it to generate a server profile in a specified location on the server filesystem.
This class provides a tool which can be used to generate source code for a Java class file based on information read from the schema of an LDAP directory server.
This class provides a tool that can be used to generate a TOTP shared secret for a user.
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 the OneTimePassword class), which can be used to authenticate to the server via the UnboundIDTOTPBindRequest.
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 a GenerateTOTPSharedSecretExtendedRequest.
This class provides a data structure for representing search filters in a generic way.
This class provides an implementation of a generic response protocol op.
This class provides a mechanism for performing SASL authentication in a generic manner.
This class provides an implementation of an LDAP control that can be included in a bind request to request that the Directory Server return the authentication and authorization entries for the user that authenticated.
This class provides an implementation of an LDAP control that may be included in a bind response to provide information about the authenticated and/or authorized user.
This class provides a request control which may be used to request that the Directory Proxy Server return the backend set IDs for the entry-balancing backend set(s) in which an operation was processed successfully.
This class provides a response control that may be used to provide the backend set ID(s) for any relevant backend sets accessed during the course of processing an operation.
This class provides an implementation of an extended request that can be used to retrieve backup compatibility data for a Directory Server backend.
This class provides an implementation of an extended result that can be used to retrieve backup compatibility data for a Directory Server backend.
This class provides an implementation of an extended request which may be used to retrieve a batch of changes from a Directory Server.
This class provides an extended result that may be used to obtain information about the results of processing a get changelog batch extended request.
This class provides an implementation of an extended request that can be used to retrieve a version of the server configuration.
This class provides an implementation of an extended result that can be used to retrieve a version of the server configuration.
This enum defines the types of configurations that may be obtained using the get configuration extended operation.
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.
This class implements a data structure for storing the information from an extended result for the get connection ID extended request.
This class provides an implementation of the get effective rights request control, which may be included in a search request to indicate that matching entries should include information about the rights a given user may have when interacting with that entry.
This class provides an LDAP connection pool health check implementation that may be used to check the health of the associated server by verifying that a specified entry can be retrieved in an acceptable period of time.
This class provides an implementation of a request control that can be included in a bind request to indicate that the server should include a control in the bind response with information about any password policy state notices, warnings, and/or errors for the user.
This class provides an implementation of a response control that can be included in a bind response with information about any password policy state notices, warnings, and/or errors for the user.
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).
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.
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.
This class provides an implementation of a request control that can be included in a bind request to indicate that the server should include a control int eh bind response with information about recent login attempts for the user.
This class provides an implementation of a response control that can be included in the response to a successful bind operation to provide information about recent successful and failed authentication attempts.
This class provides a request control which may be used to request the server ID of the server that actually processed the associated request.
This class provides a response control that may be used to provide the server ID of the Directory Server instance that processed the associated request.
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.
This class provides an implementation of an extended result that holds information about the response returned from a GetSubtreeAccessibilityExtendedRequest.
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.
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.
This class provides a data structure that holds information about an annotated getter method.
This class provides a request control which may be used to request that the server return resource limit information for the authenticated user in the response to a successful bind operation.
This class provides a response control that may be included in the response to a successful bind operation in order to provide information about custom resource limits for the user, including size limit, time limit, idle time limit, lookthrough limit, equivalent authorization user DN, and client connection policy name.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have at least one value for a specified field that is greater than a given value.
This class defines a Directory Server task that can be used to invoke a task written as a Groovy script using the UnboundID Server SDK.
This class defines a monitor entry that provides information about the group cache and the number and types of groups available in the server.
This class provides a SASL GSSAPI bind request implementation as described in RFC 4752.
This class provides a data structure that may be used to hold a number of properties that may be used during processing for a SASL GSSAPI bind operation.
This enum defines the types of channel binding that may be used in conjunction with the GSSAPI SASL mechanism.
This class provides a request control which may be included in a delete request to indicate that the server should completely remove the target entry, even if it would otherwise process the operation as a soft delete and merely hide the entry from most clients.
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 a CollectSupportDataExtendedRequest.
This class provides information about the health check states that may be held by an LDAP external server.
This class provides an implementation of a password encoder output formatter that will use hexadecimal digits to represent the bytes of the encoded password.
This enumeration defines a set of values that may indicate how text should be horizontally aligned.
This class provides an implementation of an SSLSocket verifier that will verify that the presented server certificate includes the address to which the client intended to establish a connection.
This class provides an SSL trust manager that will only accept certificates whose hostname (as contained in the CN subject attribute or a subjectAltName extension) matches an expected value.
This class defines a monitor entry that provides information about the recent CPU and memory utilization of the underlying system.
This class provides an implementation of a socket factory that can be used to forward traffic through an HTTP proxy server.
This class provides an implementation of an argument value validator that ensures that values can be parsed as valid IA5 strings (that is, strings containing only ASCII characters).
This class provides an implementation of an extended request that can be used to identify potential incompatibility problems between two backup compatibility descriptor values.
This class provides an implementation of an extended result that can be used to identify potential incompatibility problems between two backup compatibility descriptor values.
This class provides a tool that may be used to identify references to entries that do not exist.
This class provides a tool that may be used to identify unique attribute conflicts (i.e., attributes which are supposed to be unique but for which some values exist in multiple entries).
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.
This class provides an implementation of an LDAP control that can be used to request that the Directory Server ignore the NO-USER-MODIFICATION flag for attribute types.
This class defines a Directory Server task that can be used to import LDIF content into a backend.
This class provides a command-line tool that can be used to display a complex LDAP search filter in a multi-line form that makes it easier to visualize its hierarchy.
This class defines a monitor entry that provides general information about the state of an index in a Directory Server backend.
This class defines an indicator gauge monitor entry, which obtains its information from a non-numeric value in a monitor entry.
This class provides a utility that may be used to create a simple LDAP server instance that will hold all of its information in memory.
This class provides a simple data structure with information that may be used to control the behavior of an InMemoryDirectoryServer instance.
This class provides a data structure that encapsulates a password used by the in-memory directory server.
This class provides an opaque data structure which represents a point-in-time snapshot for an in-memory directory server instance.
This class provides a command-line tool that can be used to run an instance of the in-memory directory server.
This class defines an API that may be used to provide support for one or more types of extended operations in the in-memory directory server.
This class provides an API that can be used in the course of processing an add request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing an add request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a compare request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a compare request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a delete request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a delete request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing an extended request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing an extended request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing an intermediate response via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a modify DN request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a modify DN request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a modify request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a modify request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a result via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a SASL bind request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a SASL bind request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a search request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a search request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a search request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a search request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a simple bind request via the InMemoryOperationInterceptor API.
This class provides an API that can be used in the course of processing a simple bind request via the InMemoryOperationInterceptor API.
This class provides a data structure that can be used to configure a listener for use in the in-memory directory server.
This class defines an API that may be used to intercept and potentially alter communication between an LDAP client and the in-memory directory server.
This class provides an LDAP listener request handler that may be used to invoke any in-memory operation interceptors in the course of processing operations for the in-memory directory server.
This class defines an API that may be used to interact with clear-text passwords provided to the in-memory directory server.
This class provides an implementation of an LDAP request handler that can be used to store entries in memory and process operations on those entries.
This class defines an API that may be used to provide support for a specified SASL mechanism in the in-memory directory server.
This class defines an argument that is intended to hold one or more integer values.
This class defines a log field syntax for values that are integers.
This class provides an implementation of a matching rule that performs equality and ordering comparisons against values that should be integers.
This class defines an intermediate client request control, which can be used to provide a server with information about the client and any downstream clients that it may have.
This class implements a data structure which encapsulates the value of an intermediate client request value.
This class defines an intermediate client response control, which can be used to provide a server with information about the client and any downstream clients that it may have.
This class implements a data structure which encapsulates the value of an intermediate client response value.
This class provides a data structure for holding information about an LDAP intermediate response, which provides the ability for the directory server to return multiple messages in response to operations that would not otherwise support it.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an intermediate response returned to a client.
This class provides a data structure that holds information about an intermediate response access log message.
This interface defines a method that may be used to process intermediate response messages that are returned to the client while processing an operation.
This class provides an implementation of an LDAP intermediate response protocol op.
This interface may be implemented by a class which wishes to intercept and alter intermediate responses in some way before they are returned to the client, and/or to prevent them from being returned altogether.
This annotation type, may be used to mark a class, constructor, or method that is part of the LDAP SDK codebase to be for internal use only, and therefore something that should not be accessed by third-party code.
This class provides an implementation of an argument value validator that ensures that values can be parsed as valid IPv4 or IPV6 addresses.
This class provides an implementation of the issuer alternative name X.509 certificate extension as described in RFC 5280 section 4.2.1.7.
This class provides an LDAPSocketFactory implementation that wraps a standard Java socket factory to use when creating sockets.
This class defines a monitor entry that provides basic information about the Berkeley DB Java Edition environment in use for a backend.
This utility class provides a set of methods that may be used to convert between data structures in the Java Naming and Directory Interface (JNDI) and the corresponding data structures in the UnboundID LDAP SDK for Java.
This class provides a mechanism for converting between an LDAP extended request as used in JNDI and one used in the UnboundID LDAP SDK for Java.
This class provides a mechanism for converting between an LDAP extended response as used in JNDI and one used in the UnboundID LDAP SDK for Java.
This class provides a data structure which may be used to indicate the base DN to use for a join request.
This class provides a joined entry, which is a read-only representation of an entry that has been joined with a search result entry using the LDAP join control.
This class provides an implementation of an LDAP control which can be included in a search request to indicate that search result entries should be returned along with related entries based on a given set of criteria, much like an SQL join in a relational database.
This class contains a data structure which provides information about the value of an LDAP join request control, which may or may not include a nested join.
This class provides an implementation of a control that may be included in a search result entry in response to a join request control to provide a set of entries related to the search result entry.
This class provides an implementation of a join rule as used by the LDAP join request control.
This class provides a data structure that holds information about a JSON-formatted abandon forward access log message.
This class provides a data structure that holds information about a JSON-formatted abandon forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted abandon request access log message.
This class provides a data structure that holds information about a JSON-formatted abandon result access log message.
This class provides a data structure that holds information about a JSON-formatted access log message.
This class provides a mechanism for reading JSON-formatted access log messages.
This class provides a request handler that may be used to log each request and result using the Java logging framework.
This class provides a data structure that holds information about a JSON-formatted add assurance completed access log message.
This class provides a data structure that holds information about a JSON-formatted add forward access log message.
This class provides a data structure that holds information about a JSON-formatted add forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted add request access log message.
This class provides a data structure that holds information about a JSON-formatted add result access log message.
This class provides an implementation of a JSON value that represents an ordered collection of zero or more values.
This class provides a data structure that contains information about a server result from an assurance completed access log message.
This class provides a data structure that holds information about a JSON-formatted bind forward access log message.
This class provides a data structure that holds information about a JSON-formatted bind forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted bind request access log message.
This class provides a data structure that holds information about a JSON-formatted bind result access log message.
This class provides an implementation of a JSON value that represents a Java Boolean.
This class provides a mechanism for constructing the string representation of one or more JSON objects by appending elements of those objects into a byte string buffer.
This class provides a data structure that contains information about a JSON-formatted certificate.
This class provides a data structure that holds information about a JSON-formatted client certificate access log message.
This class provides a data structure that holds information about a JSON-formatted compare forward access log message.
This class provides a data structure that holds information about a JSON-formatted compare forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted compare request access log message.
This class provides a data structure that holds information about a JSON-formatted compare result access log message.
This class provides a data structure that holds information about a JSON-formatted connect access log message.
This class provides a data structure that holds information about a JSON-formatted delete assurance completed access log message.
This class provides a data structure that holds information about a JSON-formatted delete forward access log message.
This class provides a data structure that holds information about a JSON-formatted delete forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted delete request access log message.
This class provides a data structure that holds information about a JSON-formatted delete result access log message.
This class provides a data structure that holds information about a JSON-formatted disconnect access log message.
This class provides a data structure that holds information about a JSON-formatted entry rebalancing request access log message.
This class provides a data structure that holds information about a JSON-formatted entry rebalancing result access log message.
This class defines an exception that can be thrown if a problem occurs while performing JSON processing.
This class provides a data structure that holds information about a JSON-formatted extended forward access log message.
This class provides a data structure that holds information about a JSON-formatted extended forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted extended request access log message.
This class provides a data structure that holds information about a JSON-formatted extended result access log message.
This class provides a simple data structure that represents a field in a JSON object, containing a name and a value.
This class defines a number of constants that represent fields that may appear in JSON-formatted access log messages.
This enum defines options for the behaviors that should be used when trying to decode JSON objects embedded in a JSONFormattedRequestControl or JSONFormattedResponseControl as Control objects.
This class provides an implementation of a request control that may be used to encapsulate a set of zero or more other controls represented as JSON objects, and to indicate that the server should return any response controls in a JSONFormattedResponseControl.
This class provides an implementation of a response control that may be used to encapsulate a set of one or more other controls represented as JSON objects.
This class provides a data structure that contains information about an JSON-formatted intermediate client request control.
This class provides a data structure that contains information about an JSON-formatted intermediate client response control.
This class provides a data structure that holds information about a JSON-formatted operation request access log message.
This class provides an implementation of an LDAP connection access logger that records messages as JSON objects.
This class provides a data structure that can be used to define the properties to use when creating a JSONLDAPConnectionLogger.
This class provides an LDAPResultWriter instance that formats results in JSON.
This class defines a log field syntax for values that are JSON objects.
This class provides a data structure that holds information about a JSON-formatted log message.
This class provides a data structure that holds information about a JSON-formatted modify assurance completed access log message.
This class provides a data structure that holds information about a JSON-formatted modify DN assurance completed access log message.
This class provides a data structure that holds information about a JSON-formatted modify DN forward access log message.
This class provides a data structure that holds information about a JSON-formatted modify DN forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted modify DN request access log message.
This class provides a data structure that holds information about a JSON-formatted modify DN result access log message.
This class provides a data structure that holds information about a JSON-formatted modify forward access log message.
This class provides a data structure that holds information about a JSON-formatted modify forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted modify request access log message.
This class provides a data structure that holds information about a JSON-formatted modify result access log message.
This class provides an implementation of a JSON value that represents a null value.
This class provides an implementation of a JSON value that represents a base-ten numeric value of arbitrary size.
This class provides an implementation of a JSON value that represents an object with zero or more name-value pairs.
This class provides an implementation of a matching rule that can be used in conjunction with JSON objects.
This class defines the base class for all JSON object filter types, which are used to perform matching against JSON objects stored in a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server via the jsonObjectFilterExtensibleMatch matching rule.
This class provides a mechanism for reading JSON objects from an input stream.
This class provides a data structure that contains information about an JSON-formatted operation purpose request control.
This class provides a data structure that holds information about a JSON-formatted operation request access log message.
This class provides a data structure that holds information about a JSON-formatted search entry access log message.
This class provides a data structure that holds information about a JSON-formatted search forward access log message.
This class provides a data structure that holds information about a JSON-formatted search forward failed access log message.
This class provides a data structure that holds information about a JSON-formatted search reference access log message.
This class provides a data structure that holds information about a JSON-formatted search request access log message.
This class provides a data structure that holds information about a JSON-formatted search result access log message.
This class provides a data structure that holds information about a JSON-formatted security negotiation access log message.
This class provides an implementation of a JSON value that represents a string of Unicode characters.
This class provides a data structure that holds information about a JSON-formatted unbind request access log message.
This class provides the base class for data types that can be used as values in JSON objects and as elements in JSON arrays.
This class provides a ReplaceCertificateTrustBehavior implementation to indicate that the listener certificate should be trusted by the JVM's default trust manager.
This class provides an implementation of a trust manager that relies on the JVM's default set of trusted issuers.
This class provides a ReplaceCertificateKeyStoreContent 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.
This class provides a ReplaceCertificateKeyStoreContent implementation to indicate that the server should use a certificate key store file contained on the server filesystem.
This class provides an SSL key manager that may be used to retrieve certificates from a key store file.
This class provides a data structure with information about properties to use when accessing the KeyStoreKeyManager.
This class provides an implementation of the key usage X.509 certificate extension as described in RFC 5280 section 4.2.1.3.
This class provides an entry point that may be used to launch other tools provided as part of the LDAP SDK.
This class provides an entry point that may be used to launch other tools provided as part of the LDAP SDK.
This class provides a data structure that holds information about an LDAP attribute, including an attribute description (a base name or OID and optional set of options) and zero or more values.
This class provides a data structure that contains a set of LDAP attribute objects.
This interface defines a method that can be used to bind to a server when following a referral.
This class defines an exception that can be thrown if the server sends a bind response with a result code other than ResultCode.SUCCESS, which indicates that the bind operation did not complete successfully.
This class provides a basis for developing command-line tools that communicate with an LDAP directory server.
This class provides a simple tool that can be used to perform compare operations in an LDAP directory server.
This class provide an LDAP command-line tool that may be used to perform compare operations in an LDAP directory server.
This class provides a facility for interacting with an LDAPv3 directory server.
This class provides an object that may be used to communicate with an LDAP directory server.
This class provides a utility that may be used to obtain information that may be used to create LDAP connections to one or more servers from a definition contained in a JSON object.
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.
This interface defines a number of methods that may be used to obtain information about an LDAP connection.
This class defines an API that may be used to log operations processed on an LDAP connection.
This class provides a data structure that may be used to configure a number of connection-related properties.
This class provides an implementation of an LDAP connection pool, which is a structure that can hold multiple connections established to a given server that can be reused for multiple operations rather than creating and destroying connections for each operation.
This class provides an API that may be used to determine whether connections associated with a connection pool are valid and suitable for use.
This class provides a data structure that holds information about the result of an LDAP connection pool health check.
This class provides a data structure with information about usage of an LDAP connection pool.
This class provides a data structure with information about operations performed on an associated LDAP connection.
This class provides a data structure which may be used to define a set of constraints that may be used when processing operations.
This class provides a data structure that holds information about an LDAP control.
This class provides a tool that can be used to create a simple listener that may be used to intercept and decode LDAP requests before forwarding them to another directory server, and then intercept and decode responses before returning them to the client.
This class provides a request handler that may be used to write detailed information about the contents of all requests and responses that pass through it.
This class provides a command-line tool that can be used to delete one or more entries from an LDAP directory server.
This class provides a tool that can be used to compare the contents of two LDAPv3 servers and report the differences in an LDIF file that can be used to update the source server to match the target.
This class provides a set of utility methods for working with LDAP DNs.
This annotation type may be used to mark a field whose value should be the DN of the entry from which the corresponding object was initialized.
This class provides a data structure that represents an LDAP entry.
This annotation type may be used to mark a field whose value should be the full entry from which the corresponding object was initialized.
This class provides an EntrySource that will read entries matching a given set of search criteria from an LDAP directory server.
This class defines an exception that can be thrown if a problem occurs while performing LDAP-related processing.
This class defines an exception that may be thrown if an error occurs during LDAP-related processing.
This class provides a data structure that represents an LDAP extended request.
This class defines an exception that can be thrown if the server returns an extended response that indicates that the operation did not complete successfully.
This class provides a data structure which represents an LDAP extended response.
This class defines a monitor entry that provides general information about an LDAP external server used by the Directory Proxy Server.
This annotation type may be used to mark fields whose values should be persisted in an LDAP directory server.
This annotation type may be used to mark methods whose return values should be persisted in an LDAP directory server.
This interface defines a set of methods that are available for objects that may be used to communicate with an LDAP directory server.
This class provides an exception that may be returned if an operation in progress is interrupted.
This class provides a framework that may be used to accept connections from LDAP clients and ensure that any requests received on those connections will be processed appropriately.
This class provides an object which will be used to represent a connection to a client accepted by an LDAPListener, although connections may also be created independently if they were accepted in some other way.
This class provides a mechanism for defining the configuration to use for an LDAPListener instance.
This interface defines an API that may be implemented by a class that should be notified whenever a problem occurs with the LDAP listener or any of its associated connections in a manner that may not be directly visible to the caller.
This class defines an API that may be used to process requests read from a client connection.
This class provides a data structure that may be used to represent LDAP protocol messages.
This class provides a data structure that represents an LDAP modification.
This class provides a data structure that represents a set of LDAP modifications.
This class provides a simple tool that can be used to perform add, delete, modify, and modify DN operations against an LDAP directory server.
This class provides an implementation of an LDAP command-line tool that may be used to apply changes to a directory server.
This annotation type may be used to mark classes for objects that may be persisted in an LDAP directory server.
This class provides a mechanism for validating, encoding, and decoding objects marked with the LDAPObject annotation type.
This class provides an implementation of an LDAP command-line tool that may be used to change passwords in a directory server.
This class provides an interface that can be used to store and update representations of Java objects in an LDAP directory server, and to find and retrieve Java objects from the directory server.
This class defines an exception that may be thrown if a problem occurs while attempting to perform processing related to persisting Java objects in an LDAP directory server.
This class provides an implementation of a special type of LDAP connection pool which maintains two separate sets of connections: one for read operations and the other for write operations.
This interface defines a method that can be used to retrieve information to use to bind to a server when following referrals.
This class provides a data structure that may be used when authenticating a connection used to follow a referral.
This class provides an exception that may be returned if a referral is returned in response for an operation.
This class provides a framework that should be extended by all types of LDAP requests.
This interface serves as a marker for classes in the com.unboundid.ldap.sdk package that are responses which may be received from a directory server.
This class provides a data structure that represents a response that may be received from a directory server.
This class provides a data structure for holding the elements that are common to most types of LDAP responses.
This class provides a command-line tool that can be used to list LDAP result code names and their numeric values, or to search for result codes that match a given name or value.
This class provides an API that may be implemented by classes that format and output the results for LDAP-related tools.
This class defines a version of the LDAPException class that may be thrown as a RuntimeException without the need for it to have been explicitly declared in the method's throws list.
This class serves as the base class for all custom checked exception types defined in the LDAP SDK.
This class serves as the base class for all custom runtime exception types defined in the LDAP SDK.
This class provides a thread factory implementation that may be used to create threads with a number of basic settings.
This class provides a runtime exception that may be thrown by the LDAP SDK if it detects a problem with the usage of the SDK itself (e.g., a null value provided for an argument that must not be null, or an argument value that violates a documented constraint).
This class provides a simple tool that can be used to search an LDAP directory server.
This class provides an implementation of an LDAP command-line tool that may be used to issue searches to a directory server.
This class provides a data structure which may be used to define a set of constraints that may be used when processing search operations.
This class defines an exception that can be thrown if a problem occurs while performing LDAP-related processing.
This class provides a data structure that provides access to data returned in response to a search operation.
This annotation type may be used to mark methods which may be used to set values in the associated object using attributes read from an LDAP directory server.
This interface defines a method that can be used to construct the socket to use when communicating with the directory server.
This class defines a monitor entry that provides information about the types of LDAP operations processed through an LDAP connection handler.
This class provides a number of convenience methods that can be used to help write test cases for directory-enabled applications.
This class provides an implementation of an LDAP connection pool which maintains a dedicated connection for each thread using the connection pool.
This class provides a data structure that represents an LDAP URL.
This class provides a data structure for interacting with LDAP URLs.
This class provides an implementation of an argument value validator that is expected to be used with a string argument and ensures that all values for the argument are valid LDAP URLs.
This class defines an LDIF add change record, which can be used to represent an LDAP add request.
This class provides a base class for LDIF change records, which can be used to represent add, delete, modify, and modify DN operations in LDIF form.
This class defines an API that may be used to apply some kind of transformation to an LDIF change record to alter its contents or suppress it from further processing.
This class defines an LDIF delete change record, which can be used to represent an LDAP delete request.
This class provides a command-line tool that can be used to identify the differences between two LDIF files.
This class provides an EntrySource that will read entries from an LDIF file.
This class defines an exception that may be thrown if a problem occurs while attempting to decode data read from an LDIF source.
This class provides an LDAPResultWriter instance that formats results in LDIF.
This class provides a command-line tool that can be used to apply a set of changes to data in an LDIF file.
This class defines an LDIF modify change record, which can be used to represent an LDAP modify request.
This class defines an LDIF modify DN change record, which can be used to represent an LDAP modify DN request.
This class provides an LDIF reader, which can be used to read and decode entries and change records from a data source using the LDAP Data Interchange Format as per RFC 2849.
This interface is used by the LDIFReader to translate change records read from the input or filter them out before they are returned via LDIFReader.readChangeRecord().
This interface is used by the LDIFReader to translate entries read from the input or filter them out before they are returned via LDIFReader.readEntry().
This interface defines a common API for LDIF records, which are objects that can be represented using LDIF.
This class provides a command-line tool that can be used to search for entries matching a given set of criteria in an LDIF file.
This class provides an LDIF writer, which can be used to write entries and change records in the LDAP Data Interchange Format as per RFC 2849.
This interface is used by the LDIFWriter to translate or exclude change records before they are written.
This interface is used by the LDIFWriter to translate or exclude entries before they are written.
This class defines a Directory Server task that can be used to cause the server to leave lockdown mode and resume normal operation.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have at least one value for a specified field that is less than a given value.
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.
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.
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.
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.
This class defines a monitor entry that provides information about a load-balancing algorithm used by the Directory Proxy Server.
This class defines a data structure that provides information about the availability of an LDAP external server associated with a load-balancing algorithm.
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.
This class defines an exception that may be thrown if a problem occurs while attempting to parse a log message.
This class defines a data structure that represents a field that may appear in a Directory Server log message.
This class defines the base class for syntaxes that may be used for field values in log messages.
This class provides a data structure that holds information about a log message contained in a Directory Server access or error log file.
This class provides a data structure that holds information about a log message.
This class defines an API for reading log messages.
This class defines an exception that may be used to indicate that a log field value cannot be parsed in accordance with the associated syntax.
This class provides a tool that can be used to perform a variety of account management functions against user entries in the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server.
This enum provides information about all of the subcommands available for use with the manage-account tool.
This class provides a tool that can be used to manage X.509 certificates for use in TLS communication.
This class provides an implementation of the ManageDsaIT control as described in RFC 3296.
This class provides an implementation of the simple filter item for use with the MatchedValuesRequestControl as defined in RFC 3876.
This class provides an implementation of the matched values request control as defined in RFC 3876.
This class provides a request control which may be included in a search request to indicate that the server should provide the number of entries that match the search criteria.
This class provides a set of properties that can be used in conjunction with the MatchingEntryCountRequestControl.
This class provides a response control that may be used to provide information about the number of entries that match a given set of search criteria.
This enum defines the set of count types that may be used in a matching entry count response control.
This class defines the API for an LDAP matching rule, which may be used to determine whether two values are equal to each other, and to normalize values so that they may be more easily compared.
This class provides a data structure that describes an LDAP matching rule schema element.
This class provides a data structure that describes an LDAP matching rule use schema element.
This class provides an implementation of an LDAP connection pool health check that will cause the associated connection pool to consider a connection invalid after it has remained idle (as determined using the LDAPConnection.getLastCommunicationTime() method) for more than a specified length of time.
This class defines a monitor entry that provides information about the memory usage for the JVM in which the Directory Server is running.
This class provides a log formatter for use in the Java logging framework that may be used to minimize the formatting applied to log messages.
This interface defines a number of methods common to all types of operation result access log messages.
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.
This class provides an implementation of an FullLDAPInterface that provides a basic means of mocking an LDAPConnection (which itself is not easily mockable because it is final, as a commonly recognized best practice for APIs).
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.
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.
This enum defines the set of fields that are supported for use with the ModifiablePasswordPolicyStateJSON object.
This class provides a data structure for holding information about an LDAP modification, which describes a change to apply to an attribute.
This class defines a data type for modification type values.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of replication assurance processing for a modify operation.
This class provides a data structure that holds information about a modify assurance completed access log message.
This class provides a data structure that holds information about an audit log message that represents a modify operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of replication assurance processing for a modify DN operation.
This class provides a data structure that holds information about a modify DN assurance completed access log message.
This class provides a data structure that holds information about an audit log message that represents a modify DN operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a modify DN request forwarded to a backend server.
This class provides a data structure that holds information about a modify DN forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a modify DN request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about a modify DN forward failed access log message.
This class implements the processing necessary to perform an LDAPv3 modify DN operation, which can be used to rename and/or move an entry or subtree in the directory.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a modify DN request received from a client.
This class provides a data structure that holds information about a modify DN request access log message.
This class provides an implementation of an LDAP modify DN request protocol op.
This class provides an implementation of a modify DN response protocol op.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of a modify DN operation processed by the Directory Server.
This class provides a data structure that holds information about a modify DN operation result access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a modify request forwarded to a backend server.
This class provides a data structure that holds information about a modify forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a modify request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about a modify forward failed access log message.
This class implements the processing necessary to perform an LDAPv3 modify operation, which can be used to update an entry in the directory server.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a modify request received from a client.
This class provides a data structure that holds information about a modify request access log message.
This class provides an implementation of an LDAP modify request protocol op.
This class provides an implementation of a modify response protocol op.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of a modify operation processed by the Directory Server.
This class provides a data structure that holds information about a modify operation result access log message.
This class provides a tool that can be used to perform repeated modifications in an LDAP directory server using multiple threads.
This class provides a data structure for providing information about the data presented in an attribute in a Directory Server monitor entry.
This class defines a generic monitor entry that provides access to monitor information provided by a Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server instance.
This class provides a set of methods for retrieving Directory Server monitor entries.
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.
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.
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.
This class provides a data structure that holds information about the result of a move subtree operation.
This class provides an implementation of an entry and LDIF change record transformation that will alter DNs at or below a specified base DN to replace that base DN with a different base DN.
This class provides a basis for developing command-line tools that have the ability to communicate with multiple directory servers, potentially with very different settings for each.
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.
This enum defines the set of possible error behavior values that may be used in the multi-update extended request.
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.
This class provides an implementation of an extended result that can be used to provide information about the processing for a MultiUpdateExtendedRequest.
This annotation type is used to indicate that instances of the associated class may be altered after they have been created.
This enum defines a set of OIDs that are known to be associated with elliptic curve keys.
This class provides a data structure that describes an LDAP name form schema element.
This class defines an API that the LDAP SDK can use to resolve host names to IP addresses, and vice versa.
This class provides an implementation of the name with entryUUID request control.
This class provides an implementation of a JSON object filter that can negate the result of a provided filter.
This class provides an implementation of the LDAP no-op control as defined in draft-zeilenga-ldap-noop.
This annotation type is used to indicate that a non-final class or interface is NOT intended to be extended or implemented by third-party code.
This class provides an implementation of the notice of disconnection extended result as defined in RFC 4511.
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.
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.
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.
This annotation type is used to indicate that instances of the associated class may not be altered after they have been created.
This annotation type is used to indicate that the associated field, local variable, method or constructor parameter, or method return value is not allowed to be null.
This annotation type is used to indicate that the associated field, local variable, method or constructor parameter, or method return value is allowed to be null, and that code using nullable elements should be prepared to encounter null values.
This class provides an implementation of a java.io.OutputStream in which any data written to it is simply discarded.
This class provides an SSL trust manager that will not trust any certificates.
This class defines a numeric gauge monitor entry, which obtains its information from a numeric value in a monitor entry.
This class provides an implementation of a matching rule that allows strings consisting of numeric digits and spaces.
This class provides an implementation of a SASL bind request that uses the OAUTHBEARER SASL mechanism described in RFC 7628 to allow a user to authenticate with an OAuth 2.0 bearer token.
This class provides a data structure that may be used to hold a number of properties used during processing for a OAUTHBEARER SASL bind operation.
This class provides a bind result that can provide access to the details of a failed OAUTHBEARER SASL bind attempt.
This class provides a data structure that describes an LDAP object class schema element.
This enum defines the set of object class types that are defined in the LDAP protocol.
This class provides an API for converting between Java objects and LDAP attributes.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a field whose value is a JSON object that matches a provided JSON object filter, or a field whose value is an array that contains at least one JSON object that matches the provided filter.
This class provides a typed pair of objects.
This interface defines a set of methods that provide access to objects returned by the LDAPPersister class in the course of performing a search.
This class provides a typed trio of objects.
This class provides an implementation of a matching rule that performs byte-for-byte matching.
This class provides a data structure that may be used for representing object identifiers.
This class provides a mechanism that can be used for generating object identifiers (OIDs) for use in attribute type and object class definitions constructed for use in representing an object in the directory.
This class provides an implementation of an argument value validator that ensures that values can be parsed as valid object identifiers.
This class provides a command-line tool that can be used to search the OID registry to retrieve information an item with a specified OID or name.
This class represents a data structure with information about a variety of object identifiers (OIDs) used in LDAP-related contexts.
This class defines a data structure that represents an item in the OID registry.
This class provides support for a number of one-time password algorithms.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an operation processed by the server.
This class provides a data structure that holds information about a forward access log message.
This class provides a data structure that holds information about a forward failed access log message.
This class provides a request control that can be used by the client to identify the purpose of the associated operation.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an operation request received from a client.
This class provides a data structure that holds information about an operation request access log message.
This interface defines a number of methods common to all types of operation result access log messages.
This class provides a data structure that holds information about an operation result access log message.
This class provides a data structure that provides information about the result codes associated with a particular type of operation (or across all types of operations, if the associated operation type is null).
This enum defines the set of LDAP operation types.
This class provides an implementation of a JSON object filter that can perform a logical OR across the result obtained from a number of filters.
This enum defines a set of output formats that may be used in conjunction with the ColumnFormatter when formatting data.
This class provides an implementation of a control that may be included in a search request to override certain default limits that would normally be in place for the operation.
This class provides a command-line tool that can be used to read change records for add, delete, modify and modify DN operations from an LDIF file, and then apply them in parallel using multiple threads for higher throughput.
This class provides an InputStream implementation that can read encrypted data written by the PassphraseEncryptedOutputStream.
This class provides an OutputStream implementation that will encrypt all data written to it with a key generated from a passphrase.
This class provides a set of properties that will be used when creating a PassphraseEncryptedOutputStream.
This class represents a data structure that will be used to hold information about the encryption performed by the PassphraseEncryptedOutputStream when writing encrypted data, and that will be used by a PassphraseEncryptedInputStream to obtain the settings needed to decrypt the encrypted data.
This enum defines sets of settings that may be used when encrypting data with a PassphraseEncryptedOutputStream.
This class defines an API that may be used to format and un-format encoded passwords for use with the in-memory directory server.
This class provides an LDAPConnectionPoolHealthCheck implementation that may be used to output a warning message about a password expiration that has occurred or is about to occur.
This class provides an implementation of the password expired control as described in draft-vchu-ldap-pwd-policy.
This class provides an implementation of the expiring expiring control as described in draft-vchu-ldap-pwd-policy.
This class provides a mechanism for reading a password from a file.
This class provides an implementation of an extended operation handler for the in-memory directory server that can be used to process the password modify extended operation as defined in RFC 3062.
This class provides an implementation of the LDAP password modify extended request as defined in RFC 3062.
This class implements a data structure for storing the information from an extended result for the password modify extended request as defined in RFC 3062.
This enum defines a set of error types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy.
This class provides an implementation of the password policy request control as described in draft-behera-ldap-password-policy.
This class provides an implementation of the password policy response control as described in draft-behera-ldap-password-policy.
This class defines a data structure that will provide information about errors that may affect an account's usability.
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).
This class defines a data structure that will provide information about warnings that may affect an account's usability.
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.
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.
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.
This enum defines the set of fields that are supported for use with the PasswordPolicyStateJSON object.
This class defines an operation that may be used in conjunction with the password policy state extended operation.
This enum defines a set of warning types that may be included in the password policy response control as defined in draft-behera-ldap-password-policy.
This class defines an API that may be used to obtain a clear-text password that may be used for authentication or other purposes.
This class provides a data structure that describes a requirement that passwords must satisfy in order to be accepted by the server.
This class provides a data structure that holds information about the result of attempting validation with a proposed password against a password quality requirement.
This class provides a mechanism for reading a password from the command line in a way that attempts to prevent it from being displayed.
This class provides an implementation of a request control that can be included in an add request, modify request, or password modify extended request to control the way the server should behave when performing a password change.
This class provides a set of properties that can be used in conjunction with the PasswordUpdateBehaviorRequestControl.
This class provides an implementation for a request control that can be included in an add, modify, or password modify request.
This class provides an implementation for a response control that can be returned by the server in the response for add, modify, and password modify requests that include the password validation details request control.
This enum defines the set of response types that can be used in the password validation details response control.
This class provides an implementation of an X.509 key manager that can obtain a certificate chain and private key from PEM files.
This class provides an implementation of an X.509 trust manager that can obtain information about trusted issuers from one or more PEM files.
This class defines a monitor entry that provides information about the processing times of operations that are performed in the server in the context of a single application.
This class provides an implementation of the permissive modify request control, which is supported by a number of servers and may be included in a modify request to indicate that the server should not reject a modify request which attempts to add an attribute value which already exists or remove an attribute value which does not exist.
This class provides an implementation of a request control that may be included in a search request to indicate that the server should process the search even if it cannot use its defined indexes to identify matching entries efficiently.
This class provides a mechanism for iterating through the objects returned by a search operation performed using one of the search methods in the LDAPPersister class.
This enum defines a set of change types that can be associated with persistent search operations.
This class provides an implementation of the persistent search request control as defined in draft-ietf-ldapext-psearch.
This enum defines a set of filter types for filters that may be generated for an object using the LDAP SDK persistence framework.
This class provides a set of utilities that may be used in the course of persistence processing.
This class provides support for decoding a PKCS #10 certificate signing request (aka certification request or CSR) as defined in RFC 2986.
This enum defines a set of supported PKCS #10 certificate signing request versions.
This class provides an SSL key manager that may be used to interact with PKCS #11 tokens.
This enum defines a set of OIDs and algorithm names for password-based cryptography as described in the PKCS #5 specification defined in RFC 8018.
This class provides a set of utility methods for interacting with encrypted PKCS #8 private keys.
This class defines a set of properties that may be used when encrypting a PKCS #8 private key.
This class provides a mechanism for reading a PEM-encoded PKCS #8 private key from a specified file.
This class provides support for decoding an X.509 private key encoded in the PKCS #8 format as defined in RFC 5958.
This enum defines a set of supported PKCS #8 private key versions.
This class defines a SASL bind handler which may be used to provide support for the SASL PLAIN mechanism (as defined in RFC 4616) in the in-memory directory server.
This class provides a SASL PLAIN bind request implementation as described in RFC 4616.
This class provides an implementation of a reusable referral connector that maintains pools of connections to each of the servers accessed in the course of following referrals.
This enum defines the type of communication security that the PooledReferralConnector will use when following LDAP URLs that have a scheme of "ldap" rather than "ldaps".
This class defines a set of properties for use when creating a PooledReferralConnector.
This class defines a Directory Server task that can be used to populate the values of a composed attribute in existing entries without the need to export the data to LDIF and re-import it.
This interface provides the ability to perform custom processing immediately after creating an LDAP connection for use in a connection pool.
This class provides an implementation of the LDAP post-read request control as defined in RFC 4527.
This class provides an implementation of the LDAP post-read response control as defined in RFC 4527.
This class provides an implementation of the LDAP pre-read request control as defined in RFC 4527.
This class provides an implementation of the LDAP pre-read response control as defined in RFC 4527.
This class defines a monitor entry that provides information about the processing times of operations that are performed in the server.
This class provides an implementation of an argument value validator that is expected to be used with string or DN arguments and ensures that all values for the argument are valid DNs that are not within one or more specified subtrees.
This class provides an SSL trust manager that will interactively prompt the user to determine whether to trust any certificate that is presented to it.
This class provides a mechanism for retrieving the values of specified properties in the form of either Java system properties or process environment variables (using an alternative name generated from the provided property name using the PropertyManager.generateEnvironmentVariableNameFromPropertyName(java.lang.String) method).
This interface defines a set of methods that should be implemented by all types of LDAP protocol ops.
This class provides an implementation of the proxied authorization V1 request control, which may be used to request that the associated operation be performed as if it had been requested by some other user.
This class provides an implementation of the proxied authorization V2 request control, as defined in RFC 4370.
This class provides an implementation of a simple LDAP listener request handler that may be used to forward the request to another LDAP directory server.
This class provides an implementation of an LDAP connection pool health check that periodically monitors the number of available connections in the pool.
This enum defines a set of public key algorithm names and OIDs.
This class provides a request control that can be included in a modify request or a password modify extended request in order to indicate that if the operation results in changing the password for a user, the user's former password should be purged from the entry rather than retired, and any existing retired password should also be purged.
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.
This class implements an extended result that may be returned in response to a 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 listener certificates from its topology registry.
This class implements an extended result that may be returned in response to a PurgeRetiredListenerCertificatesExtendedRequest.
This class allows a FixedRateBarrier to change dynamically.
This class provides an InputStream implementation that uses a FixedRateBarrier to impose an upper bound on the rate (in bytes per second) at which data can be read from a wrapped InputStream.
This class provides an OutputStream implementation that uses a FixedRateBarrier to impose an upper bound on the rate (in bytes per second) at which data can be written to a wrapped OutputStream.
This class provides an implementation of an LDAP listener request handler that can be used to apply rate limiting to client requests.
This class provides a data structure for holding information about an LDAP relative distinguished name (RDN).
This class provides a data structure that represents a single name-value pair that may appear in a relative distinguished name.
This class provides an implementation of a password provider that will obtain the password from a specified file.
This interface defines a set of methods that may be safely called in an LDAP add request without altering its contents.
This interface defines a set of methods that may be safely called in an LDAP compare request without altering its contents.
This interface defines a set of methods that may be safely called in an LDAP delete request without altering its contents.
This class defines an Entry subclass in which the contents of the entry cannot be modified.
This class provides a read-only representation of an InMemoryDirectoryServerConfig object.
This interface defines a set of methods that may be safely called in an LDAP request without altering its contents.
This interface defines a set of methods that may be safely called in an LDAP modify DN request without altering its contents.
This interface defines a set of methods that may be safely called in an LDAP modify request without altering its contents.
This interface defines a set of methods that may be safely called in an LDAP search request without altering its contents.
This class provides an implementation of the real attributes only request control, which may be included in a search request to indicate that only real (i.e., non-virtual) attributes should be included in matching entries.
This class defines a Directory Server task that can be used to generate and/or rebuild one or more indexes a Berkeley DB Java Edition backend.
This class provides a data structure with information about recent successful and failed login attempts for a user.
This class provides a data structure with information about a recent login attempt for a user.
This class provides an implementation of an entry and LDIF change record transformation that will redact the values of a specified set of attributes so that it will be possible to determine whether the attribute had been present in an entry or change record, but not what the values were for that attribute.
This class defines an exception that may be used to indicate that a log field value cannot be parsed in accordance with the associated syntax because either the entire value or one or more of its components have been redacted.
This class defines a Directory Server task that can be used to cause entries contained in a local DB backend to be re-encoded, which may be used to apply any configuration changes that affect the encoding of that entry (e.g., if the entry should be encrypted, hashed, compressed, or fully or partially uncached; or if these settings should be reverted).
This interface defines an API that may be used to establish a connection (and perform authentication if appropriate) to a remote server when following a referral.
This class defines a Directory Server task that can be used to request that the server refresh the certificate monitor data immediately.
This class defines a Directory Server task that can be used to request that the server refresh the encryption settings database from disk.
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.
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.
This class provides an implementation of an argument value validator that is expected to be used with a string argument and ensures that all values for the argument are valid regular expressions.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have a particular value for a specified field.
This class provides an implementation of a request control that may be included in a search request to indicate that the server should reject the request if the server cannot use its defined indexes to identify matching entries efficiently.
This class defines a Directory Proxy Server task that can be used to reload the contents of the global index.
This class defines a Directory Server task that can be used to request that the server should dynamically reload all key and trust manager providers associated with all HTTP connection handlers configured with support for HTTPS.
This class defines a Directory Server task that can be used to safely remove an attribute type from the server schema.
This class defines a set of properties that may be used when creating a RemoveAttributeTypeTask.
This class defines a Directory Server task that can be used to safely remove an object class from the server schema.
This class defines a set of properties that may be used when creating a RemoveObjectClassTask.
This class provides an implementation of an entry and LDIF change record translator that will rename a specified attribute so that it uses a different name.
This class provides an implementation of an entry transformation that can be used to replace existing attributes in entries with a default set of values.
This class defines the superclass for extended results that may be returned in response to the replace certificate extended requests, including ReplaceListenerCertificateExtendedRequest, ReplaceInterServerCertificateExtendedRequest, PurgeRetiredListenerCertificatesExtendedRequest, and PurgeRetiredInterServerCertificatesExtendedRequest.
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.
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.
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.
This class implements an extended result that may be returned in response to a 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 listener certificate.
This class implements an extended result that may be returned in response to a ReplaceListenerCertificateExtendedRequest.
This class provides an implementation of an entry transformation that will replace the existing set of values for a given attribute with a value that contains a numeric counter (optionally along with additional static text) that increments for each entry that contains the target attribute.
This class defines a monitor entry that provides information about the state of a replica, including the base DN, replica ID, and generation ID, as well as information about its communication with the replication server
NOTE: This class, and other classes 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.
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.
This class provides an implementation of a control that may be used to process an add, delete, modify, or modify DN operation in the ForgeRock Directory Server that will not be replicated to other servers.
This class provides an implementation of a control which may be used to process an add, delete, modify, or modify DN operation in the Directory Server which will not be replicated to other servers.
This class defines a monitor entry that provides information about the state of a replication server, including the base DNs for replicated content, the generation ID for each of those base DNs, the replication server ID, and the port number on which the replication server is listening.
This class defines a monitor entry that provides summary information about a replicated data set within the Directory Server.
This class provides a data structure that contains information about a replica contained in a replication summary monitor entry.
This class provides a data structure that contains information about a replication server contained in a replication summary monitor entry.
This class provides an implementation of a connection pool health check that can display information about the result of a bind operation.
This class provides an implementation of an argument value validator that is expected to be used with string or DN arguments and ensures that all values for the argument are valid DNs that are within one or more specified subtrees.
This class defines a Directory Server task that can be used to restore a backup.
This class defines a number of constants associated with LDAP result codes.
This class provides a utility that may be used to count operation results and categorize them based on the total number of results of each type.
This class provides a data structure that encapsulates information about a result code included in the result code monitor entry.
This class defines a monitor entry that provides information about the result codes returned from various types of operations.
This class provides a set of utility methods for formatting operation results.
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.
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.
This class provides an implementation of a referral connector that will retain the exception encountered on the last attempt to establish a connection for the purpose of following a referral.
This class defines a request control that may be used to indicate that the server should process all aspects of the associated bind request (including password policy processing) but should not actually change the identity for the client connection, regardless of whether the authentication is successful.
This class provides a request control that can be included in a modify request or a password modify extended request in order to indicate that if the operation results in changing the password for a user, the user's former password should be marked as "retired", which may allow it to remain in use for a brief period of time (as configured in the password policy governing that user) to allow for applications which may have been configured with that password can be updated to use the new password.
This class defines a request control that may be included in a search request to indicate that the server should include replication conflict entries in the set of search result entries.
This interface defines an API that may be used to obtain a FullLDAPInterface (e.g., a connection pool) that may be used for the purpose of following a referral.
This class provides an implementation of the UNBOUNDID-TOTP SASL bind request that may be used to repeatedly generate one-time password values.
This class provides an implementation of a Comparator object that may be used to iterate through values in what would normally be considered reverse order.
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.
This class defines a log field syntax for values that are timestamps represented in the ISO 8601 format described in RFC 3339.
This class provides an implementation of the LDAP subentries request control as defined in RFC 3672.
This class provides a data structure for representing the directory server root DSE.
This class defines a Directory Server task that can be used to trigger the rotation of one or more log files.
This class provides a server set implementation that handles the case in which a given host name may resolve to multiple IP addresses.
An enum that defines the modes that may be used to select the order in which addresses should be used in attempts to establish connections.
This class provides a server set implementation that will use a round-robin algorithm to select the server to which the connection should be established.
This class provides a request control which may be used to request that the Directory Proxy Server forward the associated operation to a specific backend set associated with an entry-balancing request processor.
This enum defines the set of routing types that may be used in a route to backend set request control.
This class provides a request control which may be used to request that the associated request be routed to a specific server.
This class provides a data structure for representing the information contained in an RSA private key.
This enum defines a set of supported RSA private key versions.
This class provides a data structure for representing the information contained in an RSA public key in an X.509 certificate.
This class provides an implementation of an in-memory directory server password encoder that uses a message digest to encode passwords.
This class defines an exception that can be thrown if the server sends a bind response with a result code of ResultCode.SASL_BIND_IN_PROGRESS, which indicates that SASL bind processing has not yet completed.
This class provides an API that should be used to represent an LDAPv3 SASL bind request.
This class provides a mechanism for performing a SASL bind operation (or set of operations) using a Java SaslClient to perform all of the SASL-related processing.
This class provides a data structure which holds information about a SASL mechanism supported for use with the SASLUtils class.
This class provides a data structure that holds information about an option that can be used in the course of SASL authentication.
This enum defines the set of supported SASL quality of protection values.
This class provides a utility that may be used to help process SASL bind operations using the LDAP SDK.
This class provides a data structure for representing a directory server subschema subentry.
This class provides a superclass for all schema element types, and defines a number of utility methods that may be used when parsing schema element strings.
This enum defines the types of elements that can make up an LDAP schema.
This class provides a mechanism form validating definitions in an LDAP schema.
This class defines an argument that is intended to hold one search scope values.
This class provides the basis for bind requests that use the salted challenge-response authentication mechanism (SCRAM) described in RFC 5802 and updated in RFC 7677.
This class provides an implementation of an entry and change record transformation that may be used to scramble the values of a specified set of attributes in a way that attempts to obscure the original values but that preserves the syntax for the values.
This class provides an implementation of the SCRAM-SHA-1 SASL mechanism as described in RFC 5802.
This class provides an implementation of the SCRAM-SHA-256 SASL mechanism as described in RFC 7677.
This class provides an implementation of the SCRAM-SHA-512 SASL mechanism, which is an SCRAM mechanism that uses a SHA-512 digest algorithm and an HmacSHA512 MAC algorithm.
This class provides a tool that can be used to search an LDAP directory server repeatedly using multiple threads, and then modify each entry returned by that server.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a search result entry returned to a client.
This class provides a data structure that holds information about a search entry access log message.
This class provides support methods for paring search result entries based on a given set of requested attributes.
This interface may be implemented by a class which wishes to intercept and alter search result entries in some way before they are returned to the client, and/or to prevent them from being returned altogether.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a search request forwarded to a backend server.
This class provides a data structure that holds information about a search forward access log message.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a search request that was forwarded to a backend server but did not complete successfully.
This class provides a data structure that holds information about a search forward failed access log message.
This class provides a tool that can be used to search an LDAP directory server repeatedly using multiple threads.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a search result reference returned to a client.
This class provides a data structure that holds information about a search reference access log message.
This interface may be implemented by a class which wishes to intercept and alter search result references in some way before they are returned to the client, and/or to prevent them from being returned altogether.
This class implements the processing necessary to perform an LDAPv3 search operation, which can be used to retrieve entries that match a given set of criteria.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a search request received from a client.
This class provides a data structure that holds information about a search request access log message.
This class provides an implementation of an LDAP search request protocol op.
This class provides a data structure for holding information about the result of processing a search request.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about the result of a search operation processed by the Directory Server.
This class provides a data structure that holds information about a search operation result access log message.
This class provides an implementation of a search result done protocol op.
This class provides a data structure for representing an LDAP search result entry.
This class provides an implementation of an LDAP search result entry protocol op.
This interface defines a set of methods that provide search result entries and references to a requester as they are returned from the server.
This class provides a data structure for representing an LDAP search result reference.
This class defines an exception that may be thrown if a search result reference is received from the directory server while using the EntrySource API (e.g., an LDAPEntrySource object).
This class provides an implementation of an LDAP search result reference protocol op.
This class defines a data type for search scope values.
This class defines a Directory Server task that can be used to perform an internal search within the server and write the contents to an LDIF file.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about a form of security negotiation performed on a client connection.
This class provides a data structure that holds information about a security negotiation access log message.
This class provides a mechanism for generating a self-signed certificate for use by a listener that supports SSL or StartTLS.
This class defines an API that can be used to select between multiple directory servers when establishing a connection.
This class provides a mechanism for maintaining a blacklist of servers that have recently been found to be unacceptable for use by a server set.
This class provides an implementation of the server-side sort request control, as defined in RFC 2891.
This class provides an implementation of the server-side sort response control, as defined in RFC 2891.
This enum defines a set of change type values that may be used in conjunction with the set notification destination extended request.
This class provides an extended request that may be used to create or update a notification destination.
This class provides an extended request that may be used to create or update a notification subscription.
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.
This class provides a data structure that holds information about an annotated setter method.
This class defines a Directory Server task that can be used to shut down or restart the server.
This enum defines a set of algorithm names and OIDs.
This class implements the processing necessary to perform an LDAPv3 simple bind operation, which authenticates using a bind DN and password.
This class provides a common matching rule framework that may be extended by matching rule implementations in which equality, ordering, and substring matching can all be made based on byte-for-byte comparisons of the normalized value, for values that are considered acceptable by the MatchingRule.normalize(com.unboundid.asn1.ASN1OctetString) and MatchingRule.normalizeSubstring(com.unboundid.asn1.ASN1OctetString, byte) methods.
This class provides an implementation of the simple paged results control as defined in RFC 2696.
This class provides a server set implementation that only provides the ability to connect to a single server.
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.
This class provides an implementation of a socket factory that can be used to forward traffic through a SOCKSv4 or SOCKSv5 proxy server.
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.
This class provides a request control which may be included in a search request to indicate that soft-deleted entries may be included in the results, or it may be included in a compare or modify request to indicate that the operation should operate against the target entry even if it is a soft-deleted entry.
This class provides a request control which may be included in a delete request to indicate that the server should perform a soft delete rather than a hard delete.
This class provides a response control that holds information about the soft-deleted entry that results from a soft delete request, and may also be included in a search result entry which represents a soft-deleted entry.
This class provides a data structure for representing a sort key that is to be used in conjunction with the ServerSideSortRequestControl for requesting that the server sort the results before returning them to the client.
This class provides a command-line tool that can be used to split an LDIF file below a specified base DN.
This class defines an API that will be invoked immediately after establishing a connection using SSLSocket (whether by establishing a connection that is initially secure or by wrapping an existing insecure connection in an SSLSocket).
This class provides a relatively simple interface for helping to configure secure communication using TLS (formerly known as SSL) and StartTLS (which uses an LDAP extended operation to convert an already-established non-secure connection to one that uses TLS security).
This class defines a monitor entry that provides access to the Directory Server stack trace information.
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.
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.
This class provides an implementation of the start batched transaction extended request.
This class implements a data structure for storing the information from an extended result for the start batched transaction extended request.
This class provides an implementation of the LDAP StartTLS extended request as defined in RFC 4511 section 4.14.
This class provides an implementation of a post-connect processor that can be used to perform StartTLS negotiation on an LDAP connection that is intended to be used in a connection pool.
This class provides a request handler implementation that can be used to convert an existing connection to use TLS encryption.
This class provides an implementation of the start transaction extended request as defined in RFC 5805.
This class implements a data structure for storing the information from an extended result for the start transaction extended request, as defined in RFC 5805.
This class provides a number of static utility functions.
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.
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.
This class provides a data structure for holding information about the configuration of backend sets as used by the stream proxy values extended request.
This class provides a data structure for holding a value included in the stream proxy values intermediate response.
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.
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.
This class defines an argument that is intended to hold one or more string values.
This class defines a log field syntax for values that are arbitrary strings.
This class provides a data structure that represents a subcommand that can be used in conjunction with the argument parser.
Deprecated.
This class has been deprecated because there are two competing specifications that can affect the visibility of entries with the ldapSubEntry object class: RFC 3672 and draft-ietf-lddup-subentry.
This class provides an implementation of the subject alternative name X.509 certificate extension as described in RFC 5280 section 4.2.1.6.
This class provides an implementation of the subject key identifier X.509 certificate extension as described in RFC 5280 section 4.2.1.2.
This class provides an implementation of a JSON object filter that can be used to identify JSON objects that have string value that matches a specified substring.
This class provides a utility that can be used to query and update the set of subtree accessibility restrictions defined in the Directory Server.
This class defines a data structure with information about a subtree with restricted access, as may be included in a GetSubtreeAccessibilityExtendedResult.
This enum defines the set of allowed accessibility states that may be used with the SetSubtreeAccessibilityExtendedRequest.
This class provides a utility that can delete all entries below a specified base DN (including the base entry itself by default, although it can be preserved if desired) in an LDAP directory server.
This class provides an implementation of the subtree delete request control as defined in draft-armijo-ldap-treedelete.
This class provides a data structure with information about the results of a subtree delete attempt.
This class provides a tool that may be used to read and summarize the contents of one or more access log files from Ping Identity, UnboundID and Nokia/Alcatel-Lucent 8661 server products.
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.
This class provides an implementation of a control that can be used to indicate that the server should suppress the update to one or more operational attributes for the associated request.
This class provides a request control which may be included in a delete or modify DN request to indicate that the server should skip any referential integrity processing that would have otherwise been done for that operation.
This enum defines the set of operational update types that may be suppressed by the suppress operational attribute update request control.
This class provides an implementation of a Java socket factory that will wrap a provided socket factory but will synchronize on each use of that factory to ensure that only a single thread may use that factory to create a socket at any given time.
This class provides an implementation of a Java socket factory that will wrap a provided socket factory but will synchronize on each use of that factory to ensure that only a single thread may use that factory to create a socket at any given time.
This class defines a Directory Server task that can be used to synchronize the encryption settings definitions in one instance with one or more other servers in the topology.
This class defines a monitor entry that provides information about the system and JVM on which the Directory Server is running.
This class defines a data structure for holding information about scheduled tasks as used by the Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 Directory Server.
This class defines an exception that may be thrown while interacting with scheduled tasks.
This class provides a number of utility methods for interacting with tasks in Ping Identity, UnboundID, or Nokia/Alcatel-Lucent 8661 server instances.
This class provides information about a property that may be used to schedule a task.
This class defines a task state, which provides information about the current state of processing for a scheduled task.
This class provides an OutputStream implementation that can cause everything provided to it to be written to multiple output streams (e.g., to both a file and to standard output, or to both a file and a network socket).
This enum defines the policy that the TelephoneNumberMatchingRule should use when comparing two values in accordance with this syntax.
This class provides an implementation of a matching rule that may be used for telephone numbers.
This enum defines the policy that the TelephoneNumberMatchingRule should use when validating values in accordance with the syntax.
This class implements a command-line tool that can be helpful in measuring the performance of the LDAP SDK itself.
This class provides a data structure that holds information about a text-formatted abandon forward access log message.
This class provides a data structure that holds information about a text-formatted abandon forward failed access log message.
This class provides a data structure that holds information about a text-formatted abandon request access log message.
This class provides a data structure that holds information about a text-formatted abandon result access log message.
This class defines a number of constants that represent fields that may appear in text-formatted access log messages.
This class provides a data structure that holds information about a text-formatted access log message.
This class provides a mechanism for reading text-formatted access log messages.
This class provides a data structure that holds information about a text-formatted add assurance completed access log message.
This class provides a data structure that holds information about a text-formatted add forward access log message.
This class provides a data structure that holds information about a text-formatted add forward failed access log message.
This class provides a data structure that holds information about a text-formatted add request access log message.
This class provides a data structure that holds information about a text-formatted add result access log message.
This class provides a data structure that holds information about a text-formatted bind forward access log message.
This class provides a data structure that holds information about a text-formatted bind forward failed access log message.
This class provides a data structure that holds information about a text-formatted bind request access log message.
This class provides a data structure that holds information about a text-formatted bind result access log message.
This class provides a data structure that holds information about a text-formatted client certificate access log message.
This class provides a data structure that holds information about a text-formatted compare forward access log message.
This class provides a data structure that holds information about a text-formatted compare forward failed access log message.
This class provides a data structure that holds information about a text-formatted compare request access log message.
This class provides a data structure that holds information about a text-formatted compare result access log message.
This class provides a data structure that holds information about a text-formatted connect access log message.
This class provides a data structure that holds information about a text-formatted delete assurance completed access log message.
This class provides a data structure that holds information about a text-formatted delete forward access log message.
This class provides a data structure that holds information about a text-formatted delete forward failed access log message.
This class provides a data structure that holds information about a text-formatted delete request access log message.
This class provides a data structure that holds information about a text-formatted delete result access log message.
This class provides a data structure that holds information about a text-formatted disconnect access log message.
This class provides a data structure that holds information about a text-formatted entry rebalancing request access log message.
This class provides a data structure that holds information about a text-formatted entry rebalancing result access log message.
This class provides a data structure that holds information about a text-formatted extended forward access log message.
This class provides a data structure that holds information about a text-formatted extended forward failed access log message.
This class provides a data structure that holds information about a text-formatted extended request access log message.
This class provides a data structure that holds information about a text-formatted extended result access log message.
This class provides a data structure that holds information about a text-formatted operation request access log message.
This class provides a data structure that holds information about a text-formatted log message in the name=value format used by the Ping Identity Directory Server and related server products.
This class provides a data structure that holds information about a text-formatted modify assurance completed access log message.
This class provides a data structure that holds information about a text-formatted modify DN assurance completed access log message.
This class provides a data structure that holds information about a text-formatted modify DN forward access log message.
This class provides a data structure that holds information about a text-formatted modify DN forward failed access log message.
This class provides a data structure that holds information about a text-formatted modify DN request access log message.
This class provides a data structure that holds information about a text-formatted modify DN result access log message.
This class provides a data structure that holds information about a text-formatted modify forward access log message.
This class provides a data structure that holds information about a text-formatted modify forward failed access log message.
This class provides a data structure that holds information about a text-formatted modify request access log message.
This class provides a data structure that holds information about a text-formatted modify result access log message.
This class provides a data structure that holds information about a text-formatted operation request access log message.
This class provides a data structure that holds information about a text-formatted search entry access log message.
This class provides a data structure that holds information about a text-formatted search forward access log message.
This class provides a data structure that holds information about a text-formatted search forward failed access log message.
This class provides a data structure that holds information about a text-formatted search reference access log message.
This class provides a data structure that holds information about a text-formatted search request access log message.
This class provides a data structure that holds information about a text-formatted search result access log message.
This class provides a data structure that holds information about a text-formatted security negotiation access log message.
This class provides a data structure that holds information about a text-formatted unbind request access log message.
This class defines a Directory Server task that can be used to invoke third-party code created using the UnboundID Server SDK.
This class provides a means of obtaining a thread-local random number generator that can be used by the current thread without the need for synchronization.
This class provides a means of obtaining a thread-local SecureRandom instance that can be used without synchronization or contention.
This annotation type may be used to indicate the level of thread safety for a class or method.
This enumeration defines a set of thread safety levels that may be used to indicate whether the associated code is safe to be accessed concurrently by multiple threads.
This class defines a data structure that can hold information about a thread stack trace read from the Directory Server's stack trace monitor.
This class defines an argument that is intended to hold one or more timestamp values.
This class provides an implementation of an argument value validator that ensures that values must be timestamps (parsable by the TimestampArgument class) within a specified time range.
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 a CollectSupportDataExtendedRequest.
This class provides a comparator that may be used to order TLS cipher suites from most-preferred to least-preferred.
This class provides a utility for selecting the cipher suites that should be supported for TLS communication.
This class provides a request handler that may be used to create a log file with code that may be used to generate the requests received from clients.
This class defines an exception that may be used to indicate that a log field value cannot be parsed in accordance with the associated syntax because either the entire value or one or more of its components have been tokenized.
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 a CollectSupportDataExtendedRequest.
This class represents a data structure that contains information that should be used when logging launch and completion messages for a tool invocation.
This class provides a utility that can log information about the launch and completion of a tool invocation.
This class provides a thread that will be registered as a JVM shutdown hook for any command-line tool for which invocation logging is to be performed.
This class provides a number of utility methods primarily intended for use with command-line tools.
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.
This class defines a number of configuration properties that may be used by the TopologyRegistryTrustManager.
This class defines a monitor entry that provides information about the state of the traditional work queue.
This enum defines a set of possible behaviors that may be exhibited by the LDIF reader when encountering trailing spaces in attribute values that are not base64-encoded.
This class provides an implementation of an extended operation handler for the start transaction and end transaction extended operations as defined in RFC 5805.
This class provides an implementation of a control that can be used to specify an external identifier for a request sent to a ForgeRock Directory Server that will appear in the access log message for the associated operation.
This enum defines the options that may be specified to indicate whether and when to acquire an exclusive lock in the target backend when processing a transaction.
This enum defines the options that may be specified for the transaction commit durability when using the transaction settings request control.
This class defines a number of properties for use in conjunction with the TransactionSettingsRequestControl.
This class provides a request control that can be used to specify a number of settings used for any database transaction that may be associated with the associated request.
This class provides a response control that may be used to provide the client with information about transaction-related information over the course of the associated operation.
This class provides a data structure that holds information that may be used if the server needs to acquire a scoped lock that may apply to a subset of related requests within a backend, without affecting other unrelated operations being processed in that backend.
This class provides an implementation of the transaction specification request control as defined in RFC 5805.
This class provides a command-line tool that can be used to apply a number of transformations to an LDIF file.
This class provides an implementation of an SSLSocket verifier that will blindly accept any SSLSocket.
This class provides an SSL trust manager which will blindly trust any certificate that is presented to it, although it may optionally reject certificates that are expired or not yet valid.
This class provides a ReplaceCertificateTrustBehavior implementation to indicate that the server should update a specified trust manager provider.
This class provides an SSL trust manager that will consult a specified trust store file to determine whether to trust a certificate that is presented to it.
This class provides a data structure with information about properties to use when accessing the TrustStoreTrustManager.
This class provides a data structure that holds information about a log message that may appear in the Directory Server access log about an unbind request received from a client.
This class provides a data structure that holds information about an unbind request access log message.
This class provides an implementation of an LDAP unbind request protocol op.
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.
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.
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).
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.
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.
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.
This class defines a monitor entry that provides information about the state of the UnboundID work queue.
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.
This class provides a request control which may be included in an add request to indicate that the contents of the resulting entry should come not from the data of the add request itself but instead from a soft-deleted entry.
This enum defines the set of multiple attribute behavior values that may be used in conjunction with the UniquenessRequestControl.
This class provides a request control that may be included in an add, modify, or modify DN request to ensure that the contents of that request will not result in a uniqueness conflict with any other entry in the server.
This class provides a data structure that holds a set of properties for use in conjunction with the UniquenessRequestControl.
This class provides a response control that may be included in the response to add, modify, and modify DN requests that included the UniquenessRequestControl.
This enum defines the set of validation level values that may be used in conjunction with the UniquenessRequestControl.
This enum defines a set of values that provide information about the result of validation processing that the server performed in response to a UniquenessRequestControl.
This class provides an implementation of an in-memory directory server password encoder that uses a message digest to encode passwords.
This class provides an implementation of the unsolicited cancel response control, which may be returned by the Directory Server if an operation is canceled by the server without a cancel or abandon request from the client.
This interface defines a method that may be invoked if an unsolicited notification is received from the directory server.
This class is the superclass of all types of LDAP requests that can be altered.
This class provides an implementation of an argument value validator that is expected to be used with a string argument and ensures that all values for the argument are valid URLs.
This class provides a command-line tool that may be used to validate definitions read from one or more schema files.
This class provides a simple tool that can be used to validate that the contents of an LDIF file are valid.
This class provides an implementation of an extended request which may be used to validate a TOTP password for a user.
This class provides a number of methods that can be used to enforce constraints on the behavior of SDK methods.
This class provides an SSL trust manager that merely checks to see whether a presented certificate is currently within its validity time window (i.e., the current time is not earlier than the certificate's notBefore timestamp and not later than the certificate's notAfter timestamp).
This class provides a method for generating a string value comprised of zero or more components.
This class provides an LDAPResultWriter instance that simply prints the values of all attributes in the entries that are returned, with each value on a line by itself.
This class provides an implementation of an extended request that may be sent to the Ping Identity Directory Server to determine whether a provided password is correct for a user without performing any other password policy processing for that user.
This class provides information about the current version of the UnboundID LDAP SDK for Java.
This class defines a monitor entry that provides general information about the Directory Server version.
This class provides an implementation of the virtual attributes only request control, which may be included in a search request to indicate that only virtual attributes should be included in matching entries.
This class provides an implementation of the LDAP virtual list view (VLV) request control as defined in draft-ietf-ldapext-ldapv3-vlv.
This class provides an implementation of the virtual list view (VLV) response control, as defined in draft-ietf-ldapext-ldapv3-vlv.
This class provides a utility that can be used to sleep for a specified period of time in a manner that allows it to be woken up if necessary.
This class provides a weak hash set, which maintains weak references to the elements it contains, so that they will be removed automatically once there are no more normal references to them.
This class provides an implementation of an extended operation handler for the in-memory directory server that can be used to process the "Who Am I?" extended operation as defined in RFC 4532.
This class provides an implementation of the LDAP "Who Am I?" extended request as defined in RFC 4532.
This class implements a data structure for storing the information from an extended result for the "Who Am I?" extended request as defined in RFC 4532.
This class provides an SSL key manager that may be used to wrap a provided set of key managers.
This class provides support for decoding an X.509 certificate as defined in RFC 5280.
This class represents a data structure that holds information about an X.509 certificate extension.
This class defines a monitor entry that provides information about X.509 certificates that are in use by the Directory Server.
This enum defines a set of supported X.509 certificate versions.
This class provides a mechanism for reading PEM-encoded X.509 certificates from a specified file.