KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > ejb > InstancePool


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.ejb;
23
24
25 /**
26  * Defines the model for a EnterpriseContext instance pool.
27  *
28  * @author <a HREF="mailto:rickard.oberg@telkel.com">Rickard Öberg</a>
29  * @version $Revision: 37459 $
30  */
31 public interface InstancePool
32    extends ContainerPlugin
33 {
34    /**
35     * Get an instance without identity.
36     *
37     * <p>Can be used by finders and create-methods, or stateless beans
38     *
39     * @return Context/w instance
40     *
41     * @throws Exception RemoteException
42     */
43    EnterpriseContext get() throws Exception JavaDoc;
44
45    /**
46     * Return an anonymous instance after invocation.
47     *
48     * @param ctx The context to free.
49     */
50    void free(EnterpriseContext ctx);
51
52    /**
53     * Discard an anonymous instance after invocation.
54     * This is called if the instance should not be reused, perhaps due to some
55     * exception being thrown from it.
56     *
57     * @param ctx The context to discard.
58     */
59    void discard(EnterpriseContext ctx);
60
61    /**
62     * Return the size of the pool.
63     *
64     * @return the size of the pool.
65     */
66    int getCurrentSize();
67
68    /**
69     * Get the maximum size of the pool.
70     *
71     * @return the size of the pool.
72     */
73    public int getMaxSize();
74
75 }
76
77
Popular Tags