org.opends.guitools.controlpanel.task

Class ModifyEntryTask

java.lang.Object

org.opends.guitools.controlpanel.task.Task

org.opends.guitools.controlpanel.task.ModifyEntryTask

public class ModifyEntryTask
extends Task

The task that is called when we must modify an entry.

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

Constructor and Description
ModifyEntryTask(ControlPanelInfo info, ProgressDialog dlg, Entry newEntry, CustomSearchResult oldEntry, BrowserController controller, TreePath path) 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 String	getCommandLinePath() Returns the full path of the command-line associated with this task or null if there is not a command-line (or a single command-line) associated with the task.
static ArrayList<ModificationItem>	getModifications(Entry newEntry, CustomSearchResult oldEntry, ControlPanelInfo info) Gets the modifications to apply between two entries.
LocalizableMessage	getTaskDescription() The description of the task.
Task.Type	getType() Returns the type of the task.
boolean	hasModifications() Tells whether there actually modifications on the entry.
void	postOperation() Method that is called when everything is finished after updating the progress dialog.
boolean	regenerateDescriptor() Tells whether a new server descriptor should be regenerated when the task is over.
void	runTask() Execute the task.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ModifyEntryTask

public ModifyEntryTask(ControlPanelInfo info,
               ProgressDialog dlg,
               Entry newEntry,
               CustomSearchResult oldEntry,
               BrowserController controller,
               TreePath path)

Constructor of the task.

Parameters:

info - the control panel information.

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

newEntry - the entry containing the new values.

oldEntry - the old entry as we retrieved using JNDI.

controller - the BrowserController.

path - the TreePath corresponding to the node in the tree that we want to modify.

Method Detail

hasModifications

public boolean hasModifications()

Tells whether there actually modifications on the entry.

Returns:

true if there are modifications and false otherwise.

getType

public Task.Type getType()

Returns the type of the task.

Specified by:

getType in class Task

Returns:

the type of the task.

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.

getTaskDescription

public LocalizableMessage getTaskDescription()

The description of the task. It is used in both the incompatibility messages and in the warning message displayed when the user wants to quit and there are tasks running.

Specified by:

getTaskDescription in class Task

Returns:

the description of the task.

getCommandLinePath

protected String getCommandLinePath()

Returns the full path of the command-line associated with this task or null if there is not a command-line (or a single command-line) associated with the task.

Specified by:

getCommandLinePath in class Task

Returns:

the full path of the command-line associated with this 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.

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.

regenerateDescriptor

public boolean regenerateDescriptor()

Tells whether a new server descriptor should be regenerated when the task is over. If the task has an influence in the configuration or state of the server (for instance the creation of a base DN) this method should return true so that the configuration will be re-read and all the ConfigChangeListeners will receive a notification with the new configuration.

Overrides:

regenerateDescriptor in class Task

Returns:

true if a new server descriptor must be regenerated when the task is over and false otherwise.

runTask

public void runTask()

Execute the task. This method is synchronous.

Specified by:

runTask in class Task

postOperation

public void postOperation()

Method that is called when everything is finished after updating the progress dialog. It is called from the event thread.

Overrides:

postOperation in class Task

getModifications

public static ArrayList<ModificationItem> getModifications(Entry newEntry,
                                           CustomSearchResult oldEntry,
                                           ControlPanelInfo info)

Gets the modifications to apply between two entries.

Parameters:

newEntry - the new entry.

oldEntry - the old entry.

info - the ControlPanelInfo, used to retrieve the schema for instance.

Returns:

the modifications to apply between two entries.