org.opends.quicksetup

Class Launcher

java.lang.Object

org.opends.quicksetup.Launcher

Direct Known Subclasses:

SetupLauncher, UninstallLauncher

public abstract class Launcher
extends Object

Responsible for providing initial evaluation of command line arguments and determining whether to launch a CLI, GUI, or print a usage statement.

Field Summary

Fields

Modifier and Type	Field and Description
protected String[]	args Arguments with which this launcher was invoked.

Constructor Summary

Constructors

Constructor and Description
Launcher(String[] args) Creates a Launcher.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract CliApplication	createCliApplication() Creates a CLI application that will be run if the launcher needs to launch a CLI application.
abstract com.forgerock.opendj.cli.ArgumentParser	getArgumentParser() Gets an argument parser appropriate for this CLI launcher.
String[]	getArguments() Gets the arguments with which this launcher was invoked.
protected abstract LocalizableMessage	getFrameTitle() Gets the frame title of the GUI application that will be used in some operating systems.
protected abstract void	guiLaunchFailed(String logFileName) Called if launching of the GUI failed.
protected boolean	isCli() Indicates whether the launcher will launch a command line versus a graphical application based on the contents of the arguments passed into the constructor.
protected boolean	isQuiet() Indicates whether or not the launcher should print a usage statement based on the content of the arguments passed into the constructor.
void	launch() The main method which is called by the command lines.
protected int	launchCli(CliApplication cliApp) Launches the command line based uninstall.
protected int	launchGui(String[] args) Launches the graphical uninstall.
protected void	printUsage(boolean toStdErr) Prints a usage statement to terminal and exits with an error code.
protected void	printUsage(String i18nMsg, boolean toStdErr) Prints a usage message to the terminal.
protected void	printVersion() Prints the version statement to standard output terminal.
protected boolean	shouldPrintUsage() Indicates whether or not the launcher should print a usage statement based on the content of the arguments passed into the constructor.
protected boolean	shouldPrintVersion() Indicates whether or not the launcher should print a version statement based on the content of the arguments passed into the constructor.
protected abstract void	willLaunchGui() Called before the launcher launches the GUI.

Methods inherited from class java.lang.Object

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

Field Detail

args

protected String[] args

Arguments with which this launcher was invoked.

Constructor Detail

Launcher

public Launcher(String[] args)

Creates a Launcher.

Parameters:

args - String[] of argument passes from the command line

Method Detail

getArguments

public String[] getArguments()

Gets the arguments with which this launcher was invoked.

Returns:

String[] args from the CLI invocation

getArgumentParser

public abstract com.forgerock.opendj.cli.ArgumentParser getArgumentParser()

Gets an argument parser appropriate for this CLI launcher.

Returns:

ArgumentParser for parsing args

shouldPrintUsage

protected boolean shouldPrintUsage()

Indicates whether or not the launcher should print a usage statement based on the content of the arguments passed into the constructor.

Returns:

boolean where true indicates usage should be printed

isQuiet

protected boolean isQuiet()

Indicates whether or not the launcher should print a usage statement based on the content of the arguments passed into the constructor.

Returns:

boolean where true indicates usage should be printed

shouldPrintVersion

protected boolean shouldPrintVersion()

Indicates whether or not the launcher should print a version statement based on the content of the arguments passed into the constructor.

Returns:

boolean where true indicates version should be printed

isCli

protected boolean isCli()

Indicates whether the launcher will launch a command line versus a graphical application based on the contents of the arguments passed into the constructor.

Returns:

boolean where true indicates that a CLI application should be launched

printUsage

protected void printUsage(String i18nMsg,
              boolean toStdErr)

Prints a usage message to the terminal.

Parameters:

i18nMsg - localized user message that will be printed to the terminal.

toStdErr - whether the message must be printed to the standard error or the standard output.

launchGui

protected int launchGui(String[] args)

Launches the graphical uninstall. The graphical uninstall is launched in a different thread that the main thread because if we have a problem with the graphical system (for instance the DISPLAY environment variable is not correctly set) the native libraries will call exit. However if we launch this from another thread, the thread will just be killed. This code also assumes that if the call to SplashWindow.main worked (and the splash screen was displayed) we will never get out of it (we will call a System.exit() when we close the graphical uninstall dialog).

Parameters:

args - String[] the arguments used to call the SplashWindow main method

Returns:

0 if everything worked fine, or 1 if we could not display properly the SplashWindow.

getFrameTitle

protected abstract LocalizableMessage getFrameTitle()

Gets the frame title of the GUI application that will be used in some operating systems.

Returns:

internationalized String representing the frame title

launchCli

protected int launchCli(CliApplication cliApp)

Launches the command line based uninstall.

Parameters:

cliApp - the CLI application to launch

Returns:

0 if everything worked fine, and an error code if something wrong occurred.

printVersion

protected void printVersion()

Prints the version statement to standard output terminal.

printUsage

protected void printUsage(boolean toStdErr)

Prints a usage statement to terminal and exits with an error code.

Parameters:

toStdErr - whether the message must be printed to the standard error or the standard output.

createCliApplication

protected abstract CliApplication createCliApplication()

Creates a CLI application that will be run if the launcher needs to launch a CLI application.

Returns:

CliApplication that will be run

willLaunchGui

protected abstract void willLaunchGui()

Called before the launcher launches the GUI. Here subclasses can do any application specific things like set system properties of print status messages that need to be done before the GUI launches.

guiLaunchFailed

protected abstract void guiLaunchFailed(String logFileName)

Called if launching of the GUI failed. Here subclasses can so application specific things like print a message.

Parameters:

logFileName - the log file containing more information about why the launch failed.

launch

public void launch()

The main method which is called by the command lines.