View Javadoc

1   /**
2    * This file Copyright (c) 2003-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.jcr.util.SessionUtil;
37  import info.magnolia.module.InstallContext;
38  
39  import java.util.Arrays;
40  import java.util.Collection;
41  
42  import javax.jcr.Node;
43  import javax.jcr.RepositoryException;
44  import javax.jcr.Session;
45  
46  
47  /**
48   * If the specified property (NodeData) has the expected value, then it will be replaced by the new value.
49   */
50  public class CheckAndModifyPropertyValueTask extends PropertyValuesTask {
51      private final String workspaceName;
52      private final String nodePath;
53      private final String propertyName;
54      private final Collection<String> expectedCurrentValues;
55      private final String newValue;
56  
57      public CheckAndModifyPropertyValueTask(String name, String description, String workspaceName, String nodePath, String propertyName, String expectedCurrentValue, String newValue) {
58          super(name, description);
59          this.workspaceName = workspaceName;
60          this.nodePath = nodePath;
61          this.propertyName = propertyName;
62          this.expectedCurrentValues = Arrays.asList(expectedCurrentValue);
63          this.newValue = newValue;
64      }
65  
66      public CheckAndModifyPropertyValueTask(String name, String description, String workspaceName, String nodePath, String propertyName, Collection<String> expectedCurrentValues, String newValue) {
67          super(name, description);
68          this.workspaceName = workspaceName;
69          this.nodePath = nodePath;
70          this.propertyName = propertyName;
71          this.expectedCurrentValues = expectedCurrentValues;
72          this.newValue = newValue;
73      }
74  
75      @Override
76      public void execute(InstallContext ctx) {
77          try {
78              final Session session = ctx.getJCRSession(workspaceName);
79              final Node node = SessionUtil.getNode(session, nodePath);
80              checkAndModifyPropertyValue(ctx, node, propertyName, expectedCurrentValues, newValue);
81          } catch (RepositoryException e) {
82              ctx.error(format("Could not check property {0} of node at {1}. Please create it with value {2}.", propertyName, nodePath, newValue), e);
83          }
84      }
85  }