01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * 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: * Defines the model for a EnterpriseContext instance pool.
26: *
27: * @author <a href="mailto:rickard.oberg@telkel.com">Rickard Öberg</a>
28: * @version $Revision: 57209 $
29: */
30: public interface InstancePool extends ContainerPlugin {
31: /**
32: * Get an instance without identity.
33: *
34: * <p>Can be used by finders and create-methods, or stateless beans
35: *
36: * @return Context/w instance
37: *
38: * @throws Exception RemoteException
39: */
40: EnterpriseContext get() throws Exception;
41:
42: /**
43: * Return an anonymous instance after invocation.
44: *
45: * @param ctx The context to free.
46: */
47: void free(EnterpriseContext ctx);
48:
49: /**
50: * Discard an anonymous instance after invocation.
51: * This is called if the instance should not be reused, perhaps due to some
52: * exception being thrown from it.
53: *
54: * @param ctx The context to discard.
55: */
56: void discard(EnterpriseContext ctx);
57:
58: /**
59: * Return the size of the pool.
60: *
61: * @return the size of the pool.
62: */
63: int getCurrentSize();
64:
65: /**
66: * Get the maximum size of the pool.
67: *
68: * @return the size of the pool.
69: */
70: public int getMaxSize();
71:
72: }
|