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

This page was automatically generated by Maven