Package com.unboundid.util

package com.unboundid.util
This package contains classes for performing various utility functions used throughout the LDAP SDK. Most of the content is primarily for internal use within the SDK, but some components (in particular, the code for base64 encoding and decoding) may be useful to third-party code.
  • Class
    Description
    AggregateInputStream
    This class provides an input stream implementation that can aggregate multiple input streams.
    Base32
    This class provides methods for encoding and decoding data in base32 as defined in RFC 4648.
    Base64
    This class provides methods for encoding and decoding data in base64 as defined in RFC 4648.
    BinarySizeUnit
    This enum defines a set of size units that can be used to represent data sizes in varying units (bytes, kilobytes, megabytes, gigabytes, etc.).
    ByteString
    This interface defines a set of methods for treating a value as either a string or byte array.
    ByteStringBuffer
    This class provides a growable byte array to which data can be appended.
    ByteStringFactory
    This class provides a mechanism for creating ByteString values.
    CloseableLock
    This class provides an implementation of a reentrant lock that can be used with the Java try-with-resources facility.
    CloseableReadWriteLock
    This class provides an implementation of a reentrant read-write lock that can be used with the Java try-with-resources facility.
    ColumnFormatter
    This class provides a utility for formatting output in multiple columns.
    CommandLineTool
    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.
    Debug
    This class provides a means of enabling and configuring debugging in the LDAP SDK.
    DebugType
    This enumeration defines a set of debugging types that are used by the LDAP SDK.
    DecimalSizeUnit
    This enum defines a set of size units that can be used to represent data sizes in varying units (bytes, kilobytes, megabytes, gigabytes, etc.).
    DNFileReader
    This class provides a mechanism for reading DNs from a file.
    ExampleCommandLineArgument
    This class provides access to a form of a command-line argument that is safe to use in a shell.
    Extensible
    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.
    FilterFileReader
    This class provides a mechanism for reading LDAP search filters from a file.
    FixedArrayOutputStream
    This class provides an OutputStream implementation that writes data to a provided byte array.
    FixedRateBarrier
    Instances of this class are used to ensure that certain actions are performed at a fixed rate per interval (e.g.
    FormattableColumn
    This class provides a data structure with information about a column to use with the ColumnFormatter.
    HorizontalAlignment
    This enumeration defines a set of values that may indicate how text should be horizontally aligned.
    HTTPProxySocketFactory
    This class provides an implementation of a socket factory that can be used to forward traffic through an HTTP proxy server.
    InternalUseOnly
    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.
    Launcher
    This class provides an entry point that may be used to launch other tools provided as part of the LDAP SDK.
    LDAPCommandLineTool
    This class provides a basis for developing command-line tools that communicate with an LDAP directory server.
    LDAPSDKException
    This class serves as the base class for all custom checked exception types defined in the LDAP SDK.
    LDAPSDKRuntimeException
    This class serves as the base class for all custom runtime exception types defined in the LDAP SDK.
    LDAPSDKThreadFactory
    This class provides a thread factory implementation that may be used to create threads with a number of basic settings.
    LDAPSDKUsageException
    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).
    LDAPTestUtils
    This class provides a number of convenience methods that can be used to help write test cases for directory-enabled applications.
    MinimalLogFormatter
    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.
    MultiServerLDAPCommandLineTool
    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.
    Mutable
    This annotation type is used to indicate that instances of the associated class may be altered after they have been created.
    NotExtensible
    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.
    NotMutable
    This annotation type is used to indicate that instances of the associated class may not be altered after they have been created.
    NotNull
    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.
    Nullable
    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.
    NullOutputStream
    This class provides an implementation of a java.io.OutputStream in which any data written to it is simply discarded.
    ObjectPair<F,S>
    This class provides a typed pair of objects.
    ObjectTrio<F,S,T>
    This class provides a typed trio of objects.
    OID
    This class provides a data structure that may be used for representing object identifiers.
    OIDRegistry
    This class represents a data structure with information about a variety of object identifiers (OIDs) used in LDAP-related contexts.
    OIDRegistryItem
    This class defines a data structure that represents an item in the OID registry.
    OutputFormat
    This enum defines a set of output formats that may be used in conjunction with the ColumnFormatter when formatting data.
    PassphraseEncryptedInputStream
    This class provides an InputStream implementation that can read encrypted data written by the PassphraseEncryptedOutputStream.
    PassphraseEncryptedOutputStream
    This class provides an OutputStream implementation that will encrypt all data written to it with a key generated from a passphrase.
    PassphraseEncryptedOutputStreamProperties
    This class provides a set of properties that will be used when creating a PassphraseEncryptedOutputStream.
    PassphraseEncryptedStreamHeader
    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.
    PassphraseEncryptionCipherType
    This enum defines sets of settings that may be used when encrypting data with a PassphraseEncryptedOutputStream.
    PasswordFileReader
    This class provides a mechanism for reading a password from a file.
    PasswordReader
    This class provides a mechanism for reading a password from the command line in a way that attempts to prevent it from being displayed.
    PropertyManager
    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).
    RateAdjustor
    This class allows a FixedRateBarrier to change dynamically.
    RateLimitedInputStream
    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.
    RateLimitedOutputStream
    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.
    ResultCodeCounter
    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.
    ReverseComparator<T>
    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.
    SASLMechanismInfo
    This class provides a data structure which holds information about a SASL mechanism supported for use with the SASLUtils class.
    SASLOption
    This class provides a data structure that holds information about an option that can be used in the course of SASL authentication.
    SASLUtils
    This class provides a utility that may be used to help process SASL bind operations using the LDAP SDK.
    SOCKSProxySocketFactory
    This class provides an implementation of a socket factory that can be used to forward traffic through a SOCKSv4 or SOCKSv5 proxy server.
    StaticUtils
    This class provides a number of static utility functions.
    SubtreeDeleter
    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.
    SubtreeDeleterResult
    This class provides a data structure with information about the results of a subtree delete attempt.
    SynchronizedSocketFactory
    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.
    SynchronizedSSLSocketFactory
    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.
    TeeOutputStream
    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).
    ThreadLocalRandom
    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.
    ThreadLocalSecureRandom
    This class provides a means of obtaining a thread-local SecureRandom instance that can be used without synchronization or contention.
    ThreadSafety
    This annotation type may be used to indicate the level of thread safety for a class or method.
    ThreadSafetyLevel
    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.
    Validator
    This class provides a number of methods that can be used to enforce constraints on the behavior of SDK methods.
    ValuePattern
    This class provides a method for generating a string value comprised of zero or more components.
    WakeableSleeper
    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.
    WeakHashSet<T>
    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.