1 package org.apache.turbine.services.jsp;
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 org.apache.turbine.services.Service;
58 import org.apache.turbine.util.RunData;
59 import org.apache.turbine.util.TurbineException;
60
61
62 /***
63 * Implementations of the JspService interface.
64 *
65 * @author <a href="mailto:john.mcnally@clearink.com">John D. McNally</a>
66 */
67 public interface JspService extends Service
68 {
69 /*** The name used to specify this service in TurbineResources.properties */
70 public static final String SERVICE_NAME = "JspService";
71 /*** The key used to store an instance of RunData in the request */
72 public static final String RUNDATA = "rundata";
73 /*** The key used to store an instance of JspLink in the request */
74 public static final String LINK = "link";
75
76 /***
77 * Adds some useful objects to the request, so they are available to the JSP.
78 */
79 public void addDefaultObjects(RunData data);
80
81 /***
82 * executes the JSP given by templateName.
83 */
84 public void handleRequest(RunData data, String templateName, boolean isForward)
85 throws TurbineException;
86
87 /***
88 * executes the JSP given by templateName.
89 */
90 public void handleRequest(RunData data, String templateName)
91 throws TurbineException;
92
93 /***
94 * The buffer size
95 */
96 public int getDefaultBufferSize();
97
98 /***
99 * Searchs for a template in the default.template path[s] and
100 * returns the template name with a relative path which is required
101 * by <a href="http://java.sun.com/products/servlet/2.3/javadoc/javax/servlet/ServletContext.html#getRequestDispatcher(java.lang.String)">javax.servlet.RequestDispatcher</a>
102 *
103 * @param template The name of the template to search for.
104 * @return the template with a relative path
105 */
106 public String getRelativeTemplateName(String template);
107
108 }
This page was automatically generated by Maven