public class Uninstaller extends GuiApplication implements CliApplication
Application.ErrorPrintStream, Application.OutputPrintStream, Application.PointAdder
formatter, installStatus, tempLogFile
Constructor and Description |
---|
Uninstaller()
Default constructor.
|
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).
|
LocalizableMessage |
getCloseButtonToolTip()
Gets the key for the close button's tool tip text.
|
UninstallProgressStep |
getCurrentProgressStep()
Gets the current step.
|
LocalizableMessage |
getFinishButtonLabel()
Gets the key for the finish button's label.
|
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.
|
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. |
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,
LocalizableMessage currentPhaseSummary,
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.
|
acceptCertificateForException, confirmCancel, createFramePanel, forceToDisplay, getCurrentWizardStep, getExtraDialogHeight, getOrderedSteps, getQuitButtonToolTip, getTab, getUserArguments, isSubStep, isVisible, isVisible, setDisplayedWizardStep, setQuickSetupDialog, setUserArguments
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getUserData, setProgressMessageFormatter, setUserData
addProgressUpdateListener, removeProgressUpdateListener
public Uninstaller()
public LocalizableMessage getFrameTitle()
GuiApplication
getFrameTitle
in class GuiApplication
public UserData createUserData()
Application
createUserData
in class Application
public WizardStep getFirstWizardStep()
GuiApplication
getFirstWizardStep
in class GuiApplication
public WizardStep getNextWizardStep(WizardStep step)
GuiApplication
getNextWizardStep
in class GuiApplication
step
- Step the current steppublic WizardStep getPreviousWizardStep(WizardStep step)
GuiApplication
getPreviousWizardStep
in class GuiApplication
step
- Step the current steppublic WizardStep getFinishedStep()
GuiApplication
getFinishedStep
in class GuiApplication
public boolean finishOnLeft()
GuiApplication
finishOnLeft
in class GuiApplication
true
if the finish button must be placed on the left
and false
otherwise.public boolean canGoBack(WizardStep step)
GuiApplication
step
.canGoBack
in class GuiApplication
step
- WizardStep for which the the return value indicates whether
or not the user can return to a previous stepstep
public boolean canGoForward(WizardStep step)
GuiApplication
step
.canGoForward
in class GuiApplication
step
- WizardStep for which the the return value indicates whether
or not the user can move to a new stepstep
public boolean canFinish(WizardStep step)
GuiApplication
step
.canFinish
in class GuiApplication
step
- WizardStep for which the the return value indicates whether
or not the user can finish the wizardpublic boolean canQuit(WizardStep step)
step
- the wizard steppublic void nextClicked(WizardStep cStep, QuickSetup qs)
GuiApplication
nextClicked
in class GuiApplication
cStep
- WizardStep at which the user clicked the next buttonqs
- QuickSetup controllerpublic void closeClicked(WizardStep cStep, QuickSetup qs)
GuiApplication
closeClicked
in class GuiApplication
cStep
- WizardStep at which the user clicked the close buttonqs
- QuickSetup controllerpublic void quitClicked(WizardStep step, QuickSetup qs)
GuiApplication
quitClicked
in class GuiApplication
step
- WizardStep at which the user clicked the quit buttonqs
- QuickSetup controllerpublic LocalizableMessage getCloseButtonToolTip()
GuiApplication
getCloseButtonToolTip
in class GuiApplication
public LocalizableMessage getFinishButtonToolTip()
GuiApplication
getFinishButtonToolTip
in class GuiApplication
public LocalizableMessage getFinishButtonLabel()
GuiApplication
getFinishButtonLabel
in class GuiApplication
public void previousClicked(WizardStep cStep, QuickSetup qs)
GuiApplication
previousClicked
in class GuiApplication
cStep
- WizardStep at which the user clicked the previous buttonqs
- QuickSetup controllerpublic void notifyListeners(Integer ratio, LocalizableMessage currentPhaseSummary, LocalizableMessage newLogDetail)
Application
notifyListeners
in interface ProgressNotifier
notifyListeners
in class Application
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.public boolean finishClicked(WizardStep cStep, QuickSetup qs)
GuiApplication
finishClicked
in class GuiApplication
cStep
- WizardStep at which the user clicked the previous buttonqs
- QuickSetup controllerpublic void updateUserData(WizardStep step, QuickSetup qs)
GuiApplication
updateUserData
in class GuiApplication
step
- current wizard stepqs
- QuickSetup controllerpublic void setWizardDialogState(QuickSetupDialog dlg, UserData userData, WizardStep step)
GuiApplication
setWizardDialogState
in class GuiApplication
dlg
- QuickSetupDialog hosting the wizarduserData
- UserData representing the data specified by the userstep
- Step indicating the new current steppublic UserData createUserData(Launcher launcher) throws UserDataException, ApplicationException, com.forgerock.opendj.cli.ClientException
CliApplication
createUserData
in interface CliApplication
launcher
- that launched this applicationUserDataException
- if something is wrong with the data provided by the userApplicationException
- if there is an application specific problemcom.forgerock.opendj.cli.ClientException
- If an error occurs when creating the data.public String getInstallationPath()
Application
getInstallationPath
in class Application
public String getInstancePath()
Application
getInstancePath
in class Application
public ApplicationException getRunError()
null
if no exception occurred.getRunError
in interface CliApplication
null
if no exception occurred.public ReturnCode getReturnCode()
CliApplication
getReturnCode
in interface CliApplication
getRunError
will be used.public void run()
public UninstallProgressStep getCurrentProgressStep()
Application
getCurrentProgressStep
in class Application
public Integer getRatio(ProgressStep step)
getRatio
in class Application
step
- the UninstallProgressStep for which we want to get the ratio.public LocalizableMessage getSummary(ProgressStep step)
getSummary
in class Application
step
- the UninstallProgressStep for which we want to get the summary.public boolean isFinished()
Application
isFinished
in class Application
true
if the install is finished or false
if not.public boolean isCancellable()
Application
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.isCancellable
in class Application
public void cancel()
Application
isFinished
returns true so that the application can complete.cancel
in class Application
public void windowClosing(QuickSetupDialog dlg, WindowEvent evt)
GuiApplication
windowClosing
in class GuiApplication
dlg
- QuickSetupDialog that will be closingevt
- The event from the Window indicating closingpublic ButtonName getInitialFocusButtonName()
GuiApplication
getInitialFocusButtonName
in class GuiApplication
public Set<? extends WizardStep> getWizardSteps()
GuiApplication
getWizardSteps
in class GuiApplication
public QuickSetupStepPanel createWizardStepPanel(WizardStep step)
GuiApplication
createWizardStepPanel
in class GuiApplication
step
- for which a panel representation should be createdstep
public ApplicationTrustManager getTrustManager()
Application
getTrustManager
in class Application
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.