org.opends.guitools.controlpanel.task

Class StartStopTask

java.lang.Object

org.opends.guitools.controlpanel.task.Task

org.opends.guitools.controlpanel.task.StartStopTask

Direct Known Subclasses:

RestartServerTask, StartServerTask, StopServerTask

public abstract class StartStopTask
extends Task

An abstract class used to re-factor some code between the start, stop and restart tasks.

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.guitools.controlpanel.task.Task

Task.State, Task.Type

Field Summary

Fields inherited from class org.opends.guitools.controlpanel.task.Task

errorLogs, errorPrintStream, lastException, logs, outPrintStream, outputLogs, process, returnCode, state

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StartStopTask(ControlPanelInfo info, ProgressDialog progressDialog) Constructor of the task.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLaunch(Task taskToBeLaunched, Collection<LocalizableMessage> incompatibilityReasons) Informs of whether the task to be launched can be launched or not.
Set<String>	getBackends() Returns the names of the backends that are affected by the task.
protected ArrayList<String>	getCommandLineArguments() Returns the list of command-line arguments.
protected void	postCommandLine() Method called just after calling the command-line.
void	runTask() Execute the task.

Methods inherited from class org.opends.guitools.controlpanel.task.Task

addConfigurationElementCreatedListener, displayBase64, executeCommandLine, getBinaryDir, getCommandLinePath, getCommandLinePath, getCommandLineToDisplay, getConfigCommandLineArguments, getConnectionCommandLineArguments, getConnectionCommandLineArguments, getEquivalentCommandLine, getErrorLogs, getErrorPrintStream, getIncompatibilityMessage, getInfo, getLastException, getLogs, getNoPropertiesFileArgument, getObfuscatedCommandLineArguments, getOutPrintStream, getOutputLogs, getProcess, getProgressDialog, getReturnCode, getServer, getState, getTaskDescription, getType, isServerRunning, notifyConfigurationElementCreated, obfuscateAttributeStringValue, obfuscateLDIFLine, postOperation, printEquivalentCommandLine, printEquivalentCommandToModify, printEquivalentCommandToModify, printEquivalentRenameCommand, regenerateDescriptor, removeConfigurationElementCreatedListener, runningOnSameServer

Methods inherited from class java.lang.Object

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

Constructor Detail

StartStopTask

protected StartStopTask(ControlPanelInfo info,
             ProgressDialog progressDialog)

Constructor of the task.

Parameters:

info - the control panel information.

progressDialog - the progress dialog where the task progress will be displayed.

Method Detail

getBackends

public Set<String> getBackends()

Returns the names of the backends that are affected by the task.

Specified by:

getBackends in class Task

Returns:

the names of the backends that are affected by the task.

canLaunch

public boolean canLaunch(Task taskToBeLaunched,
                Collection<LocalizableMessage> incompatibilityReasons)

Informs of whether the task to be launched can be launched or not. Every task must implement this method so that we avoid launching in paralel two tasks that are not compatible. Note that in general if the current task is not running this method will return true.

Specified by:

canLaunch in class Task

Parameters:

taskToBeLaunched - the Task that we are trying to launch.

incompatibilityReasons - the list of incompatibility reasons that must be updated.

Returns:

true if the task that we are trying to launch can be launched in parallel with this task and false otherwise.

runTask

public void runTask()

Execute the task. This method is synchronous.

Specified by:

runTask in class Task

getCommandLineArguments

protected ArrayList<String> getCommandLineArguments()

Returns the list of command-line arguments.

Specified by:

getCommandLineArguments in class Task

Returns:

the list of command-line arguments.

postCommandLine

protected void postCommandLine()

Method called just after calling the command-line. To be overwritten by the inheriting classes.