org.nuxeo.connect.update.task.standalone.commands
Class AbstractCommand

java.lang.Object
  org.nuxeo.connect.update.task.standalone.commands.AbstractCommand

All Implemented Interfaces:

org.nuxeo.connect.update.task.Command

Direct Known Subclasses:

CompositeCommand, Config, Copy, Delete, DeployConfigPlaceholder, DeployPlaceholder, InstallPlaceholder, LoadJarPlaceholder, PostInstallCommand, Rollback, UnAppend, UndeployConfigPlaceholder, UndeployPlaceholder, UninstallPlaceholder, UnloadJarPlaceholder, Update

public abstract class AbstractCommand
extends Object
implements org.nuxeo.connect.update.task.Command

All commands have 2 attributes: fail and ignore which are EL expressions.

If ignore is defined and evaluated to true then the command will be ignored (null is returned as the inverse command) If fail is defined and evaluated to true then the validation fails.

Commands extending this class must implement the doRun(org.nuxeo.connect.update.task.Task, java.util.Map) and doValidate(org.nuxeo.connect.update.task.Task, org.nuxeo.connect.update.ValidationStatus) methods instead of the one in the interface. These methods are first testing for ignore and fail guards and then if needed delegated to the doXXX method versions.

Author:

Bogdan Stefanescu

Field Summary

static String[]

FILES_TO_DELETE_ONLY_ON_EXIT List of files which must never be deleted at runtime.

Constructor Summary

AbstractCommand(AbstractCommand command)

Method Summary

String	getId()
boolean	ignore()
void	initialize(Element element)
boolean	isPostInstall()
abstract void	readFrom(Element element) Must be implemented to initialize the command arguments from an XML fragment.
org.nuxeo.connect.update.task.Command	run(org.nuxeo.connect.update.task.Task task, Map<String,String> prefs)
void	setFail(String fail)
void	setIgnore(String ignore)
void	validate(org.nuxeo.connect.update.task.Task task, org.nuxeo.connect.update.ValidationStatus status)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.connect.update.task.Command

writeTo

Field Detail

FILES_TO_DELETE_ONLY_ON_EXIT

public static final String[] FILES_TO_DELETE_ONLY_ON_EXIT

List of files which must never be deleted at runtime.

Since:

5.5

Constructor Detail

AbstractCommand

public AbstractCommand(AbstractCommand command)

Method Detail

isPostInstall

public boolean isPostInstall()

Specified by:

isPostInstall in interface org.nuxeo.connect.update.task.Command

validate

public void validate(org.nuxeo.connect.update.task.Task task,
                     org.nuxeo.connect.update.ValidationStatus status)
              throws org.nuxeo.connect.update.PackageException

Specified by:

validate in interface org.nuxeo.connect.update.task.Command

Throws:

org.nuxeo.connect.update.PackageException

run

public org.nuxeo.connect.update.task.Command run(org.nuxeo.connect.update.task.Task task,
                                                 Map<String,String> prefs)
                                          throws org.nuxeo.connect.update.PackageException

Specified by:

run in interface org.nuxeo.connect.update.task.Command

Throws:

org.nuxeo.connect.update.PackageException

getId

public String getId()

Specified by:

getId in interface org.nuxeo.connect.update.task.Command

setFail

public void setFail(String fail)

setIgnore

public void setIgnore(String ignore)

ignore

public boolean ignore()
               throws org.nuxeo.connect.update.PackageException

Throws:

org.nuxeo.connect.update.PackageException

initialize

public void initialize(Element element)
                throws org.nuxeo.connect.update.PackageException

Specified by:

initialize in interface org.nuxeo.connect.update.task.Command

Throws:

org.nuxeo.connect.update.PackageException

readFrom

public abstract void readFrom(Element element)
                       throws org.nuxeo.connect.update.PackageException

Must be implemented to initialize the command arguments from an XML fragment.

Throws:

org.nuxeo.connect.update.PackageException