javax.jms.ServerSession Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 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 ServerSession object is an application server object that
* is used by a server to associate a thread with a JMS session (optional).
*
* A ServerSession implements two methods:
*
*
* getSession - returns the ServerSession's
* JMS session.
* start - starts the execution of the
* ServerSession
* thread and results in the execution of the JMS session's
* run method.
*
*
* A ConnectionConsumer implemented by a JMS provider uses a
* ServerSession to process one or more messages that have
* arrived. It does this by getting a ServerSession from the
* ConnectionConsumer's ServerSessionPool; getting
* the ServerSession's JMS session; loading it with the messages;
* and then starting the ServerSession.
*
*
In most cases the ServerSession will register some object
* it provides as the ServerSession's thread run object. The
* ServerSession's start method will call the
* thread's start method, which will start the new thread, and
* from it, call the run method of the
* ServerSession's run object. This object will do some
* housekeeping and then call the Session's run
* method. When run returns, the ServerSession's run
* object can return the ServerSession to the
* ServerSessionPool, and the cycle starts again.
*
*
Note that the JMS API does not architect how the
* ConnectionConsumer loads the Session with
* messages. Since both the ConnectionConsumer and
* Session are implemented by the same JMS provider, they can
* accomplish the load using a private mechanism.
*
* @version 1.0 - 9 March 1998
* @author Mark Hapner
* @author Rich Burridge
*
* @see javax.jms.ServerSessionPool
* @see javax.jms.ConnectionConsumer
*/
public interface ServerSession {
/** Return the ServerSession's Session. This must
* be a Session created by the same Connection
* that will be dispatching messages to it. The provider will assign one or
* more messages to the Session
* and then call start on the ServerSession.
*
* @return the server session's session
*
* @exception JMSException if the JMS provider fails to get the associated
* session for this ServerSession due
* to some internal error.
**/
Session
getSession() throws JMSException;
/** Cause the Session's run method to be called
* to process messages that were just assigned to it.
*
* @exception JMSException if the JMS provider fails to start the server
* session to process messages due to some internal
* error.
*/
void
start() throws JMSException;
}