cgl.narada.jms
Class JmsSession

java.lang.Object
  extended by cgl.narada.jms.JmsSession
All Implemented Interfaces:
Runnable, Session
Direct Known Subclasses:
JmsTopicSession

public abstract class JmsSession
extends Object
implements Session

This class implements the Session defined in the JMS specification.


Field Summary
 
Fields inherited from interface javax.jms.Session
AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE
 
Constructor Summary
JmsSession()
           
 
Method Summary
 void close()
          Closes the session.
 void commit()
          Commits all messages done in this transaction and releases any locks currently held.
 BytesMessage createBytesMessage()
          Creates a BytesMessage object.
 MapMessage createMapMessage()
          Creates a MapMessage object.
 Message createMessage()
          Creates a Message object.
 ObjectMessage createObjectMessage()
          Creates an ObjectMessage object.
 ObjectMessage createObjectMessage(Serializable object)
          Creates an initialized ObjectMessage object.
 StreamMessage createStreamMessage()
          Creates a StreamMessage object.
 TextMessage createTextMessage()
          Creates a TextMessage object.
 TextMessage createTextMessage(String text)
          Creates an initialized TextMessage object.
 MessageListener getMessageListener()
          Returns the session's distinguished message listener (optional).
 boolean getTransacted()
          Indicates whether the session is in transacted mode.
 void recover()
          Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.
 void rollback()
          Rolls back any messages done in this transaction and releases any locks currently held.
 void run()
          Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.
 void setMessageListener(MessageListener listener)
          Sets the session's distinguished message listener (optional).
 void startSession()
           
 void stopSession()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JmsSession

public JmsSession()
Method Detail

createBytesMessage

public BytesMessage createBytesMessage()
                                throws JMSException
Creates a BytesMessage object. A BytesMessage object is used to send a message containing a stream of uninterpreted bytes.

Specified by:
createBytesMessage in interface Session
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

createMapMessage

public MapMessage createMapMessage()
                            throws JMSException
Creates a MapMessage object. A MapMessage 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 Session
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

createMessage

public Message createMessage()
                      throws JMSException
Creates a Message object. The Message interface is the root interface of all JMS messages. A Message object holds all the standard message header information. It can be sent when a message containing only header information is sufficient.

Specified by:
createMessage in interface Session
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

createObjectMessage

public ObjectMessage createObjectMessage()
                                  throws JMSException
Creates an ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.

Specified by:
createObjectMessage in interface Session
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

createObjectMessage

public ObjectMessage createObjectMessage(Serializable object)
                                  throws JMSException
Creates an initialized ObjectMessage object. An ObjectMessage object is used to send a message that contains a serializable Java object.

Specified by:
createObjectMessage in interface Session
Parameters:
object - the object to use to initialize this message
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

createStreamMessage

public StreamMessage createStreamMessage()
                                  throws 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 Session
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

createTextMessage

public TextMessage createTextMessage()
                              throws JMSException
Creates a TextMessage object. A TextMessage object is used to send a message containing a String object.

Specified by:
createTextMessage in interface Session
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

createTextMessage

public TextMessage createTextMessage(String text)
                              throws JMSException
Creates an initialized TextMessage object. A TextMessage object is used to send a message containing a String.

Specified by:
createTextMessage in interface Session
Parameters:
text - the string used to initialize this message
Throws:
JMSException - if the JMS provider fails to create this message due to some internal error.

getTransacted

public boolean getTransacted()
                      throws JMSException
Indicates whether the session is in transacted mode.

Specified by:
getTransacted in interface Session
Returns:
true if the session is in transacted mode
Throws:
JMSException - if the JMS provider fails to return the transaction mode due to some internal error.

commit

public void commit()
            throws JMSException
Commits all messages done in this transaction and releases any locks currently held.

Specified by:
commit in interface Session
Throws:
JMSException - if the JMS provider fails to commit the transaction due to some internal error.
TransactionRolledBackException - if the transaction is rolled back due to some internal error during commit.
IllegalStateException - if the method is not called by a transacted session.

rollback

public void rollback()
              throws JMSException
Rolls back any messages done in this transaction and releases any locks currently held.

Specified by:
rollback in interface Session
Throws:
JMSException - if the JMS provider fails to roll back the transaction due to some internal error.
IllegalStateException - if the method is not called by a transacted session.

close

public void close()
           throws JMSException
Closes the session.

Since a provider may allocate some resources on behalf of a session outside the JVM, clients should close the resources when they are not needed. Relying on garbage collection to eventually reclaim these resources may not be timely enough.

There is no need to close the producers and consumers of a closed session.

This call will block until a receive call or message listener in progress has completed. A blocked message consumer receive call returns null when this session is closed.

Closing a transacted session must roll back the transaction in progress.

This method is the only Session method that can be called concurrently.

Invoking any other Session method on a closed session must throw a JMSException.IllegalStateException. Closing a closed session must not throw an exception.

Specified by:
close in interface Session
Throws:
JMSException - if the JMS provider fails to close the session due to some internal error.

recover

public void recover()
             throws JMSException
Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.

All consumers deliver messages in a serial order. Acknowledging a received message automatically acknowledges all messages that have been delivered to the client.

Restarting a session causes it to take the following actions:

Specified by:
recover in interface Session
Throws:
JMSException - if the JMS provider fails to stop and restart message delivery due to some internal error.
IllegalStateException - if the method is called by a transacted session.

getMessageListener

public MessageListener getMessageListener()
                                   throws JMSException
Returns the session's distinguished message listener (optional).

Specified by:
getMessageListener in interface Session
Returns:
the message listener associated with this session
Throws:
JMSException - if the JMS provider fails to get the message listener due to an internal error.

setMessageListener

public void setMessageListener(MessageListener listener)
                        throws JMSException
Sets the session's distinguished message listener (optional).

When the distinguished message listener is set, no other form of message receipt in the session can be used; however, all forms of sending messages are still supported.

This is an expert facility not used by regular JMS clients.

Specified by:
setMessageListener in interface Session
Parameters:
listener - the message listener to associate with this session
Throws:
JMSException - if the JMS provider fails to set the message listener due to an internal error.

run

public void run()
Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.

Specified by:
run in interface Runnable
Specified by:
run in interface Session
See Also:
ServerSession

startSession

public void startSession()
                  throws JMSException
Throws:
JMSException

stopSession

public void stopSession()
                 throws JMSException
Throws:
JMSException


For comments and suggestions please send e-mail to The NaradaBrokering Project