org.opends.guitools.controlpanel.ui

Class ExportLDIFPanel.ExportTask

java.lang.Object

org.opends.guitools.controlpanel.task.Task

org.opends.guitools.controlpanel.ui.InclusionExclusionPanel.InclusionExclusionTask

org.opends.guitools.controlpanel.ui.ExportLDIFPanel.ExportTask

Enclosing class:

ExportLDIFPanel

protected class ExportLDIFPanel.ExportTask
extends InclusionExclusionPanel.InclusionExclusionTask

The class that performs the export.

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
ExportLDIFPanel.ExportTask(ControlPanelInfo info, ProgressDialog dlg) The 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 command line arguments corresponding to the elements displayed in the inclusion/exclusion panels.
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.
LocalizableMessage	getTaskDescription() The description of the task.
Task.Type	getType() Returns the type of the task.
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, 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

ExportLDIFPanel.ExportTask

public ExportLDIFPanel.ExportTask(ControlPanelInfo info,
                          ProgressDialog dlg)

The constructor of the task.

Parameters:

info - the control panel info.

dlg - the progress dialog that shows the progress of the task.

Method Detail

getType

public Task.Type getType()

Returns the type of the task.

Specified by:

getType in class Task

Returns:

the type of 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.

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

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.

getCommandLineArguments

protected ArrayList<String> getCommandLineArguments()

Returns the command line arguments corresponding to the elements displayed in the inclusion/exclusion panels.

Overrides:

getCommandLineArguments in class InclusionExclusionPanel.InclusionExclusionTask

Returns:

the command line arguments corresponding to the elements displayed in the inclusion/exclusion panels.

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.