com.j_spaces.jms

Class GSSessionImpl

java.lang.Object

com.j_spaces.jms.GSSessionImpl

All Implemented Interfaces:

Runnable, javax.jms.QueueSession, javax.jms.Session, javax.jms.TopicSession

Direct Known Subclasses:

GSQueueSessionImpl, GSTopicSessionImpl, GSXASessionImpl

public class GSSessionImpl
extends Object
implements javax.jms.Session, javax.jms.TopicSession, javax.jms.QueueSession, Runnable

GigaSpaces implementation of the javax.jms.Session interface.

Limitations:
- Sessions support only a single MessageConsumer.
- Durable subscribers are not supported. - StreamMessage is not supported.

Version:

6.0

Author:

Gershon Diner, Shai Wolf

See Also:

Session

Field Summary

Fields

Modifier and Type	Field and Description
protected Transaction	_tx
protected Vector<GSQueueBrowserImpl>	m_browsers Maintains a list of m_browsers for the session.
protected boolean	m_closed true if the session is closed.
protected boolean	m_closing If true, indicates that the session is in the process of being closed
protected Map<String,GSMessageConsumerImpl>	m_consumers Maintains a list of m_consumers for the session.
protected boolean	m_isQueue
protected Vector<GSMessageProducerImpl>	m_producers Maintains a list of m_producers for the session.
protected boolean	m_stopped This flag determines whether message delivery is enabled or disabled.
protected LinkedList<GSMessageImpl>	sentMessages Holds the messages produced and sent by this session during a transaction.
static long	txLeaseTime
protected LinkedList<com.j_spaces.jms.GSSessionImpl.MessageQueueElement>	unackedMessages Holds the messages consumed consumers during a transaction and were not acked.

Fields inherited from interface javax.jms.Session

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Constructor Summary

Constructors

Constructor and Description
GSSessionImpl(com.j_spaces.jms.GSConnectionImpl conn, boolean isTransacted, int acknowledgeMode) Creates a session.

Method Summary

Modifier and Type	Method and Description
protected void	addBrowser(GSQueueBrowserImpl browser)
protected void	addConsumer(GSMessageConsumerImpl consumer)
protected void	addProducer(GSMessageProducerImpl producer)
void	close()
void	commit() Commits all messages done in this transaction and releases any locks currently held.
javax.jms.QueueBrowser	createBrowser(javax.jms.Queue queue)
javax.jms.QueueBrowser	createBrowser(javax.jms.Queue queue, String messageSelector)
javax.jms.BytesMessage	createBytesMessage() Creates a GSBytesMessageImpl object.
javax.jms.BytesMessage	createBytesMessage(byte[] bytesArrayBody) Creates a GSBytesMessageImpl object.
javax.jms.MessageConsumer	createConsumer(javax.jms.Destination destination)
javax.jms.MessageConsumer	createConsumer(javax.jms.Destination destination, String messageSelector)
javax.jms.MessageConsumer	createConsumer(javax.jms.Destination destination, String messageSelector, boolean noLocal)
javax.jms.TopicSubscriber	createDurableSubscriber(javax.jms.Topic topic, String name) Currently not supported.
javax.jms.TopicSubscriber	createDurableSubscriber(javax.jms.Topic topic, String name, String messageSelector, boolean noLocal) Currently not supported.
javax.jms.MapMessage	createMapMessage() Creates a GSMapMessageImpl object.
javax.jms.Message	createMessage()
javax.jms.ObjectMessage	createObjectMessage() Creates a GSObjectMessageImpl object.
javax.jms.ObjectMessage	createObjectMessage(Serializable object) Creates a GSObjectMessageImpl object.
javax.jms.MessageProducer	createProducer(javax.jms.Destination destination)
javax.jms.TopicPublisher	createPublisher(javax.jms.Topic topic)
javax.jms.Queue	createQueue(String queueName)
javax.jms.QueueReceiver	createReceiver(javax.jms.Queue queue)
javax.jms.QueueReceiver	createReceiver(javax.jms.Queue queue, String messageSelector)
javax.jms.QueueSender	createSender(javax.jms.Queue queue)
javax.jms.StreamMessage	createStreamMessage() Creates a StreamMessage object.
javax.jms.TopicSubscriber	createSubscriber(javax.jms.Topic topic)
javax.jms.TopicSubscriber	createSubscriber(javax.jms.Topic topic, String messageSelector, boolean noLocal)
javax.jms.TemporaryQueue	createTemporaryQueue() We use the same space proxy we obtained in the session and we write another External Entry, which will have a class name of 'TempQueue'.
javax.jms.TemporaryTopic	createTemporaryTopic() Creates a TemporaryTopic object.
javax.jms.TextMessage	createTextMessage() Creates an initialized TextMessage object.
javax.jms.TextMessage	createTextMessage(String text) Creates an initialized TextMessage object.
javax.jms.Topic	createTopic(String topicName)
protected void	ensureTX() Verifies that the session is under TX
int	getAcknowledgeMode() JMS 1.1 API
protected com.j_spaces.jms.GSConnectionImpl	getConn()
int	getConsumersC()
String	getJMSProviderName()
javax.jms.MessageListener	getMessageListener()
int	getMessagesC()
int	getNumOfConsumedMsg()
int	getNumOfProducedMsg()
int	getProducersC()
protected int	getRandomInt()
String	getSessionID()
boolean	getTransacted()
protected Transaction	getTransaction()
protected boolean	isClosed() Check if the session is closed
void	recover()
protected void	removeBrower(GSQueueBrowserImpl browser)
protected void	removeConsumer(GSMessageConsumerImpl consumer)
protected void	removeProducer(GSMessageProducerImpl producer)
void	rollback()
void	run()
void	setConsumersC(int i)
void	setMessageListener(javax.jms.MessageListener listener)
void	setMessagesC(int i)
void	setProducersC(int i)
void	setSessionID(String string)
String	toString()
void	unsubscribe(String subscriptionName) Currently not supported.

Methods inherited from class java.lang.Object

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

Field Detail

m_closed

protected volatile boolean m_closed

true if the session is closed.

m_closing

protected volatile boolean m_closing

If true, indicates that the session is in the process of being closed

m_stopped

protected volatile boolean m_stopped

This flag determines whether message delivery is enabled or disabled. Message delivery if disabled if the enclosing connection is stopped. If true then the session was started, else the session is stopped.

m_consumers

protected Map<String,GSMessageConsumerImpl> m_consumers

Maintains a list of m_consumers for the session.

m_producers

protected Vector<GSMessageProducerImpl> m_producers

Maintains a list of m_producers for the session.

m_browsers

protected Vector<GSQueueBrowserImpl> m_browsers

Maintains a list of m_browsers for the session.

_tx

protected Transaction _tx

txLeaseTime

public static final long txLeaseTime

See Also:

Constant Field Values

sentMessages

protected LinkedList<GSMessageImpl> sentMessages

Holds the messages produced and sent by this session during a transaction.

unackedMessages

protected LinkedList<com.j_spaces.jms.GSSessionImpl.MessageQueueElement> unackedMessages

Holds the messages consumed consumers during a transaction and were not acked.

m_isQueue

protected boolean m_isQueue

Constructor Detail

GSSessionImpl

public GSSessionImpl(com.j_spaces.jms.GSConnectionImpl conn,
                     boolean isTransacted,
                     int acknowledgeMode)
              throws javax.jms.JMSException

Creates a session.

Parameters:

conn - The connection the session belongs to.

isTransacted - true for a transacted session.

acknowledgeMode - 1 (auto), 2 (client) or 3 (dups ok).

Throws:

javax.jms.JMSException - In case of an invalid acknowledge mode.

Method Detail

getJMSProviderName

public String getJMSProviderName()

createBytesMessage

public javax.jms.BytesMessage createBytesMessage()
                                          throws javax.jms.JMSException

Creates a GSBytesMessageImpl object. A BytesMessage object is used to send a message containing a stream of uninterpreted bytes.

Specified by:

createBytesMessage in interface javax.jms.Session

Throws:

javax.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

javax.jms.IllegalStateException - If the session is closed.

See Also:

Session.createBytesMessage()

createBytesMessage

public javax.jms.BytesMessage createBytesMessage(byte[] bytesArrayBody)
                                          throws javax.jms.JMSException

Creates a GSBytesMessageImpl object. A BytesMessage object is used to send a message containing a stream of uninterpreted bytes. This method is used in MessageConsumer.recieve() when the JMSMessageID is known already.

Throws:

javax.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

javax.jms.IllegalStateException - If the session is closed.

See Also:

Session.createBytesMessage()

createMapMessage

public javax.jms.MapMessage createMapMessage()
                                      throws javax.jms.JMSException

Creates a GSMapMessageImpl object. A GSMapMessageImpl object is used to send a self-defining set of name-value pairs, where names are String objects and values are primitive values in the Java programming language.

Specified by:

createMapMessage in interface javax.jms.Session

Throws:

javax.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

javax.jms.IllegalStateException - If the session is closed.

See Also:

Session.createMapMessage()

createMessage

public javax.jms.Message createMessage()
                                throws javax.jms.JMSException

Specified by:

createMessage in interface javax.jms.Session

Throws:

javax.jms.IllegalStateException - If the session is closed.

javax.jms.JMSException

See Also:

Session.createMessage()

createObjectMessage

public javax.jms.ObjectMessage createObjectMessage()
                                            throws javax.jms.JMSException

Creates a GSObjectMessageImpl object. A GSObjectMessageImpl object is used to send a Serializable java object.

Specified by:

createObjectMessage in interface javax.jms.Session

Throws:

javax.jms.IllegalStateException - If the session is closed.

javax.jms.JMSException

See Also:

Session.createObjectMessage()

createObjectMessage

public javax.jms.ObjectMessage createObjectMessage(Serializable object)
                                            throws javax.jms.JMSException

Creates a GSObjectMessageImpl object. A GSObjectMessageImpl object is used to send a Serializable java object.

Specified by:

createObjectMessage in interface javax.jms.Session

Throws:

javax.jms.IllegalStateException - If the session is closed.

javax.jms.JMSException

See Also:

Session.createObjectMessage(Serializable)

createStreamMessage

public javax.jms.StreamMessage createStreamMessage()
                                            throws javax.jms.JMSException

Creates a StreamMessage object. A StreamMessage object is used to send a self-defining stream of primitive values in the Java programming language.

Specified by:

createStreamMessage in interface javax.jms.Session

Throws:

javax.jms.IllegalStateException - If the session is closed.

javax.jms.JMSException

See Also:

Session.createStreamMessage()

createTextMessage

public javax.jms.TextMessage createTextMessage()
                                        throws javax.jms.JMSException

Creates an initialized TextMessage object. A TextMessage object is used to send a message containing a String.

Specified by:

createTextMessage in interface javax.jms.Session

Throws:

javax.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

javax.jms.IllegalStateException - If the session is closed.

See Also:

Session.createTextMessage()

createTextMessage

public javax.jms.TextMessage createTextMessage(String text)
                                        throws javax.jms.JMSException

Creates an initialized TextMessage object. A TextMessage object is used to send a message containing a String.

Specified by:

createTextMessage in interface javax.jms.Session

Parameters:

text - the string used to initialize this message

Throws:

javax.jms.JMSException - if the JMS provider fails to create this message due to some internal error.

javax.jms.IllegalStateException - If the session is closed.

See Also:

Session.createTextMessage(String)

getTransacted

public boolean getTransacted()
                      throws javax.jms.JMSException

Specified by:

getTransacted in interface javax.jms.Session

Returns:

true if the session is transacted.

Throws:

javax.jms.JMSException

See Also:

Session.getTransacted()

getTransaction

protected Transaction getTransaction()

Returns:

m_tx Returns the session m_tx in case when transcated == true

getAcknowledgeMode

public int getAcknowledgeMode()
                       throws javax.jms.IllegalStateException

JMS 1.1 API

Specified by:

getAcknowledgeMode in interface javax.jms.Session

Returns:

m_acknowledgeMode

Throws:

javax.jms.IllegalStateException

See Also:

Session.getAcknowledgeMode()

commit

public void commit()
            throws javax.jms.JMSException

Commits all messages done in this transaction and releases any locks currently held.

Specified by:

commit in interface javax.jms.Session

Throws:

javax.jms.IllegalStateException - If the session is m_closed or it is NOT transacted

javax.jms.JMSException

See Also:

Session.commit()

rollback

public void rollback()
              throws javax.jms.JMSException

Specified by:

rollback in interface javax.jms.Session

Throws:

javax.jms.JMSException

recover

public void recover()
             throws javax.jms.JMSException

Specified by:

recover in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.recover()

close

public void close()
           throws javax.jms.JMSException

Specified by:

close in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.close()

ensureTX

protected void ensureTX()
                 throws javax.jms.IllegalStateException

Verifies that the session is under TX

Throws:

javax.jms.IllegalStateException - if the session is not under tx

getMessageListener

public javax.jms.MessageListener getMessageListener()
                                             throws javax.jms.JMSException

Specified by:

getMessageListener in interface javax.jms.Session

Throws:

javax.jms.JMSException

setMessageListener

public void setMessageListener(javax.jms.MessageListener listener)
                        throws javax.jms.JMSException

Specified by:

setMessageListener in interface javax.jms.Session

Throws:

javax.jms.JMSException

run

public void run()

Specified by:

run in interface Runnable

Specified by:

run in interface javax.jms.Session

createProducer

public javax.jms.MessageProducer createProducer(javax.jms.Destination destination)
                                         throws javax.jms.JMSException

Specified by:

createProducer in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createProducer(Destination)

createConsumer

public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination)
                                         throws javax.jms.JMSException

Specified by:

createConsumer in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createConsumer(Destination)

createConsumer

public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination,
                                                String messageSelector)
                                         throws javax.jms.JMSException

Specified by:

createConsumer in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createConsumer(Destination, String)

createConsumer

public javax.jms.MessageConsumer createConsumer(javax.jms.Destination destination,
                                                String messageSelector,
                                                boolean noLocal)
                                         throws javax.jms.JMSException

Specified by:

createConsumer in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createConsumer(Destination, String, boolean)

getSessionID

public String getSessionID()

Returns:

String m_sessionID

setSessionID

public void setSessionID(String string)

Parameters:

string -

getRandomInt

protected int getRandomInt()

getConsumersC

public int getConsumersC()

getMessagesC

public int getMessagesC()

getProducersC

public int getProducersC()

setConsumersC

public void setConsumersC(int i)

setMessagesC

public void setMessagesC(int i)

setProducersC

public void setProducersC(int i)

toString

public String toString()

Overrides:

toString in class Object

getNumOfConsumedMsg

public int getNumOfConsumedMsg()

Returns:

m_numOfConsumedMsg

getNumOfProducedMsg

public int getNumOfProducedMsg()

Returns:

m_numOfProducedMsg

addConsumer

protected void addConsumer(GSMessageConsumerImpl consumer)

removeConsumer

protected void removeConsumer(GSMessageConsumerImpl consumer)

addProducer

protected void addProducer(GSMessageProducerImpl producer)

removeProducer

protected void removeProducer(GSMessageProducerImpl producer)

isClosed

protected final boolean isClosed()

Check if the session is closed

Returns:

true if the session is m_closed

getConn

protected com.j_spaces.jms.GSConnectionImpl getConn()

Returns:

m_conn

unsubscribe

public void unsubscribe(String subscriptionName)
                 throws javax.jms.JMSException

Currently not supported.

Specified by:

unsubscribe in interface javax.jms.Session

Specified by:

unsubscribe in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

Session.unsubscribe(String)

createDurableSubscriber

public javax.jms.TopicSubscriber createDurableSubscriber(javax.jms.Topic topic,
                                                         String name,
                                                         String messageSelector,
                                                         boolean noLocal)
                                                  throws javax.jms.JMSException

Currently not supported.

Specified by:

createDurableSubscriber in interface javax.jms.Session

Specified by:

createDurableSubscriber in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

Session.createDurableSubscriber(Topic, String, String, boolean)

createDurableSubscriber

public javax.jms.TopicSubscriber createDurableSubscriber(javax.jms.Topic topic,
                                                         String name)
                                                  throws javax.jms.JMSException

Currently not supported.

Specified by:

createDurableSubscriber in interface javax.jms.Session

Specified by:

createDurableSubscriber in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

Session.createDurableSubscriber(Topic, String)

createTemporaryTopic

public javax.jms.TemporaryTopic createTemporaryTopic()
                                              throws javax.jms.JMSException

Creates a TemporaryTopic object. Its lifetime will be that of the TopicConnection unless it is deleted earlier. We use the same space proxy we obtained in the session and we write another External Entry, which will have a class name of 'TempQueue_ < >. The only message m_consumers that can consume from a temporary destination are those created by the same connection that created the destination. Any message producer can send to the temporary destination. If you close the connection that a temporary destination belongs to, the destination is closed and its contents lost. You can use temporary destinations to implement a simple request/reply mechanism. If you create a temporary destination and specify it as the value of the JMSReplyTo message header field when you send a message, the consumer of the message can use the value of the JMSReplyTo field as the destination to which it sends a reply and can also reference the original request by setting the JMSCorrelationID header field of the reply message to the value of the JMSMessageID header field of the request.

Specified by:

createTemporaryTopic in interface javax.jms.Session

Specified by:

createTemporaryTopic in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

Session.createTemporaryQueue()

createTopic

public javax.jms.Topic createTopic(String topicName)
                            throws javax.jms.JMSException

Specified by:

createTopic in interface javax.jms.Session

Specified by:

createTopic in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

Session.createTopic(String)

createQueue

public javax.jms.Queue createQueue(String queueName)
                            throws javax.jms.JMSException

Specified by:

createQueue in interface javax.jms.QueueSession

Specified by:

createQueue in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createQueue(String)

createBrowser

public javax.jms.QueueBrowser createBrowser(javax.jms.Queue queue)
                                     throws javax.jms.JMSException

Specified by:

createBrowser in interface javax.jms.QueueSession

Specified by:

createBrowser in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createBrowser(Queue)

createBrowser

public javax.jms.QueueBrowser createBrowser(javax.jms.Queue queue,
                                            String messageSelector)
                                     throws javax.jms.JMSException

Specified by:

createBrowser in interface javax.jms.QueueSession

Specified by:

createBrowser in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createBrowser(Queue, String)

addBrowser

protected void addBrowser(GSQueueBrowserImpl browser)

removeBrower

protected void removeBrower(GSQueueBrowserImpl browser)

createTemporaryQueue

public javax.jms.TemporaryQueue createTemporaryQueue()
                                              throws javax.jms.JMSException

We use the same space proxy we obtained in the session and we write another External Entry, which will have a class name of 'TempQueue'. The only message consumers that can consume from a temporary destination are those created by the same connection that created the destination. Any message producer can send to the temporary destination. If you close the connection that a temporary destination belongs to, the destination is closed and its contents lost. You can use temporary destinations to implement a simple request/reply mechanism. If you create a temporary destination and specify it as the value of the JMSReplyTo message header field when you send a message, the consumer of the message can use the value of the JMSReplyTo field as the destination to which it sends a reply and can also reference the original request by setting the JMSCorrelationID header field of the reply message to the value of the JMSMessageID header field of the request.

Specified by:

createTemporaryQueue in interface javax.jms.QueueSession

Specified by:

createTemporaryQueue in interface javax.jms.Session

Throws:

javax.jms.JMSException

See Also:

Session.createTemporaryQueue()

createPublisher

public javax.jms.TopicPublisher createPublisher(javax.jms.Topic topic)
                                         throws javax.jms.JMSException

Specified by:

createPublisher in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

TopicSession.createPublisher(Topic)

createSubscriber

public javax.jms.TopicSubscriber createSubscriber(javax.jms.Topic topic)
                                           throws javax.jms.JMSException

Specified by:

createSubscriber in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

TopicSession.createSubscriber(Topic)

createSubscriber

public javax.jms.TopicSubscriber createSubscriber(javax.jms.Topic topic,
                                                  String messageSelector,
                                                  boolean noLocal)
                                           throws javax.jms.JMSException

Specified by:

createSubscriber in interface javax.jms.TopicSession

Throws:

javax.jms.JMSException

See Also:

TopicSession.createSubscriber(Topic, String, boolean)

createReceiver

public javax.jms.QueueReceiver createReceiver(javax.jms.Queue queue)
                                       throws javax.jms.JMSException

Specified by:

createReceiver in interface javax.jms.QueueSession

Throws:

javax.jms.JMSException

See Also:

QueueSession.createReceiver(Queue)

createReceiver

public javax.jms.QueueReceiver createReceiver(javax.jms.Queue queue,
                                              String messageSelector)
                                       throws javax.jms.JMSException

Specified by:

createReceiver in interface javax.jms.QueueSession

Throws:

javax.jms.JMSException

See Also:

QueueSession.createReceiver(Queue, String)

createSender

public javax.jms.QueueSender createSender(javax.jms.Queue queue)
                                   throws javax.jms.JMSException

Specified by:

createSender in interface javax.jms.QueueSession

Throws:

javax.jms.JMSException

See Also:

QueueSession.createSender(Queue)