View Javadoc

1   /**
2    * This file Copyright (c) 2012 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.blossom.setup;
35  
36  import javax.jcr.Property;
37  import javax.jcr.RepositoryException;
38  import javax.jcr.Session;
39  
40  import org.apache.commons.lang.ArrayUtils;
41  
42  import info.magnolia.module.InstallContext;
43  import info.magnolia.module.delta.AbstractTask;
44  import info.magnolia.module.delta.TaskExecutionException;
45  
46  /**
47   * Conditionally changes a property if its current value is one of several expected values.
48   *
49   * @since 2.0
50   */
51  public class MultiCheckAndModifyPropertyValueTask extends AbstractTask {
52  
53      private final String nodePath;
54      private final String propertyName;
55      private final String[] expectedValues;
56      private final String newValue;
57  
58      public MultiCheckAndModifyPropertyValueTask(String name, String description, String nodePath, String propertyName, String[] expectedValues, String newValue) {
59          super(name, description);
60          this.nodePath = nodePath;
61          this.propertyName = propertyName;
62          this.newValue = newValue;
63          this.expectedValues = expectedValues;
64      }
65  
66      @Override
67      public void execute(InstallContext installContext) throws TaskExecutionException {
68          String propertyPath = nodePath + "/" + propertyName;
69          try {
70              Session session = installContext.getConfigJCRSession();
71              Property property = session.getProperty(propertyPath);
72              if (ArrayUtils.contains(expectedValues, property.getString())) {
73                  property.setValue(newValue);
74              }
75          } catch (RepositoryException e) {
76              installContext.error("Could not check property " + propertyPath + ", should be set to " + newValue, e);
77          }
78      }
79  }