View Javadoc

1   /**
2    * This file Copyright (c) 2010-2011 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.cms.filters;
35  
36  import javax.servlet.http.HttpServletRequest;
37  import java.util.ArrayList;
38  import java.util.Collection;
39  import java.util.regex.Pattern;
40  
41  
42  /**
43   * A basic implementation which uses a request attribute to mark a request to a web container
44   * resource.
45   * @version $Id$
46   *
47   */
48  public class WebContainerResourcesImpl implements WebContainerResources {
49  
50      /**
51       * A request can be marked as requesting a web container resource by adding this attribute to the request.
52       */
53      public static final String WEB_CONTAINER_RESOURCE_MARKER_ATTRIBUTE = WebContainerResources.class.getName();
54  
55      private Mapping mapping = new Mapping();
56  
57      @Override
58      public boolean isWebContainerResource(HttpServletRequest request) {
59          boolean markerAttribute = request.getAttribute(WebContainerResourcesImpl.WEB_CONTAINER_RESOURCE_MARKER_ATTRIBUTE) != null;
60          return markerAttribute || mapping.match(request).isMatching();
61      }
62  
63      public Collection<String> getMappings() {
64          ArrayList<String> result = new ArrayList<String>();
65          for (Pattern pattern : mapping.getMappings()) {
66              result.add(pattern.pattern());
67          }
68          return result;
69      }
70  
71      public void setMappings(Collection<String> mappings) {
72          for (String mapping : mappings) {
73              this.mapping.addMapping(mapping);
74          }
75      }
76  
77      public void addMapping(String mapping){
78          this.mapping.addMapping(mapping);
79      }
80  }