@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.

See: Description

Class Summary

Class	Description
AddChangeRecordEntry	This class defines a data structure for a change record entry for an add operation.
BackupManager	A backup manager for any entity that is backupable (backend, storage).
Base64	This class provides methods for performing base64 encoding and decoding.
BSDMD5Crypt	BSD MD5 Crypt algorithm, ported from C.
BuildVersion	Represents a particular version of OpenDJ useful for making comparisons between versions.
CertificateManager	This class provides an interface for generating self-signed certificates and certificate signing requests, and for importing, exporting, and deleting certificates from a key store.
ChangeRecordEntry	This abstract class defines methods for a change record entry.
CollectionUtils	Utility class for Collections.
Crypt	UNIX Crypt cipher, ported from the Sun OpenSolaris project.
DeleteChangeRecordEntry	This class defines a data structure for a change record entry for an delete operation.
DynamicConstants	This file contains a number of constants that are used throughout the Directory Server source.
EMailMessage	This class defines an e-mail message that may be sent to one or more recipients via SMTP.
EmbeddedUtils	This class provides a number of utility methods for using OpenDS in an embedded manner (i.e., running within the same JVM as another application and controlled by that application).
ExpirationCheckTrustManager	This class implements an X.509 trust manager that will be used to wrap an existing trust manager and makes it possible to reject a presented certificate if that certificate is outside the validity window.
LDIFReader	This class provides the ability to read information from an LDIF file.
LDIFWriter	This class provides a mechanism for writing entries in LDIF form to a file or an output stream.
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.
ModifyChangeRecordEntry	This class defines a data structure for a change record entry for an modify operation.
ModifyDNChangeRecordEntry	This class defines a data structure for a change record entry for an modifyDN operation.
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	Provides a wrapper class that collects all of the JVM vendor and JDK version specific code in a single place.
RuntimeInformation	This class is used to gather and display information from the runtime environment.
SelectableCertificateKeyManager	This class implements an X.509 key manager that will be used to wrap an existing key manager and makes it possible to configure which certificate(s) should be used for client and/or server operations.
ServerConstants	This class defines a set of constants that may be referenced throughout the Directory Server source.
SetupUtils	This class provides a number of utility methods that may be used during the graphical or command-line setup process.
SizeLimitInputStream	An implementation of input stream that enforces an read size limit.
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
ChangeOperationType	This enumeration defines the set of possible change types.
Platform.KeyType	Key size, key algorithm and signature algorithms used.

Exception Summary

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

Annotation Types Summary

Annotation Type	Description
ActivateOnceNewConfigFrameworkIsUsed	Temporary annotation to remind that annotated code should be activated once the new configuration framework is used in place of legacy one.
ActivateOnceSDKSchemaIsUsed	Temporary annotation to remind that annotated code should be activated once the SDK schema is used in place of legacy server schema.
ModifyOnceNewConfigFrameworkIsUsed	Temporary annotation to remind that annotated code should be modified once the new configuration framework is used in place of legacy one.
ModifyOnceSDKSchemaIsUsed	Temporary annotation to remind that annotated code could be modified once the SDK schema is used in place of legacy server schema.
RemoveOnceNewConfigFrameworkIsUsed	Temporary annotation to remind that annotated code could be removed once the new configuration framework is used in place of legacy one.
RemoveOnceSDKSchemaIsUsed	Temporary annotation to remind that annotated code could be removed once the SDK schema is used in place of legacy server schema.

Package org.opends.server.util Description

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.