@PublicAPI(stability=PRIVATE)

Package org.opends.server.tools

Contains various Directory Server tool implementations.

See: Description

Class Summary

Class	Description
BackendToolUtils	This class provides utility functions for all backend client tools.
BackendToolUtils.BackendInfo	Contains backend infos: LocalBackend, baseDNs and BackendCfg.
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.
CheckJVMVersion	Class used by script to ensure the running java version is compatible with OpenDJ software.
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.
ManageTasks	Tool for getting information and managing tasks in the Directory Server.
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.
StopDs	This class provides a tool that can send a request to the Directory Server that will cause it to shut down.
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
ConfigureWindowsService.CleanupServiceReturnCode	Return codes for the method cleanupService.
ConfigureWindowsService.DisableServiceReturnCode	Return codes for the method disableService.
ConfigureWindowsService.EnableServiceReturnCode	Return codes for the method enableService.
ConfigureWindowsService.ServiceStateReturnCode	Return codes for the method serviceState.
ConfigureWindowsService.StartServiceReturnCode	Return codes for the method startService.
ConfigureWindowsService.StopServiceReturnCode	Return codes for the method stopService.

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.