1 package org.apache.turbine.services.freemarker;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 // FreeMarker Stuff
58 import freemarker.template.SimpleHash;
59 import freemarker.template.Template;
60
61 // Java Classes
62 import java.io.IOException;
63
64 import javax.servlet.ServletRequest;
65
66 // Turbine Stuff
67 import org.apache.turbine.services.Service;
68
69 import org.apache.turbine.util.RunData;
70 import org.apache.turbine.util.TurbineException;
71
72 /***
73 * Implementations of the FreeMarkerService interface.
74 *
75 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
76 * @version $Id: FreeMarkerService.java,v 1.2 2002/06/07 21:22:45 henning Exp $
77 * @deprecated
78 */
79 public interface FreeMarkerService
80 extends Service
81 {
82 /***
83 * The name used to specify this service in
84 * TurbineResources.properties.
85 */
86 public static final String SERVICE_NAME = "FreeMarkerService";
87
88 /***
89 * The name used as a key in TurbineInfo when storing the
90 * Context.
91 */
92 public static final String CONTEXT = "FREEMARKER_CONTEXT";
93
94 /***
95 * Create a context needed by the FreeMarker template. This
96 * method just returns an SimpleHash with the request parameters
97 * copied into a model called request.
98 *
99 * @return SimpleHash which can be used as the model for a
100 * template.
101 */
102 public SimpleHash getContext();
103
104 /***
105 * Create a context needed by the FreeMarker template. This
106 * method just returns an SimpleHash with the request parameters
107 * copied into a model called request.
108 *
109 * @param req A ServletRequest.
110 * @return SimpleHash which can be used as the model for a
111 * template.
112 */
113 public SimpleHash getContext(ServletRequest req);
114
115 /***
116 * Create a context from the RunData object. Values found in
117 * RunData are copied into the modelRoot under similar names as
118 * they can be found in RunData. e.g. data.serverName,
119 * data.parameters.form_field_name
120 * data.acl.permissions.can_write_file. Some default links are
121 * also made available under links.
122 *
123 * @param data The Turbine RunData object.
124 * @return a SimpleHash populated with RunData data.
125 */
126 public SimpleHash getContext(RunData data);
127
128 /***
129 * Process the request and fill in the template with the values
130 * you set in the WebContext.
131 *
132 * @param context A SimpleHash with the context.
133 * @param templateName A String with the filename of the template.
134 * @param cache True if the parsed template should be cached.
135 * @return The processed template as a String.
136 * @throws TurbineException Any exception trown while processing will be
137 * wrapped into a TurbineException and rethrown.
138 */
139 public String handleRequest(SimpleHash context,
140 String templateName,
141 boolean cache)
142 throws TurbineException;
143
144 /***
145 * Gets the base path for the FreeMarker templates.
146 *
147 * @return The base path for the FreeMarker templates.
148 */
149 public String getBasePath();
150
151 /***
152 * Return a FreeMarker template. It will not be added to the
153 * cache.
154 *
155 * @param templateName A String with the name of the template.
156 * @return A Template.
157 * @exception IOException, if there was an I/O problem.
158 */
159 public Template getNonCachedTemplate(String templateName)
160 throws IOException;
161
162 /***
163 * Return a FreeMarker template from the cache. If the template
164 * has not been cached yet, it will be added to the cache.
165 *
166 * @param templateName A String with the name of the template.
167 * @return A Template.
168 */
169 public Template getCachedTemplate(String templateName);
170 }
This page was automatically generated by Maven