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;
58 import javax.servlet.http.HttpServletRequest;
59 import javax.servlet.http.HttpServletResponse;
60
61 import org.apache.turbine.util.RunData;
62 import org.apache.turbine.util.TurbineException;
63 import org.apache.turbine.services.Service;
64
65 /***
66 * The RunData Service provides the implementations for RunData and
67 * related interfaces required by request processing. It supports
68 * different configurations of implementations, which can be selected
69 * by specifying a configuration key. It may use pooling, in which case
70 * the implementations should implement the Recyclable interface.
71 *
72 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
73 * @version $Id: RunDataService.java,v 1.1.1.1 2001/08/16 05:09:13 jvanzyl Exp $
74 */
75 public interface RunDataService extends Service
76 {
77 /***
78 * The key under which this service is stored in TurbineServices.
79 */
80 public static final String SERVICE_NAME = "RunDataService";
81
82 /***
83 * The default configuration key.
84 */
85 public static final String DEFAULT_CONFIG = "default";
86
87 /***
88 * Gets a default RunData object.
89 *
90 * @param req a servlet request.
91 * @param res a servlet response.
92 * @param config a servlet config.
93 * @return a new or recycled RunData object.
94 * @throws TurbineException if the operation fails.
95 */
96 public RunData getRunData(HttpServletRequest req,
97 HttpServletResponse res,
98 ServletConfig config)
99 throws TurbineException;
100
101 /***
102 * Gets a RunData object from a specific configuration.
103 *
104 * @param key a configuration key.
105 * @param req a servlet request.
106 * @param res a servlet response.
107 * @param config a servlet config.
108 * @return a new or recycled RunData object.
109 * @throws TurbineException if the operation fails.
110 */
111 public RunData getRunData(String key,
112 HttpServletRequest req,
113 HttpServletResponse res,
114 ServletConfig config)
115 throws TurbineException;
116
117 /***
118 * Puts the used RunData object back to the factory for recycling.
119 *
120 * @param data the used RunData object.
121 * @return true, if pooling is supported and the object was accepted.
122 */
123 public boolean putRunData(RunData data);
124 }
This page was automatically generated by Maven