View Javadoc

1   /**
2    * This file Copyright (c) 2008-2013 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 java.util.ArrayList;
39  import java.util.List;
40  
41  import javax.servlet.http.HttpServletResponse;
42  
43  import org.apache.commons.lang.StringUtils;
44  
45  /**
46   * A voter which checks the content type set on the <strong>response</strong>
47   * object against a list of allowed and/or rejected content types.
48   *
49   * @author gjoseph
50   * @version $Revision: $ ($Author: $)
51   */
52  public class ResponseContentTypeVoter extends AbstractBoolVoter {
53      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(ResponseContentTypeVoter.class);
54  
55      private final List<String> allowed = new ArrayList<String>();
56      private final List<String> rejected = new ArrayList<String>();
57  
58      public List<String> getAllowed() {
59          return allowed;
60      }
61  
62      public void setAllowed(List<String> allowed) {
63          this.allowed.addAll(allowed);
64      }
65  
66      public void addAllowed(String contentType) {
67          allowed.add(contentType);
68      }
69  
70      public List<String> getRejected() {
71          return rejected;
72      }
73  
74      public void setRejected(List<String> rejected) {
75          this.rejected.addAll(rejected);
76      }
77  
78      public void addRejected(String contentType) {
79          rejected.add(contentType);
80      }
81  
82      @Override
83      protected boolean boolVote(Object value) {
84          final HttpServletResponse response;
85          if (value instanceof HttpServletResponse) {
86              response = (HttpServletResponse) value;
87          } else {
88              if (MgnlContext.isWebContext()) {
89                  response = MgnlContext.getWebContext().getResponse();
90              } else {
91                  return false;
92              }
93          }
94  
95          // strip the encoding off of the content type:
96          final String contentType = StringUtils.substringBefore(response.getContentType(), ";");
97          if (contentType == null) {
98              log.warn("No content type set on the response, can't vote.");
99              return false;
100         }
101         if (allowed.size() > 0 && !allowed.contains(contentType)) {
102             return false;
103         }
104         if (rejected.size() > 0 && rejected.contains(contentType)) {
105             return false;
106         }
107         return true;
108     }
109 }