View Javadoc
1   /**
2    * This file Copyright (c) 2009-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.nodebuilder.task;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.module.InstallContext;
38  import info.magnolia.module.delta.AbstractRepositoryTask;
39  import info.magnolia.module.delta.TaskExecutionException;
40  import info.magnolia.nodebuilder.ErrorHandler;
41  import info.magnolia.nodebuilder.NodeBuilder;
42  import info.magnolia.nodebuilder.NodeOperation;
43  import info.magnolia.nodebuilder.NodeOperationException;
44  import info.magnolia.nodebuilder.StrictErrorHandler;
45  
46  import javax.jcr.RepositoryException;
47  
48  /**
49   * Base class for {@link info.magnolia.module.delta.Task}s using the node builder API.
50   *
51   * @deprecated since 5.3 - use {@link info.magnolia.jcr.nodebuilder.task.AbstractNodeBuilderTask} instead.
52   */
53  @Deprecated
54  public abstract class AbstractNodeBuilderTask extends AbstractRepositoryTask {
55      private final ErrorHandling errorHandling;
56      private final NodeOperation[] operations;
57  
58      public AbstractNodeBuilderTask(String name, String description, ErrorHandling errorHandling, NodeOperation... operations) {
59          super(name, description);
60          this.errorHandling = errorHandling;
61          this.operations = operations;
62      }
63  
64      @Override
65      protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
66          final Content root = getRootNode(ctx);
67          final ErrorHandler errorHandler = newErrorHandler(ctx);
68          final NodeBuilderhtml#NodeBuilder">NodeBuilder nodeBuilder = new NodeBuilder(errorHandler, root, operations);
69          try {
70              nodeBuilder.exec();
71          } catch (NodeOperationException e) {
72              throw new TaskExecutionException(e.getMessage(), e);
73          }
74      }
75  
76      protected abstract Content getRootNode(InstallContext ctx) throws RepositoryException;
77  
78  
79      protected ErrorHandler newErrorHandler(InstallContext ctx) {
80          switch (errorHandling) {
81          case logging:
82              return new TaskLogErrorHandler(ctx);
83          case strict:
84              return new StrictErrorHandler();
85          }
86          throw new IllegalStateException("Improbable errorHandling: " + errorHandling);
87      }
88  }