1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 Tim Joyce
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * Tim Joyce <timj At paneris.org>
42 */
43
44 package org.melati.template.webmacro;
45
46 import org.melati.Melati;
47 import org.melati.servlet.TemplateServlet;
48 import org.melati.template.ServletTemplateContext;
49 import org.melati.util.MelatiConfigurationException;
50
51 import org.webmacro.servlet.WebContext;
52
53 /**
54 * Base class to use WebMacro (specifically) with Melati.
55 *
56 * Extend this class, overriding the {@link #handle(Melati, WebContext)} method.
57 *
58 * If you are agnostic as to what TemplateEngine to use then extend {@link TemplateServlet} directly.
59 *
60 * @author Tim Joyce
61 * $Revision$
62 */
63 public abstract class WebmacroMelatiServlet extends TemplateServlet {
64
65 /**
66 * Eclipse generated.
67 */
68 private static final long serialVersionUID = -7514187750618897237L;
69
70 protected String doTemplateRequest(Melati m, ServletTemplateContext c)
71 throws Exception {
72 if (!m.getTemplateEngine().getName().equals(WebmacroTemplateEngine.NAME))
73 throw new MelatiConfigurationException("Configured TemplateEngine ("+
74 m.getTemplateEngine().getName() + ") " +
75 "is not the required one (" + WebmacroTemplateEngine.NAME + ").");
76 return handle(m, (WebContext)c.getContext());
77 }
78
79 protected abstract String handle(Melati m, WebContext c)
80 throws Exception;
81
82 }
83
84
85
86
87
88
89
90