01: package org.apache.turbine.services.rundata;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
20: */
21:
22: import javax.servlet.ServletConfig;
23:
24: import javax.servlet.http.HttpServletRequest;
25: import javax.servlet.http.HttpServletResponse;
26:
27: import org.apache.turbine.services.TurbineServices;
28:
29: import org.apache.turbine.util.RunData;
30: import org.apache.turbine.util.TurbineException;
31:
32: /**
33: * Static wrapper for the RunData service. The name is completely
34: * out of line of the other Turbine Services. So what? All the good
35: * ones were taken.
36: *
37: * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
38: * @version $Id: TurbineRunDataFacade.java 534527 2007-05-02 16:10:59Z tv $
39: */
40:
41: public abstract class TurbineRunDataFacade {
42: /**
43: * Utility method for accessing the service
44: * implementation
45: *
46: * @return a RunDataService implementation instance
47: */
48: public static RunDataService getService() {
49: return (RunDataService) TurbineServices.getInstance()
50: .getService(RunDataService.SERVICE_NAME);
51: }
52:
53: /**
54: * Gets a default RunData object.
55: *
56: * @param req a servlet request.
57: * @param res a servlet response.
58: * @param config a servlet config.
59: * @return a new or recycled RunData object.
60: * @throws TurbineException if the operation fails.
61: */
62: public static RunData getRunData(HttpServletRequest req,
63: HttpServletResponse res, ServletConfig config)
64: throws TurbineException {
65: return getService().getRunData(req, res, config);
66: }
67:
68: /**
69: * Gets a RunData object from a specific configuration.
70: *
71: * @param key a configuration key.
72: * @param req a servlet request.
73: * @param res a servlet response.
74: * @param config a servlet config.
75: * @return a new or recycled RunData object.
76: * @throws TurbineException if the operation fails.
77: */
78: public static RunData getRunData(String key,
79: HttpServletRequest req, HttpServletResponse res,
80: ServletConfig config) throws TurbineException {
81: return getService().getRunData(key, req, res, config);
82: }
83:
84: /**
85: * Puts the used RunData object back to the factory for recycling.
86: *
87: * @param data the used RunData object.
88: * @return true, if pooling is supported and the object was accepted.
89: */
90: public static boolean putRunData(RunData data) {
91: return getService().putRunData(data);
92: }
93: }
|