1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2000-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License ("CDDL") (collectively, the "License"). You may
9 * not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or mq/legal/LICENSE.txt. See the License for the specific language
12 * governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at mq/legal/LICENSE.txt. Sun designates
16 * this particular file as subject to the "Classpath" exception as provided by
17 * Sun in the GPL Version 2 section of the License file that accompanied this
18 * code. If applicable, add the following below the License Header, with the
19 * fields enclosed by brackets [] replaced by your own identifying information:
20 * "Portions Copyrighted [year] [name of copyright owner]"
21 *
22 * Contributor(s):
23 *
24 * If you wish your version of this file to be governed by only the CDDL or
25 * only the GPL Version 2, indicate your decision by adding "[Contributor]
26 * elects to include this software in this distribution under the [CDDL or GPL
27 * Version 2] license." If you don't indicate a single choice of license, a
28 * recipient has the option to distribute your version of this file under
29 * either the CDDL, the GPL Version 2 or to extend the choice of license to
30 * its licensees as provided above. However, if you add GPL Version 2 code
31 * and therefore, elected the GPL Version 2 license, then the option applies
32 * only if the new code is made subject to such option by the copyright holder.
33 */
34
35 /*
36 * @(#)ServerSessionPool.java 1.14 07/02/07
37 */
38
39 package javax.jms;
40
41 /** A <CODE>ServerSessionPool</CODE> object is an object implemented by an
42 * application server to provide a pool of <CODE>ServerSession</CODE> objects
43 * for processing the messages of a <CODE>ConnectionConsumer</CODE> (optional).
44 *
45 * <P>Its only method is <CODE>getServerSession</CODE>. The JMS API does not
46 * architect how the pool is implemented. It could be a static pool of
47 * <CODE>ServerSession</CODE> objects, or it could use a sophisticated
48 * algorithm to dynamically create <CODE>ServerSession</CODE> objects as
49 * needed.
50 *
51 * <P>If the <CODE>ServerSessionPool</CODE> is out of
52 * <CODE>ServerSession</CODE> objects, the <CODE>getServerSession</CODE> call
53 * may block. If a <CODE>ConnectionConsumer</CODE> is blocked, it cannot
54 * deliver new messages until a <CODE>ServerSession</CODE> is
55 * eventually returned.
56 *
57 * @see javax.jms.ServerSession
58 */
59
60 public interface ServerSessionPool {
61
62 /** Return a server session from the pool.
63 *
64 * @return a server session from the pool
65 *
66 * @exception JMSException if an application server fails to
67 * return a <CODE>ServerSession</CODE> out of its
68 * server session pool.
69 */
70
71 ServerSession
72 getServerSession() throws JMSException;
73 }
Save This Page