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.context.MgnlContext;
37  
38  import javax.servlet.http.HttpServletRequest;
39  
40  import org.apache.commons.lang.StringUtils;
41  
42  
43  /**
44   * Voters which match the request headers against a pattern.
45   */
46  public abstract class RequestHeaderPatternVoter extends BasePatternVoter {
47  
48      private String headerName = StringUtils.EMPTY;
49  
50      public void setHeaderName(String headerName) {
51          this.headerName = headerName;
52      }
53  
54      public String getHeaderName() {
55          return headerName;
56      }
57  
58  
59      /**
60       * Retrieve the value of the specified header from the request.
61       */
62      protected String resolveRequestHeaderFromValue(Object value, String headerName){
63          HttpServletRequest request;
64  
65          if (value instanceof HttpServletRequest) {
66              request = (HttpServletRequest) value;
67          }
68          else {
69              if (MgnlContext.isWebContext()) {
70                  request = MgnlContext.getWebContext().getRequest();
71              }
72              else {
73                  return null;
74              }
75          }
76  
77          String headerValue = request.getHeader(headerName);
78          if (StringUtils.isEmpty(headerValue)) {
79              return null;
80          }
81          return headerValue;
82      }
83  
84  }