info.magnolia.module.delta

Class ExecuteCommandTask

java.lang.Object

info.magnolia.module.delta.AbstractTask

info.magnolia.module.delta.ExecuteCommandTask

All Implemented Interfaces:

Task

public class ExecuteCommandTask
extends AbstractTask

Task that executes command.

Field Summary

Fields inherited from class info.magnolia.module.delta.AbstractTask

DO_NOTHING, log

Constructor Summary

Constructors

Constructor and Description
ExecuteCommandTask(String taskName, String taskDescription, Class<? extends Command> commandClass, Object... params) Constructor.

Method Summary

Modifier and Type	Method and Description
void	execute(InstallContext installContext) A good-citizen task should execute itself responsibly: it should know what to do in case of problems: for instance, fixable or irrelevant issues should usually just be logged used the InstallContext methods, when the user can fix them later on.

Methods inherited from class info.magnolia.module.delta.AbstractTask

getDescription, getName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecuteCommandTask

public ExecuteCommandTask(String taskName,
                          String taskDescription,
                          Class<? extends Command> commandClass,
                          Object... params)

Constructor.

Parameters:

taskName - name of the task

taskDescription - description of the task

commandName - command class

params - parameters to be passed to the command's constructor

Method Detail

execute

public void execute(InstallContext installContext)
             throws TaskExecutionException

Description copied from interface: Task

A good-citizen task should execute itself responsibly: it should know what to do in case of problems: for instance, fixable or irrelevant issues should usually just be logged used the InstallContext methods, when the user can fix them later on. The task could also potentially do backups of nodes it needs to modify extensively, so the user could refer to the backups in case of problem. In the event of an unrecoverable issue, the Task could also throw a TaskExecutionException, knowing that will cancel the whole module's installation, update and startup. If a TaskExecutionException must be thrown, keep in mind that the exception message will still be shown to the end user, so try to keep them human readable.

Throws:

TaskExecutionException