View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.admininterface.commands;
35  
36  import info.magnolia.cms.core.ItemType;
37  import info.magnolia.cms.util.Rule;
38  import org.apache.commons.lang.StringUtils;
39  
40  /**
41   * @author Sameer Charles
42   * $Id: RuleBasedCommand.java 32667 2010-03-13 00:37:06Z gjoseph $
43   */
44  public abstract class RuleBasedCommand extends BaseRepositoryCommand {
45  
46      /**
47       * You can pass a rule to the command (optional)
48       */
49      public static final String ATTRIBUTE_RULE = "rule";
50  
51      /**
52       * All subnodes of this types are activated imediately (without using the recursion)
53       */
54      private String itemTypes = ItemType.CONTENTNODE.getSystemName();
55  
56      private Rule rule;
57  
58      public Rule getRule() {
59          // lazy bound but only if this is a clone
60          if (rule == null && isClone()) {
61              rule = new Rule();
62              String[] nodeTypes = StringUtils.split(this.getItemTypes(), " ,");
63              for (int i = 0; i < nodeTypes.length; i++) {
64                  String nodeType = nodeTypes[i];
65                  rule.addAllowType(nodeType);
66              }
67  
68              // magnolia resource and metadata must always be included
69              rule.addAllowType(ItemType.NT_METADATA);
70              rule.addAllowType(ItemType.NT_RESOURCE);
71          }
72          return rule;
73      }
74  
75      public String getItemTypes() {
76          return itemTypes;
77      }
78  
79      public void setItemTypes(String nodeTypes) {
80          this.itemTypes = nodeTypes;
81      }
82  
83      /**
84       * @param rule the Rule to set
85       */
86      public void setRule(Rule rule) {
87          this.rule = rule;
88      }
89  
90      @Override
91      public void release() {
92          super.release();
93          this.itemTypes = ItemType.CONTENTNODE.getSystemName();
94          this.rule = null;
95      }
96  }