Package org.opends.server.tools.upgrade

Class UpgradeCli

java.lang.Object

com.forgerock.opendj.cli.ConsoleApplication

org.opends.server.tools.upgrade.UpgradeCli

All Implemented Interfaces:

CallbackHandler

public final class UpgradeCli
extends ConsoleApplication
implements CallbackHandler

This class provides the CLI used for upgrading the OpenDJ product.

Nested Class Summary

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

ConsoleApplication.Style

Method Summary

Modifier and Type	Method	Description
void	handle(Callback[] callbacks)
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)	Provides the command-line arguments to the main application for processing.
static int	main(String[] args, boolean initializeServer, OutputStream outStream, OutputStream errStream)	Provides the command-line arguments to the main application for processing and returns the exit code as an integer.

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)

Provides the command-line arguments to the main application for processing.

Parameters:

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

main

public static int main(String[] args,
                       boolean initializeServer,
                       OutputStream outStream,
                       OutputStream errStream)

Provides the command-line arguments to the main application for processing and returns the exit code as an integer.

Parameters:

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

initializeServer - Indicates whether to perform basic initialization (which should not be done if the tool is running in the same JVM as the server).

outStream - The output stream for standard output.

errStream - The output stream for standard error.

Returns:

Zero to indicate that the program completed successfully, or non-zero to indicate that an error occurred.

isAdvancedMode

public boolean isAdvancedMode()

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()

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()

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()

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()

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()

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.

handle

public void handle(Callback[] callbacks)
            throws IOException,
                   UnsupportedCallbackException

Specified by:

handle in interface CallbackHandler

Throws:

IOException

UnsupportedCallbackException