org.objectweb.jonas_jms
Class JConnection

java.lang.Object
  |
  +--org.objectweb.jonas_jms.JConnection

All Implemented Interfaces:

javax.jms.Connection

Direct Known Subclasses:

JQueueConnection, JTopicConnection

public class JConnection

extends java.lang.Object

implements javax.jms.Connection

Common methods used in JQueueConnection and JTopicConnection.

Author:

Laurent Chauvirey, Frederic Maistre, Nicolas Tachker Contributor(s): Philippe Durieux Jeff Mesnil connection anonymous

Field Summary

protected boolean	closed
protected boolean	globaltx
protected static java.lang.String	INTERNAL_USER_NAME
protected JConnectionFactory	jcf
protected java.util.LinkedList	sessionlist
protected static javax.transaction.TransactionManager	tm
protected java.lang.String	user
protected javax.jms.Connection	xac

Constructor Summary

JConnection(JConnectionFactory jcf, java.lang.String user)
Constructor

Method Summary

void	close() When this method is invoked it should not return until message processing has been orderly shut down.
java.lang.String	getClientID() Get the client identifier for this connection.
javax.jms.ExceptionListener	getExceptionListener() Get the ExceptionListener for this Connection.
javax.jms.ConnectionMetaData	getMetaData() Get the meta data for this connection.
java.lang.String	getUser() Return the user associated to this connection
protected void	sessionClose(javax.jms.Session s) A non transacted session has beem closed
protected boolean	sessionOpen(javax.jms.Session s) A new non transacted session has been opened
void	setClientID(java.lang.String clientID) Set the client identifier for this connection.
void	setExceptionListener(javax.jms.ExceptionListener listener) Set an exception listener for this connection.
void	start() Start (or restart) a Connection's delivery of incoming messages.
void	stop() Used to temporarily stop a Connection's delivery of incoming messages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xac

protected javax.jms.Connection xac

closed

protected boolean closed

user

protected java.lang.String user

globaltx

protected boolean globaltx

tm

protected static javax.transaction.TransactionManager tm

jcf

protected JConnectionFactory jcf

sessionlist

protected java.util.LinkedList sessionlist

INTERNAL_USER_NAME

protected static final java.lang.String INTERNAL_USER_NAME

Constructor Detail

JConnection

public JConnection(JConnectionFactory jcf,
                   java.lang.String user)

Constructor

Method Detail

sessionOpen

protected boolean sessionOpen(javax.jms.Session s)

A new non transacted session has been opened

sessionClose

protected void sessionClose(javax.jms.Session s)

A non transacted session has beem closed

getUser

public java.lang.String getUser()

Return the user associated to this connection

close

public void close()
           throws javax.jms.JMSException

When this method is invoked it should not return until message processing has been orderly shut down. This means that all message listeners that may have been running have returned and that all pending receives have returned. A close terminates all pending message receives on the connection's sessions' consumers.

Specified by:

close in interface javax.jms.Connection

Throws:

javax.jms.JMSException - - if JMS implementation fails to return the client ID for this Connection due to some internal

getClientID

public java.lang.String getClientID()
                             throws javax.jms.JMSException

Get the client identifier for this connection. This value is JMS Provider specific. Either pre-configured by an administrator in a ConnectionFactory or assigned dynamically by the application by calling setClientID method.

Specified by:

getClientID in interface javax.jms.Connection

Returns:

the unique client identifier.

Throws:

javax.jms.JMSException - - if JMS implementation fails to return the client ID for this Connection due to some internal

setClientID

public void setClientID(java.lang.String clientID)
                 throws javax.jms.JMSException

Set the client identifier for this connection. If another connection with clientID is already running when this method is called, the JMS Provider should detect the duplicate id and throw InvalidClientIDException.

Specified by:

setClientID in interface javax.jms.Connection

Parameters:

clientID - - the unique client identifier

Throws:

javax.jms.JMSException - - general exception if JMS implementation fails to set the client ID for this Connection due to some internal error.

InvalidClientIDException - - if JMS client specifies an invalid or duplicate client id.

java.lang.IllegalStateException - - if attempting to set a connection's client identifier at the wrong time or when it has been administratively configured.

getMetaData

public javax.jms.ConnectionMetaData getMetaData()
                                         throws javax.jms.JMSException

Get the meta data for this connection.

Specified by:

getMetaData in interface javax.jms.Connection

Returns:

the connection meta data.

Throws:

javax.jms.JMSException - - general exception if JMS implementation fails to get the Connection meta-data for this Connection.

getExceptionListener

public javax.jms.ExceptionListener getExceptionListener()
                                                 throws javax.jms.JMSException

Get the ExceptionListener for this Connection.

Specified by:

getExceptionListener in interface javax.jms.Connection

Returns:

the ExceptionListener for this Connection.

Throws:

javax.jms.JMSException - - general exception if JMS implementation fails to get the Exception listener for this Connection.

setExceptionListener

public void setExceptionListener(javax.jms.ExceptionListener listener)
                          throws javax.jms.JMSException

Set an exception listener for this connection.

Specified by:

setExceptionListener in interface javax.jms.Connection

Parameters:

listener - - the exception listener.

Throws:

javax.jms.JMSException - - general exception if JMS implementation fails to set the Exception listener for this Connection.

start

public void start()
           throws javax.jms.JMSException

Start (or restart) a Connection's delivery of incoming messages.

Specified by:

start in interface javax.jms.Connection

Throws:

javax.jms.JMSException - - if JMS implementation fails to start the message delivery due to some internal error.

stop

public void stop()
          throws javax.jms.JMSException

Used to temporarily stop a Connection's delivery of incoming messages. It can be restarted using its start method. When stopped, delivery to all the Connection's message consumers is inhibited: synchronous receive's block and messages are not delivered to message listeners.

Specified by:

stop in interface javax.jms.Connection

Throws:

javax.jms.JMSException - - if JMS implementation fails to start the message delivery due to some internal error.