View Javadoc
1   /**
2    * This file Copyright (c) 2014-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  import org.slf4j.Logger;
42  import org.slf4j.LoggerFactory;
43  
44  /**
45   * Checks if multiple paths exist/do not exist before executing passed task.
46   */
47  public class PathExistenceDelegateTask extends ConditionalDelegateTask {
48  
49      private static final Logger log = LoggerFactory.getLogger(PathExistenceDelegateTask.class);
50  
51      private final String repository;
52      private final String[] pathsToCheckForExistence;
53      private final String[] pathsToCheckForNonExistence;
54  
55      public PathExistenceDelegateTask(String taskName, String taskDescription, String[] pathsToCheckForNonExistence, String[] pathsToCheckForExistence, Task ifTrue) {
56          this(taskName, taskDescription, RepositoryConstants.CONFIG, pathsToCheckForNonExistence, pathsToCheckForExistence, ifTrue);
57      }
58  
59      public PathExistenceDelegateTask(String taskName, String taskDescription, String repository, String[] pathsToCheckForNonExistence, String[] pathsToCheckForExistence, Task ifTrue) {
60          super(taskName, taskDescription, ifTrue);
61          this.repository = repository;
62          this.pathsToCheckForExistence = pathsToCheckForExistence;
63          this.pathsToCheckForNonExistence = pathsToCheckForNonExistence;
64      }
65  
66      @Override
67      protected boolean condition(InstallContext ctx) {
68          try {
69              if (pathsToCheckForNonExistence != null) {
70                  for (String pathToCheck : pathsToCheckForNonExistence) {
71                      if (ctx.getJCRSession(repository).nodeExists(pathToCheck)) {
72                          log.info("Expected path '{}' to not exist but it did. Not executing task.", pathToCheck);
73                          return false;
74                      }
75                  }
76              }
77              if (pathsToCheckForExistence != null) {
78                  for (String pathToCheck : pathsToCheckForExistence) {
79                      if (!ctx.getJCRSession(repository).nodeExists(pathToCheck)) {
80                          log.info("Expected path '{}' to exist but it did not. Not executing task.", pathToCheck);
81                          return false;
82                      }
83                  }
84              }
85          } catch (RepositoryException e) {
86              log.error("RepositoryException occurred checking provided conditions. Not executing task.", e);
87              return false;
88          }
89  
90          return true;
91      }
92  
93  }