1 package org.apache.turbine.services.rundata;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 import javax.servlet.ServletConfig;
20
21 import javax.servlet.http.HttpServletRequest;
22 import javax.servlet.http.HttpServletResponse;
23 import javax.servlet.http.HttpSession;
24
25 import org.apache.turbine.util.RunData;
26 import org.apache.turbine.util.ServerData;
27 import org.apache.turbine.util.parser.CookieParser;
28 import org.apache.turbine.util.parser.ParameterParser;
29 import org.apache.turbine.util.pool.Recyclable;
30
31 /***
32 * TurbineRunData is an extension to the RunData interface to be
33 * implemented by RunData implementations to be distributed by
34 * the Turbine RunData Service. The extensions define methods
35 * that are used by the service for initilizing the implementation,
36 * but which are not meant to be called by the actual client objects.
37 *
38 * <p>TurbineRunData extends also the Recyclable interface making
39 * it possible to pool its implementations for recycling.
40 *
41 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
42 * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
43 * @author <a href="mailto:bhoeneis@ee.ethz.ch">Bernie Hoeneisen</a>
44 * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
45 * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
46 * @version $Id: TurbineRunData.java 264148 2005-08-29 14:21:04Z henning $
47 */
48 public interface TurbineRunData
49 extends RunData,
50 Recyclable
51 {
52 /***
53 * Gets the parameter parser without parsing the parameters.
54 *
55 * @return the parameter parser.
56 */
57 ParameterParser getParameterParser();
58
59 /***
60 * Sets the parameter parser.
61 *
62 * @param parser a parameter parser.
63 */
64 void setParameterParser(ParameterParser parser);
65
66 /***
67 * Gets the cookie parser without parsing the cookies.
68 *
69 * @return the cookie parser.
70 */
71 CookieParser getCookieParser();
72
73 /***
74 * Sets the cookie parser.
75 *
76 * @param parser a cookie parser.
77 */
78 void setCookieParser(CookieParser parser);
79
80 /***
81 * Sets the servlet request.
82 *
83 * @param req a request.
84 */
85 void setRequest(HttpServletRequest req);
86
87 /***
88 * Sets the servlet response.
89 *
90 * @param res a response.
91 */
92 void setResponse(HttpServletResponse res);
93
94 /***
95 * Sets the servlet session information.
96 *
97 * @param sess a session.
98 * @deprecated No replacement. This method no longer does anything.
99 */
100 void setSession(HttpSession sess);
101
102 /***
103 * Sets the servlet configuration used during servlet init.
104 *
105 * @param config a configuration.
106 */
107 void setServletConfig(ServletConfig config);
108
109 /***
110 * Sets the server data of the request.
111 *
112 * @param serverData server data.
113 */
114 void setServerData(ServerData serverData);
115 }