javax.jms.ServerSession Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
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.
*
* @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;
}