View Javadoc

1   /**
2    * This file Copyright (c) 2014 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 info.magnolia.cms.util.SimpleUrlPattern;
37  
38  import org.apache.commons.lang.StringUtils;
39  
40  
41  /**
42   * Checks if the specified request header matches a specific pattern.
43   * <p>
44   * Parameters (as Magnolia's configuration nodes):
45   * <ul>
46   * <li>pattern: a pattern compliant to {@link SimpleUrlPattern}
47   * <li>headerName: the name of the request header to evaluate.
48   * </ul>
49   */
50  public class RequestHeaderPatternSimpleVoter extends RequestHeaderPatternVoter {
51  
52      private SimpleUrlPattern pattern;
53  
54      @Override
55      protected boolean boolVote(Object value) {
56  
57          String headerValue = resolveRequestHeaderFromValue(value, getHeaderName());
58  
59          if (pattern == null || StringUtils.isEmpty(headerValue)) {
60              return false;
61          }
62  
63          return pattern.match(headerValue);
64      }
65  
66      @Override
67      public void setPattern(String pattern) {
68          super.setPattern(pattern);
69          this.pattern = new SimpleUrlPattern(pattern);
70      }
71  
72  }