View Javadoc

1   /**
2    * This file Copyright (c) 2008-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.module.samples.filters;
35  
36  import info.magnolia.cms.filters.AbstractMgnlFilter;
37  
38  import javax.servlet.FilterChain;
39  import javax.servlet.ServletException;
40  import javax.servlet.http.HttpServletRequest;
41  import javax.servlet.http.HttpServletResponse;
42  import java.io.IOException;
43  
44  /**
45   * This is a very simple filter bootstrapped at setup using the file <code>mgnl-bootstrap/samples/config.server.filters.sample.xml
46   * (server/filters/sample)</code>.
47   * it defines bypass /.magnolia/ meaning the filter will only be executed for non admin pages
48   * @author tmiyar
49   *
50   */
51  public class SampleFilter extends AbstractMgnlFilter {
52      private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(SampleFilter.class);
53  
54      @Override
55      public void doFilter(HttpServletRequest req, HttpServletResponse res, FilterChain chain)  throws IOException, ServletException {
56          log.info("Executing sample filter");
57          req.setAttribute("sampleFilter", "attribute set by sample filter");
58          chain.doFilter(req, res);
59      }
60  
61  }