1 package org.apache.turbine.services.velocity;
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 import java.io.OutputStream;
58 import java.io.Writer;
59 import org.apache.turbine.services.Service;
60 import org.apache.turbine.util.RunData;
61 import org.apache.turbine.util.TurbineException;
62 import org.apache.velocity.context.Context;
63
64 /***
65 * Implementations of the VelocityService interface.
66 *
67 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
68 * @author <a href="mailto:mbryson@mont.mindspring.com">Dave Bryson</a>
69 * @author <a href="mailto:jvanzyl@periapt.com">Jason van Zyl</a>
70 * @version $Id: VelocityService.java,v 1.3 2002/07/11 16:53:23 mpoeschl Exp $
71 */
72 public interface VelocityService extends Service
73 {
74 public static final String SERVICE_NAME = "VelocityService";
75 public static final String CONTEXT = "VELOCITY_CONTEXT";
76
77 /***
78 * Process the request and fill in the template with the values
79 * you set in the Context.
80 *
81 * @param context A Context.
82 * @param template A String with the filename of the template.
83 * @return The process template as a String.
84 * @exception Exception, a generic exception.
85 */
86 public String handleRequest(Context context, String template)
87 throws Exception;
88
89 /***
90 * Process the request and fill in the template with the values
91 * you set in the Context.
92 *
93 * @param context A Context.
94 * @param filename A String with the filename of the template.
95 * @param out A OutputStream where we will write the process template as
96 * a String.
97 * @throws TurbineException Any exception trown while processing will be
98 * wrapped into a TurbineException and rethrown.
99 */
100 public void handleRequest(Context context,
101 String filename,
102 OutputStream out)
103 throws TurbineException;
104
105 /***
106 * Process the request and fill in the template with the values
107 * you set in the Context.
108 *
109 * @param context A Context.
110 * @param filename A String with the filename of the template.
111 * @param writer A Writer where we will write the process template as
112 * a String.
113 * @throws TurbineException Any exception trown while processing will be
114 * wrapped into a TurbineException and rethrown.
115 */
116 public void handleRequest(Context context,
117 String filename,
118 Writer writer)
119 throws TurbineException;
120
121 /***
122 * Create an empty WebContext object.
123 *
124 * @return An empty WebContext object.
125 */
126 public Context getContext();
127
128 /***
129 * Create a Context from the RunData object. Adds a pointer to
130 * the RunData object to the Context so that RunData is available in
131 * the templates.
132 *
133 * @param data The Turbine RunData object.
134 * @return A clone of the Context needed by Velocity.
135 */
136 public Context getContext(RunData data);
137
138 /***
139 * Performs post-request actions (releases context
140 * tools back to the object pool).
141 *
142 * @param context a Velocity Context
143 */
144 public void requestFinished(Context context);
145
146 }
This page was automatically generated by Maven