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 javax.jms;
23:
24: /** A <CODE>ServerSessionPool</CODE> object is an object implemented by an
25: * application server to provide a pool of <CODE>ServerSession</CODE> objects
26: * for processing the messages of a <CODE>ConnectionConsumer</CODE> (optional).
27: *
28: * <P>Its only method is <CODE>getServerSession</CODE>. The JMS API does not
29: * architect how the pool is implemented. It could be a static pool of
30: * <CODE>ServerSession</CODE> objects, or it could use a sophisticated
31: * algorithm to dynamically create <CODE>ServerSession</CODE> objects as
32: * needed.
33: *
34: * <P>If the <CODE>ServerSessionPool</CODE> is out of
35: * <CODE>ServerSession</CODE> objects, the <CODE>getServerSession</CODE> call
36: * may block. If a <CODE>ConnectionConsumer</CODE> is blocked, it cannot
37: * deliver new messages until a <CODE>ServerSession</CODE> is
38: * eventually returned.
39: *
40: * @see javax.jms.ServerSession
41: */
42:
43: public interface ServerSessionPool {
44:
45: /** Return a server session from the pool.
46: *
47: * @return a server session from the pool
48: *
49: * @exception JMSException if an application server fails to
50: * return a <CODE>ServerSession</CODE> out of its
51: * server session pool.
52: */
53:
54: ServerSession getServerSession() throws JMSException;
55: }
|