@PublicAPI(stability=PRIVATE)

Package org.opends.server.tools

Contains various Directory Server tool implementations.

See: Description

Class Summary

Class	Description
BackendCreationHelper	Utility class which can be used by tools to create a new backend with default indexes.
BackendCreationHelper.DefaultIndex	Describes an attribute index which should be created during installation.
BackendToolUtils	This class provides utility functions for all JE related client tools.
BackendTypeHelper	Helper class for setup applications.
BackendTypeHelper.BackendTypeUIAdapter	Adaptor to allow backend type selection in UIs.
BackUpDB	This program provides a utility that may be used to back up a Directory Server backend in a binary form that may be quickly archived and restored.
ConfigureDS	This class provides a very basic tool that can be used to configure some of the most important settings in the Directory Server.
ConfigureWindowsService	This class is used to configure the Windows service for this instance on this machine.
CreateRCScript	This program provides a tool that may be used to generate an RC script that can be used to start, stop, and restart the Directory Server, as well as to display its current status.
EncodePassword	This program provides a utility that may be used to interact with the password storage schemes defined in the Directory Server.
ExportLDIF	This program provides a utility that may be used to export the contents of a Directory Server backend to an LDIF file.
ImportLDIF	This program provides a utility that may be used to import the contents of an LDIF file into a Directory Server backend.
InstallDS	This class provides a very simple mechanism for installing the OpenDS Directory Service.
InstallDSArgumentParser	Class used to parse the arguments of the setup command-line and to check that there are not conflicting arguments (nor missing arguments in no prompt mode).
JavaPropertiesTool	This class is used to update the scripts that are used to launch the command lines.
JavaPropertiesToolArgumentParser	Class used to parse the arguments of the java properties tool command-line.
LDAPAuthenticationHandler	This class provides a generic interface that LDAP clients can use to perform various kinds of authentication to the Directory Server.
LDAPCompare	This class provides a tool that can be used to issue compare requests to the Directory Server.
LDAPCompareOptions	This class defines options for all the compare operations used by the ldapcompare tool.
LDAPConnection	This class provides a tool that can be used to issue search requests to the Directory Server.
LDAPConnectionOptions	This class defines options used while creating an LDAP connection to the server.
LDAPDelete	This class provides a tool that can be used to issue delete requests to the Directory Server.
LDAPDeleteOptions	This class defines options for all the delete operations used by the ldapdelete tool.
LDAPModify	This class provides a tool that can be used to issue modify requests to the Directory Server.
LDAPModifyOptions	This class defines options for all the modify operations used by the ldapmodify tool.
LDAPPasswordModify	This program provides a utility that uses the LDAP password modify extended operation to change the password for a user.
LDAPReader	This class defines a utility that can be used to read LDAP messages from a provided socket.
LDAPSearch	This class provides a tool that can be used to issue search requests to the Directory Server.
LDAPSearchOptions	This class defines options for the search operations used by the ldapsearch tool.
LDAPToolOptions	This class defines common options for all the operations used by the tools.
LDAPToolUtils	This class provides utility functions for all the client side tools.
LDAPWriter	This class defines a utility that can be used to write LDAP messages over a provided socket.
LDIFDiff	This class provides a program that may be used to determine the differences between two LDIF files, generating the output in LDIF change format.
LDIFModify	This class provides a program that may be used to apply a set of changes (in LDIF change format) to an LDIF file.
LDIFSearch	This class provides a program that may be used to search LDIF files.
ListBackends	This program provides a utility that may be used to list the backends in the server, as well as to determine which backend holds a given entry.
ManageAccount	This class provides a tool that can be used to perform various kinds of account management using the password policy state extended operation.
ManageTasks	Tool for getting information and managing tasks in the Directory Server.
PromptTrustManager	This class provides an implementation of an X.509 trust manager which will interactively prompt the user (via the CLI) whether a given certificate should be trusted.
RebuildIndex	This program provides a utility to rebuild the contents of the indexes of a Directory Server backend.
RestoreDB	This program provides a utility that may be used to restore a binary backup of a Directory Server backend generated using the BackUpDB tool.
SSLConnectionFactory	This class provides SSL connection related utility functions.
StartWindowsService	This class is used to start the Windows service associated with this instance on this machine.
StopDS	This class provides a tool that can send a request to the Directory Server that will cause it to shut down.
StopWindowsService	This class is used to stop the Windows service associated with this instance on this machine.
VerifyIndex	This program provides a utility to verify the contents of the indexes of a Directory Server backend.
WaitForFileDelete	This program provides a simple tool that will wait for a specified file to be deleted before exiting.

Enum Summary

Enum	Description
JavaPropertiesTool.ErrorReturnCode	The enumeration containing the different return codes that the command-line can have.

Exception Summary

Exception	Description
LDAPConnectionException	This class defines an exception that may be thrown during the course of creating an LDAP connection to the server.
SSLConnectionException	This class defines an exception that may be thrown during the course of creating an SSL connection.

Package org.opends.server.tools Description

Contains various Directory Server tool implementations. These tools may be either clients that communicate with the server over protocol (e.g., ldapsearch, ldapmodify, etc.), or those that help launch some administrative operation (e.g., LDIF import/export, backend backup/restore, etc.).

All command-line tools should use the argument parsing capabilities defined in the com.sun.directory.util.args package for a consistent and full-featured manner for interacting with command-line arguments and providing usage information.

Further, all tools that communicate with the server over protocol should have the ability to make use of a centralized configuration so that they can share a set of default values for the protocol, address, port, use or non-use of SSL, etc. if no value is given.