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