Package com.forgerock.opendj.cli

Classes implementing the OpenDJ CLI shared APIs.

Interface Summary

Interface	Description
DocDescriptionSupplement	Documentation that supplements generated descriptions.
HelpCallback	An interface for displaying help interactively.
Menu<T>	An interactive console-based menu.
MenuCallback<T>	A menu call-back which should be associated with each menu option.
SubCommandUsageHandler	A handler for printing sub-command usage information.
ToolRefDocContainer	An interface for an object that holds reference documentation for a command-line tool.
ValidationCallback<T>	An interface for validating user input.
VersionHandler	A handler for printing product version.

Class Summary

Class	Description
Argument	This class defines a generic argument that may be used in the argument list for an application.
ArgumentConstants	This class contains short and long options used by the argument in CLI.
ArgumentGroup	Class for organizing options into logical groups when argument usage is printed.
ArgumentParser	This class defines a utility that can be used to deal with command-line arguments for applications in a CLIP-compliant manner using either short one-character or longer word-based arguments.
BooleanArgument	This class defines an argument type that will be used to represent Boolean values.
BooleanArgument.Builder	A fluent API for incrementally constructing BooleanArgument.
CliConstants	This class defines a number of constants used by tools.
CliMessages	This file contains localizable message descriptors having the resource name com.forgerock.opendj.cli.cli.
CommandBuilder	Class used to be able to generate the non interactive mode.
CommonArguments	This class regroup commons arguments used by the different CLI.
ConnectionFactoryProvider	A connection factory designed for use with command line tools.
ConsoleApplication	This class provides an abstract base class which can be used as the basis of a console-based application.
DocGenerationHelper	This class provides utility functions to help generate reference documentation.
FileBasedArgument	This class defines an argument whose value will be read from a file rather than actually specified on the command-line.
FileBasedArgument.Builder	A fluent API for incrementally constructing FileBasedArgument.
IntegerArgument	This class defines an argument type that will only accept integer values, and potentially only those in a given range.
IntegerArgument.Builder	A fluent API for incrementally constructing IntegerArgument.
MenuBuilder<T>	An interface for incrementally building a command-line menu.
MenuResult<T>	The result of running a Menu.
MultiChoiceArgument<V>	This class defines an argument type that will only accept one or more of a specific set of string values.
MultiChoiceArgument.Builder<V>	A fluent API for incrementally constructing MultiChoiceArgument.
MultiColumnPrinter	Utility class for printing columns of data.
MultiColumnPrinter.Builder	A fluent API for incrementally constructing MultiColumnPrinter.
MultiColumnPrinter.Column	This class describes a Column of data used in the MultiColumnPrinter.
PromptingTrustManager	A trust manager which prompts the user for the length of time that they would like to trust a server certificate.
StringArgument	This class defines an argument type that will accept any string value.
StringArgument.Builder	A fluent API for incrementally constructing StringArgument.
SubCommand	This class defines a data structure for holding information about a subcommand that may be used with the subcommand argument parser.
SubCommandArgumentParser	This class defines a variant of the argument parser that can be used with applications that use subcommands to customize their behavior and that have a different set of options per subcommand (e.g, "cvs checkout" takes different options than "cvs commit").
TableBuilder	A class which can be used to construct tables of information to be displayed in a terminal.
TablePrinter	An interface for incrementally configuring a table serializer.
TableSerializer	An interface for serializing tables.
TabSeparatedTablePrinter	An interface for creating a tab-separated formatted table.
TextTablePrinter	An interface for creating a text based table.
ToolVersionHandler	Class that prints the version of the SDK to System.out.
Utils	This class provides utility functions for all the client side tools.

Enum Summary

Enum	Description
ConsoleApplication.Style	Defines the different line styles for output.
MultiColumnPrinter.Alignment	The data alignment.
ReturnCode	List of return codes used by CLIs.

Exception Summary

Exception	Description
ArgumentException	This class defines an exception that may be thrown if there is a problem with an argument definition.
ClientException	This class defines an exception that may be thrown if a local problem occurs in a Directory Server client.