1 /**
2 * This file Copyright (c) 2003-2010 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;
35
36 import info.magnolia.cms.core.Content;
37
38 import java.io.IOException;
39 import java.io.Writer;
40
41 import javax.servlet.ServletException;
42 import javax.servlet.http.HttpServletRequest;
43 import javax.servlet.http.HttpServletResponse;
44
45
46 /**
47 * A TemplateRenderer implementation is responsible for generating the actual response from request data and a
48 * template. A typical jsp implementation will simply forward the request to the jsp through request dispatcher, but
49 * anybody is free to bind a specific implementation to a template type.
50 *
51 * @author Fabrizio Giustina
52 * @version $Revision: 35335 $ ($Author: gjoseph $)
53 */
54 public interface TemplateRenderer {
55
56 /**
57 * Generates the actual output using the selected template.
58 */
59 void renderTemplate(Content content, Template template, Writer out) throws RenderException, IOException;
60
61 /**
62 * @deprecated since 4.0
63 * @see #renderTemplate(info.magnolia.cms.core.Content, Template, java.io.Writer)
64 */
65 void renderTemplate(Template template, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException;
66 }