1 /**
2 * This file Copyright (c) 2003-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.module.delta;
35
36 import info.magnolia.module.InstallContext;
37
38 /**
39 * A Task represents an atomic operation to be performed when installing,
40 * updating or uninstalling a module, as part of a Delta.
41 *
42 * TODO : add mandatoryness ?
43 *
44 * @see info.magnolia.module.delta.Delta
45 */
46 public interface Task {
47 /**
48 * Description of what has changed. Example: "New ACL configuration"
49 */
50 String getName();
51
52 /**
53 * Description what will happen during the execution. Example: "Bootstraps the new configuration for the ACL dialogs."
54 * A good-citizen task description should be written in the third person, be understandable and respect capitalization
55 * and punctuation rules. (start with capital letter, end with a dot)
56 */
57 String getDescription();
58
59 /**
60 * A good-citizen task should execute itself responsibly: it should know
61 * what to do in case of problems: for instance, fixable or irrelevant
62 * issues should usually just be logged used the InstallContext methods,
63 * when the user can fix them later on. The task could also potentially
64 * do backups of nodes it needs to modify extensively, so the user could
65 * refer to the backups in case of problem. In the event of an unrecoverable
66 * issue, the Task could also throw a TaskExecutionException, knowing that
67 * will cancel the whole module's installation, update and startup. If
68 * a TaskExecutionException must be thrown, keep in mind that the exception
69 * message will still be shown to the end user, so try to keep them human
70 * readable.
71 */
72 void execute(InstallContext installContext) throws TaskExecutionException;
73 }