View Javadoc
1   /**
2    * This file Copyright (c) 2012-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;
35  
36  import info.magnolia.jcr.util.NodeUtil;
37  import info.magnolia.jcr.util.NodeVisitor;
38  import info.magnolia.module.InstallContext;
39  import info.magnolia.module.delta.QueryTask;
40  import info.magnolia.module.delta.TaskExecutionException;
41  
42  import javax.jcr.Node;
43  import javax.jcr.RepositoryException;
44  
45  import org.slf4j.Logger;
46  import org.slf4j.LoggerFactory;
47  
48  /**
49   * Changes type of content app descriptors to {@link info.magnolia.ui.contentapp.ConfiguredContentAppDescriptor}.
50   */
51  public class ContentAppDescriptorMigrationTask extends QueryTask {
52  
53      private static final Logger log = LoggerFactory.getLogger(ContentAppDescriptorMigrationTask.class);
54      private NodeVisitor nodeVisitor = new AppNodeVisitor();
55  
56      public ContentAppDescriptorMigrationTask(String name, String description, String configRepository, String query) {
57          super(name, description, configRepository, query);
58      }
59  
60      public ContentAppDescriptorMigrationTask(String name, String description, String configRepository, String query, NodeVisitor nodeVisitor) {
61          super(name, description, configRepository, query);
62          this.nodeVisitor = nodeVisitor;
63      }
64  
65      @Override
66      protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
67          log.info("Start content app descriptor migration ");
68          try {
69              super.doExecute(ctx);
70              log.info("Successfully execute cleanup of the content repository ");
71          } catch (Exception e) {
72              log.error("Unable to clean content repository", e);
73              ctx.error("Unable to perform Migration task " + getName(), e);
74              throw new TaskExecutionException(e.getMessage());
75          } finally {
76              log.info("Finished content app descriptor migration ");
77          }
78      }
79  
80      @Override
81      protected void operateOnNode(InstallContext ctx, Node node) {
82          try {
83              NodeUtil.visit(node.getParent(), nodeVisitor);
84          } catch (RepositoryException e) {
85              log.error("Unable to process app node ", e);
86          }
87  
88      }
89  }