org.opends.quicksetup

Interface CliApplication

All Superinterfaces:

ProgressNotifier, Runnable

All Known Implementing Classes:

Uninstaller

public interface CliApplication
extends ProgressNotifier, Runnable

Represents a quick setup CLI application.

Method Summary

Methods

Modifier and Type	Method and Description
UserData	createUserData(Launcher launcher) Creates a set of user data from command line arguments and installation status.
ReturnCode	getReturnCode() Gets the return code to return to the console.
ApplicationException	getRunError() Gets any exception that happened while this application was running.
UserData	getUserData() Gets the user data this application will use when running.
void	setProgressMessageFormatter(ProgressMessageFormatter formatter) Sets the formatter that will be used to format messages.
void	setUserData(UserData userData) Sets the user data this application will use when running.

Methods inherited from interface org.opends.quicksetup.event.ProgressNotifier

addProgressUpdateListener, notifyListeners, removeProgressUpdateListener

Methods inherited from interface java.lang.Runnable

run

Method Detail

createUserData

UserData createUserData(Launcher launcher)
                        throws UserDataException,
                               ApplicationException,
                               com.forgerock.opendj.cli.ClientException

Creates a set of user data from command line arguments and installation status.

Parameters:

launcher - that launched this application

Returns:

UserData object populated to reflect the input args and status

Throws:

UserDataException - if something is wrong with the data provided by the user

ApplicationException - if there is an application specific problem

com.forgerock.opendj.cli.ClientException - If an error occurs when creating the data.

getUserData

UserData getUserData()

Gets the user data this application will use when running.

Returns:

UserData to use when running

setUserData

void setUserData(UserData userData)

Sets the user data this application will use when running.

Parameters:

userData - UserData to use when running

setProgressMessageFormatter

void setProgressMessageFormatter(ProgressMessageFormatter formatter)

Sets the formatter that will be used to format messages.

Parameters:

formatter - ProgressMessageFormatter used to format messages

getRunError

ApplicationException getRunError()

Gets any exception that happened while this application was running. A null value returned from this method indicates that the execution of the CLI program is not complete or was successful.

Returns:

an exception that happened while the CLI was running

getReturnCode

ReturnCode getReturnCode()

Gets the return code to return to the console.

Returns:

return code to return; if null the return code indicated in the error returned by getRunError will be used.