info.magnolia.module.delta
Interface Task

All Known Implementing Classes:

AbstractConditionalRepositoryTask, AbstractModuleVersionHandler.ModuleVersionToLatestTask, AbstractModuleVersionHandler.ModuleVersionUpdateTask, AbstractNodeBuilderTask, AbstractRepositoryTask, AbstractTask, AddFilterBypassTask, AddGroupToGroupTask, AddMailTemplateTask, AddMainMenuItemTask, AddMimeMappingTask, AddPermissionTask, AddRoleToGroupTask, AddRoleToUserTask, AddSubMenuItemTask, AddURIPermissionsToAllRoles, AddURIPermissionTask, AddUserToGroupTask, AddUserToRoleTask, AllChildrenNodesOperation, AllModulesNodeOperation, ArrayDelegateTask, BackupTask, BootstrapConditionally, BootstrapResourcesTask, BootstrapSingleModuleResource, BootstrapSingleResource, BootstrapSingleResourceAndOrderBefore, ChangeNodeTypeTask, ChangeTemplateTask, CheckAndModifyPartOfPropertyValueTask, CheckAndModifyPropertyValueTask, CheckOrCreatePropertyTask, ChildrenExistsDelegateTask, ConditionalDelegateTask, ContentDeletionTasks, CopyNodeTask, CopyOrReplaceNodePropertiesTask, CreateNodePathTask, CreateNodeTask, ExecuteCommandTask, FilterOrderingTask, FindAndChangeTemplateIdTask, HashUsersPasswords, InstallWorkflowDefinitionTask, IsAuthorInstanceDelegateTask, IsInstallSamplesTask, IsModuleInstalledOrRegistered, LoginAuthTypePropertyMovedToFilter, LoginFormPropertyMovedToFilter, ModuleBootstrapTask, ModuleConfigNodeBuilderTask, ModuleDependencyBootstrapTask, ModuleFilesExtraction, ModuleNodeBuilderTask, MoveAndRenamePropertyTask, MoveNodeTask, NewPropertyTask, NodeBuilderTask, NodeCheckDelegateTask, NodeExistsDelegateTask, OrderFilterBeforeTask, OrderNodeAfterTask, OrderNodeBeforeTask, PartialBootstrapTask, PropertiesImportTask, PropertyExistsDelegateTask, PropertyValueDelegateTask, PropertyValuesTask, QueryTask, RegisterMgnlDeletedType, RegisterModuleServletsTask, RegisterNodeTypeTask, RegisterServletTask, RegisterWorkspaceForCacheFlushingTask, RemoveCacheTempFilesTask, RemoveDuplicatePermissionTask, RemoveInstallFilesTask, RemoveNodeAndEmptyParentTask, RemoveNodeTask, RemoveNodeWoChildren, RemovePermissionTask, RemovePropertyTask, RenameACLNodesTask, RenameNodesTask, RenameOldServletMappingsNodesTask, RenamePropertiesTask, RenamePropertyAllModulesNodeTask, ReplaceIfExistsTask, ReplaceWrongDialogNodeTypeTask, SamplesBootstrapTask, SetDefaultPublicURI, SetPropertyTask, SetupModuleRepositoriesTask, UpdatedDefaultPublicURIWarning, UpdateFromFtlToJspConfiguration, UpdateFromFtlToJspSite, UpdateFromFtlToJspVirtualUriMapping, UpdateSecurityFilterClientCallbacksConfiguration, UpdateURI2RepositoryMappings, UpdateURIMappings, UpdateUserManagers, WarnIgnoredModuleFilters, WarnTask, WebappBootstrap

public interface Task

A Task represents an atomic operation to be performed when installing, updating or uninstalling a module, as part of a Delta. TODO : add mandatoryness ?

Version:

$Revision: $ ($Author: $)

Author:

gjoseph

See Also:

Delta

Method Summary

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.
String	getDescription() Description what will happen during the execution.
String	getName() Description of what has changed.

Method Detail

getName

String getName()

Description of what has changed. Example: "New ACL configuration"

getDescription

String getDescription()

Description what will happen during the execution. Example: "Bootstraps the new configuration for the ACL dialogs." A good-citizen task description should be written in the third person, be understandable and respect capitalization and punctuation rules. (start with capital letter, end with a dot)

execute

void execute(InstallContext installContext)
             throws TaskExecutionException

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