1 /**
2 * This file Copyright (c) 2003-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.commands.impl;
35
36 import info.magnolia.cms.util.Rule;
37 import info.magnolia.jcr.util.NodeTypes;
38
39 import org.apache.commons.lang3.StringUtils;
40
41 /**
42 * Base class for rule based commands.
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
53 * recursion).
54 */
55 private String itemTypes = NodeTypes.ContentNode.NAME;
56
57 private Rule rule;
58
59 public Rule getRule() {
60 if (rule == null) {
61 rule = getDefaultRule();
62 }
63 return rule;
64 }
65
66 protected Rule getDefaultRule() {
67 Ruleule.html#Rule">Rule rule = new Rule();
68 String[] nodeTypes = StringUtils.split(this.getItemTypes(), " ,");
69 for (int i = 0; i < nodeTypes.length; i++) {
70 String nodeType = nodeTypes[i];
71 rule.addAllowType(nodeType);
72 }
73 // magnolia resource and metadata must always be included
74 rule.addAllowType(NodeTypes.MetaData.NAME);
75 rule.addAllowType(NodeTypes.Resource.NAME);
76 return rule;
77 }
78
79 public String getItemTypes() {
80 return itemTypes;
81 }
82
83 public void setItemTypes(String nodeTypes) {
84 this.itemTypes = nodeTypes;
85 }
86
87 /**
88 * @param rule the Rule to set
89 */
90 public void setRule(Rule rule) {
91 this.rule = rule;
92 }
93
94 @Override
95 public void release() {
96 super.release();
97 this.itemTypes = NodeTypes.ContentNode.NAME;
98 this.rule = null;
99 }
100 }