View Javadoc
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;
35  
36  import info.magnolia.module.delta.ModuleBootstrapTask;
37  import info.magnolia.module.delta.ModuleFilesExtraction;
38  import info.magnolia.module.delta.RegisterModuleServletsTask;
39  import info.magnolia.module.delta.SamplesBootstrapTask;
40  import info.magnolia.module.delta.SetupModuleRepositoriesTask;
41  import info.magnolia.module.delta.Task;
42  
43  import java.util.ArrayList;
44  import java.util.List;
45  
46  /**
47   * A version handler which provides the most common installation tasks:
48   * register repositories, nodetypes and workspaces as stated in the
49   * module definition, bootstrap the module's mgnl-bootstrap files,
50   * extract the module's mgnl-files files, register the module's servlets.
51   */
52  public class DefaultModuleVersionHandler extends AbstractModuleVersionHandler {
53  
54      /**
55       * This method should generally not be overridden.
56       * To add install tasks, use {@link #getExtraInstallTasks}.
57       */
58      @Override
59      protected List<Task> getBasicInstallTasks(InstallContext installContext) {
60          final List<Task> basicInstallTasks = new ArrayList<Task>();
61          basicInstallTasks.add(new SetupModuleRepositoriesTask());
62          basicInstallTasks.add(new ModuleBootstrapTask());
63          basicInstallTasks.add(new SamplesBootstrapTask());
64          basicInstallTasks.add(new ModuleFilesExtraction());
65          basicInstallTasks.add(new RegisterModuleServletsTask());
66          return basicInstallTasks;
67      }
68  
69  }