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.blossom.render;
35  
36  import java.io.IOException;
37  import java.util.Map;
38  import javax.servlet.ServletException;
39  import javax.servlet.http.HttpServletRequest;
40  import javax.servlet.http.HttpServletResponse;
41  
42  import info.magnolia.cms.util.ServletUtils;
43  import info.magnolia.context.MgnlContext;
44  import info.magnolia.context.WebContext;
45  import info.magnolia.module.blossom.template.BlossomRenderable;
46  import info.magnolia.rendering.context.RenderingContext;
47  import info.magnolia.rendering.engine.RenderException;
48  import info.magnolia.rendering.renderer.Renderer;
49  
50  /**
51   * Custom {@link info.magnolia.rendering.renderer.Renderer} that renders Blossom managed templates.
52   *
53   * @since 1.0
54   */
55  public class BlossomTemplateRenderer implements Renderer {
56  
57      @Override
58      public void render(RenderingContext ctx, Map<String, Object> contextObjects) throws RenderException {
59  
60          try {
61  
62              BlossomRenderable renderable = (BlossomRenderable) ctx.getRenderableDefinition();
63  
64              RenderContext context = RenderContext.push();
65              try {
66  
67                  context.setRenderingContext(ctx);
68                  context.setContextObjects(contextObjects);
69  
70                  WebContext webContext = MgnlContext.getWebContext();
71                  HttpServletRequest request = webContext.getRequest();
72                  HttpServletResponse response = webContext.getResponse();
73  
74                  // This is the same test used by the JspRenderer
75                  if (response.isCommitted() || (ServletUtils.isForward(request) || ServletUtils.isInclude(request))) {
76                      renderable.getDispatcher().include(renderable.getHandlerPath(), request, response);
77                  } else {
78                      renderable.getDispatcher().forward(renderable.getHandlerPath(), request, response);
79                  }
80  
81              } finally {
82                  RenderContext.pop();
83              }
84  
85          } catch (ServletException e) {
86              throw new RenderException(e);
87          } catch (IOException e) {
88              throw new RenderException(e);
89          }
90      }
91  }