View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.ui.contentapp.setup.for5_3;
35  
36  import info.magnolia.module.delta.ArrayDelegateTask;
37  import info.magnolia.ui.api.action.ActionDefinition;
38  
39  /**
40   * Invokes JCR-liberated content app migration tasks. The list of such tasks includes:
41   * <ul>
42   *     <li>{@link MigrateAvailabilityRulesTask} - migrates availability rules from ui-api</li>
43   *     <li>{@link MigrateJcrPropertiesToContentConnectorTask} - moves respective properties from workbench definition to content connector</li>
44   *     <li>{@link MoveActionNodeTypeRestrictionToAvailabilityTask} - fixes AbstractItemActionDefinition and its descendants configuration</li>
45   *     <li>{@link ChangeAvailabilityRuleClassesTask} - updates availability definition structure</li>
46   * </ul>
47   */
48  public class ContentAppMigrationTask extends ArrayDelegateTask {
49  
50      public ContentAppMigrationTask(String path) {
51          this(path, new Class[]{});
52      }
53  
54      /**
55       * Constructs {@link ContentAppMigrationTask}.
56       * 
57       * @param path path to the module/app to be updated.
58       * @param additionalActionsToMigrate if an app to be updated utilizes some descendants of {@link ActionDefinition} they should be specified so that their configuration gets also updated.
59       */
60      public ContentAppMigrationTask(String path, Class<? extends ActionDefinition>... additionalActionsToMigrate) {
61          super("Execute JCR-liberated content app migration tasks",
62                  "Migrate availability rules from ui-api, move respective properties from workbench to content connector, update availability definition structure, fix AbstractItemActionDefinition and its descendants configuration.");
63  
64          addTask(new ChangeAvailabilityRuleClassesTask(path));
65          addTask(new MigrateAvailabilityRulesTask(path));
66          addTask(new MigrateJcrPropertiesToContentConnectorTask(path));
67          addTask(new MoveActionNodeTypeRestrictionToAvailabilityTask(path, additionalActionsToMigrate));
68      }
69  }