org.opends.guitools.uninstaller

Class Uninstaller

java.lang.Object

org.opends.quicksetup.Application

org.opends.quicksetup.ui.GuiApplication

org.opends.guitools.uninstaller.Uninstaller

All Implemented Interfaces:

Runnable, CliApplication, ProgressNotifier

public class Uninstaller
extends GuiApplication
implements CliApplication

This class is in charge of performing the uninstallation of Open DS.

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.quicksetup.Application

Application.ErrorPrintStream, Application.OutputPrintStream, Application.PointAdder

Field Summary

Fields inherited from class org.opends.quicksetup.Application

formatter, installStatus, tempLogFile

Constructor Summary

Constructors

Constructor and Description
Uninstaller() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	cancel() Signals that the application should cancel a currently running operation as soon as possible and return the environment to the state prior to running the operation.
boolean	canFinish(WizardStep step) Indicates whether the user is allowed to finish the wizard from step.
boolean	canGoBack(WizardStep step) Indicates whether the user is allowed to return to a previous step from step.
boolean	canGoForward(WizardStep step) Indicates whether the user is allowed to move to a new step from step.
boolean	canQuit(WizardStep step) Whether the provided wizard step allow to quit.
void	closeClicked(WizardStep cStep, QuickSetup qs) Called when the user has clicked the 'close' button.
UserData	createUserData() Creates a set of user data with default values.
UserData	createUserData(Launcher launcher) Creates a set of user data from command line arguments and installation status.
QuickSetupStepPanel	createWizardStepPanel(WizardStep step) Creates a wizard panel given a specific step.
boolean	finishClicked(WizardStep cStep, QuickSetup qs) Called when the user has clicked the 'finish' button.
boolean	finishOnLeft() Indicates whether the finish button must be placed on the left (close to "Next" button) or on the right (close to "Quit" button).
org.forgerock.i18n.LocalizableMessage	getCloseButtonToolTip() Gets the key for the close button's tool tip text.
UninstallProgressStep	getCurrentProgressStep() Gets the current step.
org.forgerock.i18n.LocalizableMessage	getFinishButtonLabel() Gets the key for the finish button's label.
org.forgerock.i18n.LocalizableMessage	getFinishButtonToolTip() Gets the key for the finish button's tool tip text.
WizardStep	getFinishedStep() Gets the finished step in the wizard.
WizardStep	getFirstWizardStep() Returns the initial wizard step.
org.forgerock.i18n.LocalizableMessage	getFrameTitle() Gets the frame title of the GUI application that will be used in some operating systems.
ButtonName	getInitialFocusButtonName() Get the name of the button that will receive initial focus.
String	getInstallationPath() Returns the installation path.
String	getInstancePath() Returns the instance path.
WizardStep	getNextWizardStep(WizardStep step) Gets the next step in the wizard given a current step.
WizardStep	getPreviousWizardStep(WizardStep step) Gets the previous step in the wizard given a current step.
Integer	getRatio(ProgressStep step) Returns an integer that specifies which percentage of the whole installation has been completed.
ReturnCode	getReturnCode() Gets the return code to return to the console.
ApplicationException	getRunError() Returns the ApplicationException that might occur during installation or null if no exception occurred.
org.forgerock.i18n.LocalizableMessage	getSummary(ProgressStep step) Returns an formatted representation of the summary for the specified UninstallProgressStep.
ApplicationTrustManager	getTrustManager() Returns the trust manager that can be used to establish secure connections.
Set<? extends WizardStep>	getWizardSteps() Returns the set of wizard steps used in this application's wizard.
boolean	isCancellable() Indicates whether this application is capable of cancelling the operation performed in the run method.
boolean	isFinished() Returns whether the installer has finished or not.
void	nextClicked(WizardStep cStep, QuickSetup qs) Called when the user has clicked the 'next' button.
void	notifyListeners(Integer ratio, org.forgerock.i18n.LocalizableMessage currentPhaseSummary, org.forgerock.i18n.LocalizableMessage newLogDetail) This method notifies the ProgressUpdateListeners that there was an update in the installation progress.
void	previousClicked(WizardStep cStep, QuickSetup qs) Called when the user has clicked the 'previous' button.
void	quitClicked(WizardStep step, QuickSetup qs) Called when the user has clicked the 'quit' button.
void	run() Actually performs the uninstall in this thread.
void	setWizardDialogState(QuickSetupDialog dlg, UserData userData, WizardStep step) Called when the user advances to new step in the wizard.
void	updateUserData(WizardStep step, QuickSetup qs) Called whenever this application should update its user data from values found in QuickSetup.
void	windowClosing(QuickSetupDialog dlg, WindowEvent evt) Called by the controller when the window is closing.

Methods inherited from class org.opends.quicksetup.ui.GuiApplication

acceptCertificateForException, confirmCancel, createFramePanel, forceToDisplay, getCurrentWizardStep, getExtraDialogHeight, getOrderedSteps, getQuitButtonToolTip, getTab, getUserArguments, isSubStep, isVisible, isVisible, setDisplayedWizardStep, setQuickSetupDialog, setUserArguments

Methods inherited from class org.opends.quicksetup.Application

addProgressUpdateListener, applicationPrintStreamReceived, checkAbort, create, getApplicationErrorStream, getApplicationOutputStream, getFormattedDone, getFormattedDoneWithLineBreak, getFormattedError, getFormattedError, getFormattedLog, getFormattedLogError, getFormattedProgress, getFormattedProgressWithLineBreak, getFormattedSuccess, getFormattedSummary, getFormattedWarning, getFormattedWithPoints, getInstallation, getLineBreak, getMessage, getProgressMessageFormatter, getRemoteConnection, getTaskSeparator, getUserData, isVerbose, notifyListeners, notifyListenersDone, notifyListenersRatioChange, notifyListenersWithPoints, removeProgressUpdateListener, setCurrentInstallStatus, setInstallation, setNotifyListeners, setProgressMessageFormatter, setTempLogFile, setUserData

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opends.quicksetup.CliApplication

getUserData, setProgressMessageFormatter, setUserData

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

addProgressUpdateListener, removeProgressUpdateListener

Constructor Detail

Uninstaller

public Uninstaller()

Default constructor.

Method Detail

getFrameTitle

public org.forgerock.i18n.LocalizableMessage getFrameTitle()

Description copied from class: GuiApplication

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

Specified by:

getFrameTitle in class GuiApplication

Returns:

internationalized String representing the frame title

createUserData

public UserData createUserData()

Description copied from class: Application

Creates a set of user data with default values.

Overrides:

createUserData in class Application

Returns:

UserData empty set of UserData

getFirstWizardStep

public WizardStep getFirstWizardStep()

Description copied from class: GuiApplication

Returns the initial wizard step.

Specified by:

getFirstWizardStep in class GuiApplication

Returns:

Step representing the first step to show in the wizard

getNextWizardStep

public WizardStep getNextWizardStep(WizardStep step)

Description copied from class: GuiApplication

Gets the next step in the wizard given a current step.

Specified by:

getNextWizardStep in class GuiApplication

Parameters:

step - Step the current step

Returns:

Step the next step

getPreviousWizardStep

public WizardStep getPreviousWizardStep(WizardStep step)

Description copied from class: GuiApplication

Gets the previous step in the wizard given a current step.

Specified by:

getPreviousWizardStep in class GuiApplication

Parameters:

step - Step the current step

Returns:

Step the previous step

getFinishedStep

public WizardStep getFinishedStep()

Description copied from class: GuiApplication

Gets the finished step in the wizard.

Specified by:

getFinishedStep in class GuiApplication

Returns:

Step the finished step

finishOnLeft

public boolean finishOnLeft()

Description copied from class: GuiApplication

Indicates whether the finish button must be placed on the left (close to "Next" button) or on the right (close to "Quit" button).

Overrides:

finishOnLeft in class GuiApplication

Returns:

true if the finish button must be placed on the left and false otherwise.

canGoBack

public boolean canGoBack(WizardStep step)

Description copied from class: GuiApplication

Indicates whether the user is allowed to return to a previous step from step.

Overrides:

canGoBack in class GuiApplication

Parameters:

step - WizardStep for which the the return value indicates whether or not the user can return to a previous step

Returns:

boolean where true indicates the user can return to a previous step from step

canGoForward

public boolean canGoForward(WizardStep step)

Description copied from class: GuiApplication

Indicates whether the user is allowed to move to a new step from step.

Overrides:

canGoForward in class GuiApplication

Parameters:

step - WizardStep for which the the return value indicates whether or not the user can move to a new step

Returns:

boolean where true indicates the user can move to a new step from step

canFinish

public boolean canFinish(WizardStep step)

Description copied from class: GuiApplication

Indicates whether the user is allowed to finish the wizard from step.

Specified by:

canFinish in class GuiApplication

Parameters:

step - WizardStep for which the the return value indicates whether or not the user can finish the wizard

Returns:

boolean where true indicates the user can finish the wizard

canQuit

public boolean canQuit(WizardStep step)

Whether the provided wizard step allow to quit.

Parameters:

step - the wizard step

Returns:

true if the provided wizard step allow to quit, false otherwise

nextClicked

public void nextClicked(WizardStep cStep,
                        QuickSetup qs)

Description copied from class: GuiApplication

Called when the user has clicked the 'next' button.

Specified by:

nextClicked in class GuiApplication

Parameters:

cStep - WizardStep at which the user clicked the next button

qs - QuickSetup controller

closeClicked

public void closeClicked(WizardStep cStep,
                         QuickSetup qs)

Description copied from class: GuiApplication

Called when the user has clicked the 'close' button.

Overrides:

closeClicked in class GuiApplication

Parameters:

cStep - WizardStep at which the user clicked the close button

qs - QuickSetup controller

quitClicked

public void quitClicked(WizardStep step,
                        QuickSetup qs)

Description copied from class: GuiApplication

Called when the user has clicked the 'quit' button.

Overrides:

quitClicked in class GuiApplication

Parameters:

step - WizardStep at which the user clicked the quit button

qs - QuickSetup controller

getCloseButtonToolTip

public org.forgerock.i18n.LocalizableMessage getCloseButtonToolTip()

Description copied from class: GuiApplication

Gets the key for the close button's tool tip text.

Overrides:

getCloseButtonToolTip in class GuiApplication

Returns:

String key of the text in the resource bundle

getFinishButtonToolTip

public org.forgerock.i18n.LocalizableMessage getFinishButtonToolTip()

Description copied from class: GuiApplication

Gets the key for the finish button's tool tip text.

Overrides:

getFinishButtonToolTip in class GuiApplication

Returns:

String key of the text in the resource bundle

getFinishButtonLabel

public org.forgerock.i18n.LocalizableMessage getFinishButtonLabel()

Description copied from class: GuiApplication

Gets the key for the finish button's label.

Overrides:

getFinishButtonLabel in class GuiApplication

Returns:

String key of the text in the resource bundle

previousClicked

public void previousClicked(WizardStep cStep,
                            QuickSetup qs)

Description copied from class: GuiApplication

Called when the user has clicked the 'previous' button.

Specified by:

previousClicked in class GuiApplication

Parameters:

cStep - WizardStep at which the user clicked the previous button

qs - QuickSetup controller

notifyListeners

public void notifyListeners(Integer ratio,
                            org.forgerock.i18n.LocalizableMessage currentPhaseSummary,
                            org.forgerock.i18n.LocalizableMessage newLogDetail)

Description copied from class: Application

This method notifies the ProgressUpdateListeners that there was an update in the installation progress.

Specified by:

notifyListeners in interface ProgressNotifier

Overrides:

notifyListeners in class Application

Parameters:

ratio - the integer that specifies which percentage of the whole installation has been completed.

currentPhaseSummary - the localized summary message for the current installation progress in formatted form.

newLogDetail - the new log messages that we have for the installation in formatted form.

finishClicked

public boolean finishClicked(WizardStep cStep,
                             QuickSetup qs)

Description copied from class: GuiApplication

Called when the user has clicked the 'finish' button.

Specified by:

finishClicked in class GuiApplication

Parameters:

cStep - WizardStep at which the user clicked the previous button

qs - QuickSetup controller

Returns:

boolean that the application uses to indicate the the application should be launched. If false, the application is responsible for updating the user data for the final screen and launching the application if this is the desired behavior.

updateUserData

public void updateUserData(WizardStep step,
                           QuickSetup qs)

Description copied from class: GuiApplication

Called whenever this application should update its user data from values found in QuickSetup.

Specified by:

updateUserData in class GuiApplication

Parameters:

step - current wizard step

qs - QuickSetup controller

setWizardDialogState

public void setWizardDialogState(QuickSetupDialog dlg,
                                 UserData userData,
                                 WizardStep step)

Description copied from class: GuiApplication

Called when the user advances to new step in the wizard. Applications are expected to manipulate the QuickSetupDialog to reflect the current step.

Specified by:

setWizardDialogState in class GuiApplication

Parameters:

dlg - QuickSetupDialog hosting the wizard

userData - UserData representing the data specified by the user

step - Step indicating the new current step

createUserData

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

Description copied from interface: CliApplication

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

Specified by:

createUserData in interface CliApplication

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.

getInstallationPath

public String getInstallationPath()

Description copied from class: Application

Returns the installation path.

Specified by:

getInstallationPath in class Application

Returns:

the installation path.

getInstancePath

public String getInstancePath()

Description copied from class: Application

Returns the instance path.

Specified by:

getInstancePath in class Application

Returns:

the instance path.

getRunError

public ApplicationException getRunError()

Returns the ApplicationException that might occur during installation or null if no exception occurred.

Specified by:

getRunError in interface CliApplication

Returns:

the ApplicationException that might occur during installation or null if no exception occurred.

getReturnCode

public ReturnCode getReturnCode()

Description copied from interface: CliApplication

Gets the return code to return to the console.

Specified by:

getReturnCode in interface CliApplication

Returns:

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

run

public void run()

Actually performs the uninstall in this thread. The thread is blocked.

Specified by:

run in interface Runnable

getCurrentProgressStep

public UninstallProgressStep getCurrentProgressStep()

Description copied from class: Application

Gets the current step.

Specified by:

getCurrentProgressStep in class Application

Returns:

ProgressStep representing the current step

getRatio

public Integer getRatio(ProgressStep step)

Returns an integer that specifies which percentage of the whole installation has been completed.

Specified by:

getRatio in class Application

Parameters:

step - the UninstallProgressStep for which we want to get the ratio.

Returns:

an integer that specifies which percentage of the whole uninstallation has been completed.

getSummary

public org.forgerock.i18n.LocalizableMessage getSummary(ProgressStep step)

Returns an formatted representation of the summary for the specified UninstallProgressStep.

Specified by:

getSummary in class Application

Parameters:

step - the UninstallProgressStep for which we want to get the summary.

Returns:

an formatted representation of the summary for the specified UninstallProgressStep.

isFinished

public boolean isFinished()

Description copied from class: Application

Returns whether the installer has finished or not.

Specified by:

isFinished in class Application

Returns:

true if the install is finished or false if not.

isCancellable

public boolean isCancellable()

Description copied from class: Application

Indicates whether this application is capable of cancelling the operation performed in the run method. A cancellable operation should leave its environment in the same state as it was prior to running the operation (files deleted, changes backed out etc.). Marking an Application as cancellable may control UI elements like the presense of a cancel button while the operation is being performed. Applications marked as cancellable should override the cancel method in such a way as to undo whatever actions have taken place in the run method up to that point.

Specified by:

isCancellable in class Application

Returns:

boolean where true inidcates that the operation is cancellable

cancel

public void cancel()

Description copied from class: Application

Signals that the application should cancel a currently running operation as soon as possible and return the environment to the state prior to running the operation. When finished backing out changes the application should make sure that isFinished returns true so that the application can complete.

Specified by:

cancel in class Application

windowClosing

public void windowClosing(QuickSetupDialog dlg,
                          WindowEvent evt)

Description copied from class: GuiApplication

Called by the controller when the window is closing. The application can take application specific actions here.

Specified by:

windowClosing in class GuiApplication

Parameters:

dlg - QuickSetupDialog that will be closing

evt - The event from the Window indicating closing

getInitialFocusButtonName

public ButtonName getInitialFocusButtonName()

Description copied from class: GuiApplication

Get the name of the button that will receive initial focus.

Specified by:

getInitialFocusButtonName in class GuiApplication

Returns:

ButtonName of the button to receive initial focus

getWizardSteps

public Set<? extends WizardStep> getWizardSteps()

Description copied from class: GuiApplication

Returns the set of wizard steps used in this application's wizard.

Specified by:

getWizardSteps in class GuiApplication

Returns:

Set of Step objects representing wizard steps

createWizardStepPanel

public QuickSetupStepPanel createWizardStepPanel(WizardStep step)

Description copied from class: GuiApplication

Creates a wizard panel given a specific step.

Specified by:

createWizardStepPanel in class GuiApplication

Parameters:

step - for which a panel representation should be created

Returns:

QuickSetupStepPanel for representing the step

getTrustManager

public ApplicationTrustManager getTrustManager()

Description copied from class: Application

Returns the trust manager that can be used to establish secure connections.

Overrides:

getTrustManager in class Application

Returns:

the trust manager that can be used to establish secure connections.