Package org.opends.server.tools.status

Class StatusCli

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.server.tools.status.StatusCli

public class StatusCli
extends ConsoleApplication

The class used to provide some CLI interface to display status. This class basically is in charge of parsing the data provided by the user in the command line.

Nested Class Summary

Nested classes/interfaces inherited from class com.forgerock.opendj.cli.ConsoleApplication

ConsoleApplication.Style

Method Summary

Modifier and Type	Method	Description
boolean	isAdvancedMode()	Indicates whether the user has requested advanced mode.
boolean	isInteractive()	Indicates whether the user has requested interactive behavior.
boolean	isMenuDrivenMode()	Indicates whether this console application is running in its menu-driven mode.
boolean	isQuiet()	Indicates whether the user has requested quiet output.
boolean	isScriptFriendly()	Indicates whether the user has requested script-friendly output.
boolean	isVerbose()	Indicates whether the user has requested verbose output.
static void	main(String[] args)	The main method for the status CLI tool.
static int	mainCLI(String[] args, OutputStream outStream, OutputStream errStream)	Parses the provided command-line arguments and uses that information to run the status tool.

Methods inherited from class com.forgerock.opendj.cli.ConsoleApplication

askConfirmation, askPort, confirmAction, errPrint, errPrintln, errPrintln, errPrintln, errPrintVerboseMessage, getErrorStream, getErrStream, getInputStream, getOutputStream, pressReturnToContinue, print, println, println, println, println, printlnNoWrap, printProgressBar, printVerboseMessage, readInput, readInput, readLineOfInput, readPassword, readPassword, readPort, readValidatedInput, readValidatedInput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

main

public static void main(String[] args)

The main method for the status CLI tool.

Parameters:

args - The command-line arguments provided to this program.

mainCLI

public static int mainCLI(String[] args,
                          OutputStream outStream,
                          OutputStream errStream)

Parses the provided command-line arguments and uses that information to run the status tool.

Parameters:

args - The command-line arguments provided to this program.

outStream - The output stream to use for standard output, or null if standard output is not needed.

errStream - The output stream to use for standard error, or null if standard error is not needed.

Returns:

The return code.

isAdvancedMode

public boolean isAdvancedMode()

Description copied from class: ConsoleApplication

Indicates whether the user has requested advanced mode.

Overrides:

isAdvancedMode in class ConsoleApplication

Returns:

Returns true if the user has requested advanced mode.

isInteractive

public boolean isInteractive()

Description copied from class: ConsoleApplication

Indicates whether the user has requested interactive behavior. The default implementation returns true.

Overrides:

isInteractive in class ConsoleApplication

Returns:

true if the user has requested interactive behavior.

isMenuDrivenMode

public boolean isMenuDrivenMode()

Description copied from class: ConsoleApplication

Indicates whether this console application is running in its menu-driven mode. This can be used to dictate whether output should go to the error stream or not. In addition, it may also dictate whether sub-menus should display a cancel option as well as a quit option.

Overrides:

isMenuDrivenMode in class ConsoleApplication

Returns:

Returns true if this console application is running in its menu-driven mode.

isQuiet

public boolean isQuiet()

Description copied from class: ConsoleApplication

Indicates whether the user has requested quiet output. The default implementation returns false.

Overrides:

isQuiet in class ConsoleApplication

Returns:

true if the user has requested quiet output.

isScriptFriendly

public boolean isScriptFriendly()

Description copied from class: ConsoleApplication

Indicates whether the user has requested script-friendly output. The default implementation returns false.

Overrides:

isScriptFriendly in class ConsoleApplication

Returns:

true if the user has requested script-friendly output.

isVerbose

public boolean isVerbose()

Description copied from class: ConsoleApplication

Indicates whether the user has requested verbose output. The default implementation returns false.

Overrides:

isVerbose in class ConsoleApplication

Returns:

true if the user has requested verbose output.