javax.jms.ServerSessionPool Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.jms;
/** A {@code ServerSessionPool} object is an object implemented by an
* application server to provide a pool of {@code ServerSession} objects
* for processing the messages of a {@code ConnectionConsumer} (optional).
*
* Its only method is {@code getServerSession}. The JMS API does not
* architect how the pool is implemented. It could be a static pool of
* {@code ServerSession} objects, or it could use a sophisticated
* algorithm to dynamically create {@code ServerSession} objects as
* needed.
*
*
If the {@code ServerSessionPool} is out of
* {@code ServerSession} objects, the {@code getServerSession} call
* may block. If a {@code ConnectionConsumer} is blocked, it cannot
* deliver new messages until a {@code ServerSession} is
* eventually returned.
*
* @see javax.jms.ServerSession
*
* @version JMS 2.0
* @since JMS 1.0
*
*/
public interface ServerSessionPool {
/** Return a server session from the pool.
*
* @return a server session from the pool
*
* @exception JMSException if an application server fails to
* return a {@code ServerSession} out of its
* server session pool.
*/
ServerSession
getServerSession() throws JMSException;
}