View Javadoc
1   /**
2    * This file Copyright (c) 2011-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.rendering.engine;
35  
36  import info.magnolia.rendering.context.RenderingContext;
37  import info.magnolia.rendering.listeners.AbstractRenderingListener.RenderingListenerReturnCode;
38  import info.magnolia.rendering.template.RenderableDefinition;
39  
40  import java.util.Collection;
41  import java.util.Map;
42  
43  import javax.jcr.Node;
44  import javax.servlet.http.HttpServletResponse;
45  
46  /**
47   * The RenderingEngine is the main entry point for rendering content. It's main task is to prepare for rendering by
48   * setting up the {@link RenderingContext} and then calling on a {@link info.magnolia.rendering.renderer.Renderer} to
49   * do the actual rendering.
50   */
51  public interface RenderingEngine {
52  
53      /**
54       * Renders the content with its assigned template. Uses {@link info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment} to resolve the template assigned to the node.
55       *
56       * @param content the node to render
57       * @param out the OutputProvider to be used for output or null if the OutputProvider already set in RenderingContext should be used
58       */
59      void render(Node content, OutputProvider out) throws RenderException;
60  
61      /**
62       * Renders the content with its assigned template and exposes the given context objects to the template script. Uses {@link info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment} to resolve the template assigned
63       * to the node.
64       *
65       * @param content the node to render
66       * @param contextObjects objects to expose to the template script
67       * @param out the OutputProvider to be used for output or null if the OutputProvider already set in RenderingContext should be used
68       */
69      void render(Node content, Map<String, Object> contextObjects, OutputProvider out) throws RenderException;
70  
71      /**
72       * Uses a specific {@link RenderableDefinition} to render the content and exposes the given context objects to the
73       * template script.
74       *
75       * @param content the node to render
76       * @param contextObjects objects to expose to the template script
77       * @param out the OutputProvider to be used for output or null if the OutputProvider already set in RenderingContext should be used
78       */
79      void render(Node content, RenderableDefinition definition, Map<String, Object> contextObjects, OutputProvider out) throws RenderException;
80  
81      /**
82       * Returns the current {@link RenderingContext}.
83       * FIXME is this the right place? should we use IoC
84       */
85      public RenderingContext getRenderingContext();
86  
87      /**
88       * Inits listeners.
89       * Should be called per request.
90       */
91      public Collection<RenderingListenerReturnCode> initListeners(OutputProvider out, HttpServletResponse response);
92  
93      public Boolean getRenderEmptyAreas();
94  
95      public Boolean getAutoPopulateFromRequest();
96  
97      default Boolean getEscapeHtml() {
98          return true;
99      }
100 }