001: package org.apache.turbine.services.rundata;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import javax.servlet.ServletConfig;
023:
024: import javax.servlet.http.HttpServletRequest;
025: import javax.servlet.http.HttpServletResponse;
026: import javax.servlet.http.HttpSession;
027:
028: import org.apache.turbine.util.RunData;
029: import org.apache.turbine.util.ServerData;
030: import org.apache.turbine.util.parser.CookieParser;
031: import org.apache.turbine.util.parser.ParameterParser;
032: import org.apache.turbine.util.pool.Recyclable;
033:
034: /**
035: * TurbineRunData is an extension to the RunData interface to be
036: * implemented by RunData implementations to be distributed by
037: * the Turbine RunData Service. The extensions define methods
038: * that are used by the service for initilizing the implementation,
039: * but which are not meant to be called by the actual client objects.
040: *
041: * <p>TurbineRunData extends also the Recyclable interface making
042: * it possible to pool its implementations for recycling.
043: *
044: * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
045: * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>
046: * @author <a href="mailto:bhoeneis@ee.ethz.ch">Bernie Hoeneisen</a>
047: * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
048: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
049: * @version $Id: TurbineRunData.java 534527 2007-05-02 16:10:59Z tv $
050: */
051: public interface TurbineRunData extends RunData, Recyclable {
052: /**
053: * Gets the parameter parser without parsing the parameters.
054: *
055: * @return the parameter parser.
056: */
057: ParameterParser getParameterParser();
058:
059: /**
060: * Sets the parameter parser.
061: *
062: * @param parser a parameter parser.
063: */
064: void setParameterParser(ParameterParser parser);
065:
066: /**
067: * Gets the cookie parser without parsing the cookies.
068: *
069: * @return the cookie parser.
070: */
071: CookieParser getCookieParser();
072:
073: /**
074: * Sets the cookie parser.
075: *
076: * @param parser a cookie parser.
077: */
078: void setCookieParser(CookieParser parser);
079:
080: /**
081: * Sets the servlet request.
082: *
083: * @param req a request.
084: */
085: void setRequest(HttpServletRequest req);
086:
087: /**
088: * Sets the servlet response.
089: *
090: * @param res a response.
091: */
092: void setResponse(HttpServletResponse res);
093:
094: /**
095: * Sets the servlet session information.
096: *
097: * @param sess a session.
098: * @deprecated No replacement. This method no longer does anything.
099: */
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: }
|