1 /**
2 * This file Copyright (c) 2014-2015 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.voting.voters;
35
36 import javax.servlet.http.HttpServletRequest;
37
38 import org.apache.commons.lang3.StringUtils;
39
40 /**
41 * Voter that checks for a specific GET parameter and an optional value. If no value is specified the voter just checks
42 * for the existence of the parameter no matter what value is set.
43 *
44 * <p>Parameters (as Magnolia's configuration nodes):</p>
45 * <ul>
46 * <li>parameterName: the name of the parameter, e.g. <code>mgnlPreview</code> (required)</li>
47 * <li>parameterValue: the expected value (optional)</li>
48 * </ul>
49 */
50 public class RequestParametersVoter extends AbstractBoolVoter<HttpServletRequest> {
51
52 private String parameterName;
53 private String parameterValue;
54
55 @Override
56 protected boolean boolVote(HttpServletRequest request) {
57 if (StringUtils.isNotBlank(parameterName)) {
58 if (request.getParameter(parameterName) != null) {
59 if (parameterValue != null) {
60 return request.getParameter(parameterName).equals(parameterValue);
61 } else {
62 return true;
63 }
64 }
65 }
66
67 return false;
68 }
69
70 public String getParameterName() {
71 return parameterName;
72 }
73
74 public void setParameterName(String parameterName) {
75 this.parameterName = parameterName;
76 }
77
78 public String getParameterValue() {
79 return parameterValue;
80 }
81
82 public void setParameterValue(String parameterValue) {
83 this.parameterValue = parameterValue;
84 }
85
86 @Override
87 public String toString() {
88 return super.toString() + parameterName + (parameterValue != null ? "=" + parameterValue : "");
89 }
90
91 }