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 static org.apache.commons.lang3.StringUtils.prependIfMissing;
37  
38  import info.magnolia.module.InstallContext;
39  
40  import javax.jcr.Node;
41  import javax.jcr.RepositoryException;
42  import javax.jcr.Session;
43  
44  /**
45   * A task that delegates to another if a checkNode is true, or to an optional other if it is false.
46   */
47  public abstract class CheckNodeDelegateTask extends ConditionalDelegateTask {
48      protected final String workspaceName;
49      protected final String nodePath;
50      protected final String propertyName;
51  
52      public CheckNodeDelegateTask(String taskName, String taskDescription, String workspaceName, String nodePath, String propertyName, Taskef="../../../../info/magnolia/module/delta/Task.html#Task">Task ifTrue, Task ifFalse) {
53          super(taskName, taskDescription, ifTrue, ifFalse);
54          this.workspaceName = workspaceName;
55          this.nodePath = nodePath;
56          this.propertyName = propertyName;
57      }
58  
59      @Override
60      protected boolean condition(InstallContext ctx) throws TaskExecutionException {
61          try {
62              final Session session = ctx.getJCRSession(workspaceName);
63              if (!session.nodeExists(prependIfMissing(nodePath, "/"))) {
64                  return false;
65              }
66  
67              final Node node = session.getNode(nodePath);
68              return checkNode(node, ctx);
69          } catch (RepositoryException e) {
70              throw new TaskExecutionException("Can't check for property " + propertyName + " in " + nodePath + ".", e);
71          }
72      }
73  
74      protected abstract boolean checkNode(Node node, InstallContext ctx) throws RepositoryException, TaskExecutionException;
75  }