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.cms.util.ContentUtil;
38  import info.magnolia.module.InstallContext;
39  import info.magnolia.nodebuilder.NodeOperation;
40  
41  import javax.jcr.Node;
42  import javax.jcr.RepositoryException;
43  import javax.jcr.Session;
44  
45  import org.apache.commons.lang3.StringUtils;
46  
47  /**
48   * A task using the NodeBuilder API, applying operations on a given path.
49   *
50   * @deprecated since 5.3 - use {@link info.magnolia.jcr.nodebuilder.task.NodeBuilderTask} instead.
51   */
52  @Deprecated
53  public class NodeBuilderTask extends AbstractNodeBuilderTask {
54  
55      private final String workspaceName;
56      private final String rootPath;
57  
58      public NodeBuilderTask(String taskName, String description, ErrorHandling errorHandling, String workspaceName, NodeOperation... operations) {
59          this(taskName, description, errorHandling, workspaceName, "/", operations);
60      }
61  
62      public NodeBuilderTask(String taskName, String description, ErrorHandling errorHandling, String workspaceName, String rootPath, NodeOperation... operations) {
63          super(taskName, description, errorHandling, operations);
64          this.workspaceName = workspaceName;
65          this.rootPath = rootPath;
66      }
67  
68      @Override
69      protected Content getRootNode(InstallContext ctx) throws RepositoryException {
70          final Session session = ctx.getJCRSession(workspaceName);
71          // Previously hierarchy manager would expect relative path, worse than that, it would remove any prefixed slash
72          // from given path before calling #getContent()
73          final Node rootNode;
74          if ("/".equals(this.rootPath)) {
75              rootNode = session.getRootNode();
76          } else {
77              final String rootPath = StringUtils.removeStart(this.rootPath, "/");
78              rootNode = session.getRootNode().getNode(rootPath);
79          }
80          return ContentUtil.asContent(rootNode);
81      }
82  }