@PublicAPI(stability=VOLATILE)

Package org.opends.server.util

Contains implementations for various Directory Server utility classes and methods which may be used throughout the server but do not necessarily fit in elsewhere. Notable utility classes include:

• StaticUtils.java -- a set of static methods that may be called to perform all kinds of useful operations on data (e.g., get a stack trace from an exception, or convert the contents of a byte array to a readable form).
• Base64.java -- provides a mechanism for performing base64 encoding and decoding.
• DynamicConstants.java -- a set of constants that are actually generated automatically at build time and reflect information about the time and conditions under which the server was built.
• TimeThread.java -- provides a thread that will periodically retrieve the current time and format it in several common methods in an attempt to minimize the need to have multiple calls to System.currentTimeMillis() or new Date() whenever the time is needed. This thread updates internal variables several times each second, which should be sufficient for cases in which high-resolution timing is not required.

Class Summary

Class	Description
BSDMD5Crypt	BSD MD5 Crypt algorithm, ported from C.
BuildVersion	Utility class used for manipulating OpenDJ instance, binary and data versions.
CollectionUtils	Utility class for Collections.
CronExecutorService	Implements a ScheduledExecutorService on top of a cached thread pool to achieve UNIX's cron-like capabilities.
Crypt	UNIX Crypt cipher, ported from the Sun OpenSolaris project.
EMailMessage	This class defines an e-mail message that may be sent to one or more recipients via SMTP.
LDIFReader	This class provides the ability to read information from an LDIF file.
LevenshteinDistance	This class provides an implementation of the Levenshtein distance algorithm, which may be used to determine the minimum number of changes required to transform one string into another.
MultiOutputStream	This class defines a simple OutputStream object that can be used to write all messages to multiple targets at the same time, much like the UNIX "tee" command.
Platform	Utility class for getting the default number of worker threads.
RuntimeInformation	This class is used to gather and display information from the runtime environment.
SchemaUtils	Utility methods related to schema.
SchemaUtils.SchemaFileFilter	A file filter implementation that accepts only LDIF files.
ServerConstants	This class defines a set of constants that may be referenced throughout the Directory Server source.
SslUtils	Utility class for common SSL related setup.
StaticUtils	This class defines a number of static utility methods that may be used throughout the server.
TimeThread	This class provides an application-wide timing service.

Enum Summary

Enum	Description
EMailMessage.MimeTextSubType	The MIME text subtype for the message body.
SchemaUtils.PasswordType	Represents a password type, including a "not a password" value.

Exception Summary

Exception	Description
LDIFException	This class defines an exception that may be thrown while attempting to parse LDIF content.