View Javadoc
1   /**
2    * This file Copyright (c) 2003-2015 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;
35  
36  import info.magnolia.module.delta.Delta;
37  import info.magnolia.module.model.Version;
38  
39  import java.util.List;
40  
41  /**
42   * This class provides Delta's to be applied to install/update/uninstall modules.
43   * A module that needs to handle its own install/updates should provide an implementation
44   * of this interface.
45   *
46   * @see AbstractModuleVersionHandler for a convenient super class.
47   */
48  public interface ModuleVersionHandler {
49  
50  
51      // TODO : these two methods can maybe be merged, since they're called sequentially in ModuleManager
52      /**
53       * Gets the currently installed version number of this module.
54       */
55      Version getCurrentlyInstalled(InstallContext ctx);
56  
57      /**
58       * Returns the deltas to be applied to update from the given Version from
59       * to the current one. If from is null, it means the module is being installed,
60       * and we should thus return the necessary deltas to <strong>install</strong>
61       * it.
62       * It is also responsible for updating the current version number of the module,
63       * wherever it is stored.
64       */
65      List<Delta> getDeltas(InstallContext installContext, Version from);
66  
67      /**
68       * Returns a {@link Delta} that needs to be executed always before this module is started. These tasks will
69       * be silently applied at startup.
70       * @param installContext InstallContext
71       * @deprecated It seems irrelevant to have startup tasks in a VersionHandler. These should probably be moved to ModuleLifecycle.
72       */
73       Delta getStartupDelta(InstallContext installContext);
74  
75  }