View Javadoc

1   /**
2    * This file Copyright (c) 2007-2013 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.delta;
35  
36  import info.magnolia.cms.core.ItemType;
37  import info.magnolia.jcr.util.NodeTypes;
38  import info.magnolia.jcr.util.NodeUtil;
39  import info.magnolia.module.InstallContext;
40  import info.magnolia.repository.RepositoryConstants;
41  
42  import javax.jcr.RepositoryException;
43  import javax.jcr.Session;
44  
45  /**
46   * A Task to create a full path, i.e the parent doesn't need to exist.
47   */
48  public class CreateNodePathTask extends AbstractRepositoryTask {
49  
50      private final String workspace;
51      private final String path;
52      private final String type;
53  
54      public CreateNodePathTask(String name, String path, String type) {
55          this(name, String.format("Create node path '%s:%s'.", RepositoryConstants.CONFIG, path),
56                  RepositoryConstants.CONFIG, path, type);
57      }
58  
59      public CreateNodePathTask(String name, String description, String workspace, String path) {
60          this(name, description, workspace, path, NodeTypes.Content.NAME);
61      }
62  
63      public CreateNodePathTask(String name, String description, String workspace, String path, String type) {
64          super(name, description);
65          this.workspace = workspace;
66          this.path = path;
67          this.type = type;
68      }
69  
70      /**
71       * @deprecated since 5.2.2, use {@link #CreateNodePathTask(String, String, String, String, String)} instead.
72       */
73      public CreateNodePathTask(String name, String description, String workspace, String path, ItemType type) {
74          this(name, description, workspace, path, type.getSystemName());
75      }
76  
77      @Override
78      protected void doExecute(InstallContext installContext) throws TaskExecutionException, RepositoryException {
79          final Session session = installContext.getJCRSession(workspace);
80          NodeUtil.createPath(session.getRootNode(), path, type);
81      }
82  }