1 /**
2 * This file Copyright (c) 2003-2018 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 info.magnolia.context.Context;
37 import info.magnolia.context.MgnlContext;
38
39 import java.io.IOException;
40
41 import javax.servlet.FilterChain;
42 import javax.servlet.ServletException;
43 import javax.servlet.ServletRequest;
44 import javax.servlet.ServletResponse;
45 import javax.servlet.http.HttpServletRequest;
46 import javax.servlet.http.HttpServletResponse;
47
48 /**
49 * A base abstract class for filters that should not be executed more than once for each request.
50 */
51 public abstract class OncePerRequestAbstractMgnlFilter extends AbstractMgnlFilter {
52
53 private final String requestKeyName = "__" + getClass() + "@" + System.identityHashCode(this) + "_FILTERED";
54
55 @Override
56 public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
57
58 request.setAttribute(requestKeyName, Boolean.TRUE);
59 doFilter((HttpServletRequest) request, (HttpServletResponse) response, chain);
60 }
61
62 @Override
63 public boolean bypasses(HttpServletRequest request) {
64 return MgnlContext.getAttribute(requestKeyName, Context.LOCAL_SCOPE) != null || super.bypasses(request);
65 }
66 }