View Javadoc

1   /**
2    * This file Copyright (c) 2010-2012 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.blossom.support;
35  
36  import java.io.IOException;
37  
38  import javax.servlet.RequestDispatcher;
39  import javax.servlet.ServletException;
40  import javax.servlet.ServletRequest;
41  import javax.servlet.ServletResponse;
42  import javax.servlet.http.HttpServletRequest;
43  
44  import org.springframework.web.util.WebUtils;
45  
46  /**
47   * Request wrapper that makes the request appear like an include.
48   *
49   * @since 1.2
50   */
51  public class IncludeRequestWrapper extends SpecialAttributeRequestWrapper {
52  
53      public IncludeRequestWrapper(HttpServletRequest request, String requestUri, String contextPath, String servletPath, Object pathInfo, String queryString) {
54          super(request);
55          setSpecialAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE, requestUri);
56          setSpecialAttribute(WebUtils.INCLUDE_CONTEXT_PATH_ATTRIBUTE, contextPath);
57          setSpecialAttribute(WebUtils.INCLUDE_SERVLET_PATH_ATTRIBUTE, servletPath);
58          setSpecialAttribute(WebUtils.INCLUDE_PATH_INFO_ATTRIBUTE, pathInfo);
59          setSpecialAttribute(WebUtils.INCLUDE_QUERY_STRING_ATTRIBUTE, queryString);
60      }
61  
62      @Override
63      public RequestDispatcher getRequestDispatcher(final String path) {
64  
65          if (!isEnabled()) {
66              return super.getRequestDispatcher(path);
67          }
68  
69          final RequestDispatcher dispatcher = super.getRequestDispatcher(path);
70  
71          return new RequestDispatcher() {
72  
73              @Override
74              public void forward(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
75                  dispatcher.forward(servletRequest, servletResponse);
76              }
77  
78              @Override
79              public void include(ServletRequest servletRequest, ServletResponse servletResponse) throws ServletException, IOException {
80                  setEnabled(false);
81                  try {
82                      dispatcher.include(servletRequest, servletResponse);
83                  } finally {
84                      setEnabled(true);
85                  }
86              }
87          };
88      }
89  }