View Javadoc

1   /**
2    * This file Copyright (c) 2003-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.templating.renderers;
35  
36  import info.magnolia.module.templating.RenderableDefinition;
37  import info.magnolia.cms.core.Content;
38  import info.magnolia.cms.util.NodeMapWrapper;
39  import info.magnolia.context.MgnlContext;
40  import info.magnolia.context.WebContext;
41  import info.magnolia.module.templating.RenderException;
42  
43  import javax.servlet.http.HttpServletRequest;
44  import javax.servlet.http.HttpServletResponse;
45  
46  import java.io.Writer;
47  import java.util.Map;
48  
49  /**
50   * Simple jsp template renderer, mapped to template type <code>jsp</code>. The only valid attribute jsp templates is
51   * <code>path</code>, which specify the jsp/servlet path to forward to.
52   *
53   * @author Fabrizio Giustina
54   * @version $Revision: 41137 $ ($Author: gjoseph $)
55   */
56  public class JspTemplateRenderer extends AbstractTemplateRenderer {
57  
58      private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(JspTemplateRenderer.class);
59  
60      protected void onRender(Content content, RenderableDefinition definition, Writer out, Map ctx, String templatePath) throws RenderException {
61          HttpServletRequest request = ((WebContext) MgnlContext.getInstance()).getRequest();
62          HttpServletResponse response = ((WebContext) MgnlContext.getInstance()).getResponse();
63          if (response.isCommitted()) {
64              log.warn("Attempting to forward to {}, but response is already committed.", templatePath);
65          }
66  
67          // we can't do an include() because the called template might want to set cookies or call response.sendRedirect()
68          try {
69              request.getRequestDispatcher(templatePath).forward(request, response);
70          }
71          catch (Exception e) {
72              throw new RenderException("Can't render template " + templatePath, e);
73          }
74      }
75  
76      /**
77       * We expose nodes as Map instances in JSPs.
78       */
79      protected Content wrapNodeForTemplate(Content currentContent, Content mainContent) {
80          final Content wrapped = super.wrapNodeForTemplate(currentContent, mainContent);
81          return new NodeMapWrapper(wrapped, mainContent.getHandle());
82      }
83  
84      protected Map newContext() {
85          return MgnlContext.getWebContext("JspTemplateRenderer can only be used with a WebContext");
86      }
87  
88      protected String getPageAttributeName() {
89          return "actpage";
90      }
91  
92  
93  }