KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > turbine > services > rundata > TurbineRunData


1 package org.apache.turbine.services.rundata;
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 javax.servlet.ServletConfig JavaDoc;
58 import javax.servlet.http.HttpServletRequest JavaDoc;
59 import javax.servlet.http.HttpServletResponse JavaDoc;
60 import javax.servlet.http.HttpSession JavaDoc;
61
62 import org.apache.fulcrum.parser.CookieParser;
63 import org.apache.fulcrum.parser.ParameterParser;
64 import org.apache.fulcrum.pool.Recyclable;
65 import org.apache.turbine.RunData;
66
67 /**
68  * TurbineRunData is an extension to the RunData interface to be
69  * implemented by RunData implementations to be distributed by
70  * the Turbine RunData Service. The extensions define methods
71  * that are used by the service for initilizing the implementation,
72  * but which are not meant to be called by the actual client objects.
73  *
74  * <p>TurbineRunData extends also the Recyclable interface making
75  * it possible to pool its implementations for recycling.
76  *
77  * @author <a HREF="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
78  * @author <a HREF="mailto:jon@latchkey.com">Jon S. Stevens</a>
79  * @author <a HREF="mailto:bhoeneis@ee.ethz.ch">Bernie Hoeneisen</a>
80  * @author <a HREF="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
81  * @version $Id: TurbineRunData.java,v 1.2 2004/11/12 10:26:23 epugh Exp $
82  */
83 public interface TurbineRunData
84     extends RunData,Recyclable
85 {
86     /**
87      * Gets the parameter parser without parsing the parameters.
88      *
89      * @return the parameter parser.
90      */
91     public ParameterParser getParameterParser();
92
93     /**
94      * Sets the parameter parser.
95      *
96      * @param parser a parameter parser.
97      */
98     public void setParameterParser(ParameterParser parser);
99
100     /**
101      * Gets the cookie parser without parsing the cookies.
102      *
103      * @return the cookie parser.
104      */
105     public CookieParser getCookieParser();
106
107     /**
108      * Sets the cookie parser.
109      *
110      * @param parser a cookie parser.
111      */
112     public void setCookieParser(CookieParser parser);
113
114     /**
115      * Sets the servlet request.
116      *
117      * @param req a request.
118      */
119     public void setRequest(HttpServletRequest JavaDoc req);
120
121     /**
122      * Sets the servlet response.
123      *
124      * @param res a response.
125      */
126     public void setResponse(HttpServletResponse JavaDoc res);
127
128     /**
129      * Sets the servlet session information.
130      *
131      * @param sess a session.
132      */
133     public void setSession(HttpSession JavaDoc sess);
134
135     /**
136      * Sets the servlet configuration used during servlet init.
137      *
138      * @param config a configuration.
139      */
140     public void setServletConfig(ServletConfig JavaDoc config);
141 }
142
Popular Tags