1 package org.apache.turbine.services.pool;
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 org.apache.turbine.util.TurbineException;
58 import org.apache.turbine.util.pool.Recyclable;
59 import org.apache.turbine.services.factory.FactoryService;
60
61 /***
62 * The Pool Service extends the Factory Service by adding support
63 * for pooling instantiated objects. When a new instance is
64 * requested, the service first checks its pool if one is available.
65 * If the the pool is empty, a new object will be instantiated
66 * from the specified class. If only class name is given, the request
67 * to create an intance will be forwarded to the Factory Service.
68 *
69 * <p>For objects implementing the Recyclable interface, a recycle
70 * method will be called, when they are taken from the pool, and
71 * a dispose method, when they are returned to the pool.
72 *
73 * @author <a href="mailto:ilkka.priha@simsoft.fi">Ilkka Priha</a>
74 * @version $Id: PoolService.java,v 1.1.1.1 2001/08/16 05:09:09 jvanzyl Exp $
75 */
76 public interface PoolService extends FactoryService
77 {
78 /***
79 * The key under which this service is stored in TurbineServices.
80 */
81 public static final String SERVICE_NAME = "PoolService";
82
83 /***
84 * The default pool capacity.
85 */
86 public static final int DEFAULT_POOL_CAPACITY = 128;
87
88 /***
89 * Gets an instance of a specified class either from the pool
90 * or by instatiating from the class if the pool is empty.
91 *
92 * @param clazz the class.
93 * @return the instance.
94 * @throws TurbineException if recycling fails.
95 */
96 public Object getInstance(Class clazz)
97 throws TurbineException;
98
99 /***
100 * Gets an instance of a specified class either from the pool
101 * or by instatiating from the class if the pool is empty.
102 *
103 * @param clazz the class.
104 * @param params an array containing the parameters of the constructor.
105 * @param signature an array containing the signature of the constructor.
106 * @return the instance.
107 * @throws TurbineException if recycling fails.
108 */
109 public Object getInstance(Class clazz,
110 Object params[],
111 String signature[])
112 throws TurbineException;
113
114 /***
115 * Puts a used object back to the pool. Objects implementing
116 * the Recyclable interface can provide a recycle method to
117 * be called when they are reused and a dispose method to be
118 * called when they are returned to the pool.
119 *
120 * @param instance the object instance to recycle.
121 * @return true if the instance was accepted.
122 */
123 public boolean putInstance(Object instance);
124
125 /***
126 * Gets the capacity of the pool for a named class.
127 *
128 * @param className the name of the class.
129 */
130 public int getCapacity(String className);
131
132 /***
133 * Sets the capacity of the pool for a named class.
134 * Note that the pool will be cleared after the change.
135 *
136 * @param className the name of the class.
137 * @param capacity the new capacity.
138 */
139 public void setCapacity(String className,
140 int capacity);
141
142 /***
143 * Gets the current size of the pool for a named class.
144 *
145 * @param className the name of the class.
146 */
147 public int getSize(String className);
148
149 /***
150 * Clears instances of a named class from the pool.
151 *
152 * @param className the name of the class.
153 */
154 public void clearPool(String className);
155
156 /***
157 * Clears all instances from the pool.
158 */
159 public void clearPool();
160 }
This page was automatically generated by Maven