View Javadoc
1   /**
2    * This file Copyright (c) 2003-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.module.delta;
35  
36  import info.magnolia.module.InstallContext;
37  import info.magnolia.repository.RepositoryConstants;
38  
39  import javax.jcr.RepositoryException;
40  
41  /**
42   * A task that delegates to another depending on whether a specified node exists or not.
43   */
44  public class NodeExistsDelegateTask extends ConditionalDelegateTask {
45      private final String workspaceName;
46      private final String pathToCheck;
47  
48      public NodeExistsDelegateTask(String name, String pathToCheck, Task ifTrue) {
49          this(name, pathToCheck, ifTrue, null);
50      }
51  
52      public NodeExistsDelegateTask(String name, String pathToCheck, Taskef="../../../../info/magnolia/module/delta/Task.html#Task">Task ifTrue, Task ifFalse) {
53          this(name, String.format("Execute task [%s] if node '%s' exists or [%s] if not.",
54                  ifTrue == null ? DO_NOTHING : ifTrue.getDescription(),
55                  pathToCheck,
56                  ifFalse == null ? DO_NOTHING : ifFalse.getDescription()),
57                  RepositoryConstants.CONFIG, pathToCheck, ifTrue, ifFalse);
58      }
59  
60      public NodeExistsDelegateTask(String name, String description, String workspaceName, String pathToCheck, Task ifTrue) {
61          this(name, description, workspaceName, pathToCheck, ifTrue, null);
62      }
63  
64      public NodeExistsDelegateTask(String name, String description, String workspaceName, String pathToCheck, Taskef="../../../../info/magnolia/module/delta/Task.html#Task">Task ifTrue, Task ifFalse) {
65          super(name, description, ifTrue, ifFalse);
66          this.pathToCheck = pathToCheck;
67          this.workspaceName = workspaceName;
68      }
69  
70      @Override
71      protected boolean condition(InstallContext ctx) {
72          try {
73              return ctx.getJCRSession(workspaceName).nodeExists(pathToCheck);
74          } catch (RepositoryException e) {
75              ctx.error("There was an error assessing if the node exists.", e);
76              return false;
77          }
78      }
79  }