net.sf.dropboxmq.sessions
Class SessionImpl

java.lang.Object
  net.sf.dropboxmq.sessions.SessionImpl

All Implemented Interfaces:

Runnable, Session

Direct Known Subclasses:

QueueSessionImpl, TopicSessionImpl

public class SessionImpl
extends Object
implements Session

Created: 10 Mar 2006

Version:

$Revision: 231 $, $Date: 2011-08-12 21:50:47 -0600 (Fri, 12 Aug 2011) $

Author:

Dwayne Schultz

Field Summary

Fields inherited from interface javax.jms.Session

AUTO_ACKNOWLEDGE, CLIENT_ACKNOWLEDGE, DUPS_OK_ACKNOWLEDGE, SESSION_TRANSACTED

Constructor Summary

SessionImpl(DropboxTransaction dropboxTransaction, ConnectionImpl connection, Configuration configuration)

SessionImpl(SessionImpl realSession)

Method Summary

void	acknowledge(File readMessageFile)
protected void	addMessageConsumer(MessageConsumerImpl messageConsumer)
(package private) void	checkClosed()
void	close() Closes the session.
void	commit() Commits all messages done in this transaction and releases any locks currently held.
QueueBrowser	createBrowser(Queue queue) Creates a QueueBrowser object to peek at the messages on the specified queue.
QueueBrowser	createBrowser(Queue queue, String messageSelector) Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.
BytesMessage	createBytesMessage() Creates a BytesMessage object.
MessageConsumer	createConsumer(Destination destination) Creates a MessageConsumer for the specified destination.
MessageConsumer	createConsumer(Destination destination, String messageSelector) Creates a MessageConsumer for the specified destination, using a message selector.
MessageConsumer	createConsumer(Destination destination, String messageSelector, boolean noLocal) Creates MessageConsumer for the specified destination, using a message selector.
TopicSubscriber	createDurableSubscriber(Topic topic, String name) Creates a durable subscriber to the specified topic.
TopicSubscriber	createDurableSubscriber(Topic topic, String name, String messageSelector, boolean noLocal) Creates a durable subscriber to the specified topic, using a message selector and specifying whether messages published by its own connection should be delivered to it.
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.
MessageProducer	createProducer(Destination destination) Creates a MessageProducer to send messages to the specified destination.
Queue	createQueue(String queueName) Creates a queue identity given a Queue name.
StreamMessage	createStreamMessage() Creates a StreamMessage object.
TemporaryQueue	createTemporaryQueue() Creates a TemporaryQueue object.
TemporaryTopic	createTemporaryTopic() Creates a TemporaryTopic object.
TextMessage	createTextMessage() Creates a TextMessage object.
TextMessage	createTextMessage(String text) Creates an initialized TextMessage object.
Topic	createTopic(String topicName) Creates a topic identity given a Topic name.
int	getAcknowledgeMode() Returns the acknowledgement mode of the session.
static String	getAcknowledgeModeString(int acknowledgeMode)
Configuration	getConfiguration()
ConnectionImpl	getConnection()
DropboxTransaction	getDropboxTransaction()
MessageListener	getMessageListener() Returns the session's distinguished message listener (optional).
String	getNewID()
boolean	getTransacted() Indicates whether the session is in transacted mode.
Dropbox	newDropbox(DestinationImpl destination, String messageSelector, String subscriptionName, boolean noLocal)
void	recover() Stops message delivery in this session, and restarts message delivery with the oldest unacknowledged message.
void	removeMessageConsumer(MessageConsumerImpl messageConsumer)
void	rollback() Rolls back any messages done in this transaction and releases any locks currently held.
void	rollbackReparentingFromChild()
void	run() Optional operation, intended to be used only by Application Servers, not by ordinary JMS clients.
void	setEndpointConsumer(EndpointConsumer endpointConsumer)
void	setMessageListener(MessageListener listener) Sets the session's distinguished message listener (optional).
void	start()
void	startReparentingMessageToChild(MessageImpl message)
void	stop()
protected String	toObjectString()
String	toString()
void	unsubscribe(String name) Unsubscribes a durable subscription that has been created by a client.

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionImpl

public SessionImpl(SessionImpl realSession)

SessionImpl

public SessionImpl(DropboxTransaction dropboxTransaction,
                   ConnectionImpl connection,
                   Configuration configuration)

Method Detail

getAcknowledgeModeString

public static String getAcknowledgeModeString(int acknowledgeMode)

createBytesMessage

public BytesMessage createBytesMessage()
                                throws JMSException

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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.

getAcknowledgeMode

public int getAcknowledgeMode()
                       throws JMSException

Description copied from interface: javax.jms.Session

Returns the acknowledgement mode of the session. The acknowledgement mode is set at the time that the session is created. If the session is transacted, the acknowledgement mode is ignored.

Specified by:

getAcknowledgeMode in interface Session

Returns:

If the session is not transacted, returns the current acknowledgement mode for the session. If the session is transacted, returns SESSION_TRANSACTED.

Throws:

JMSException - if the JMS provider fails to return the acknowledgment mode due to some internal error.

See Also:

Connection.createSession(boolean, int)

commit

public void commit()
            throws JMSException

Description copied from interface: javax.jms.Session

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.

IllegalStateException - if the method is not called by a transacted session.

rollback

public void rollback()
              throws JMSException

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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

Description copied from interface: javax.jms.Session

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:

• Stop message delivery
• Mark all messages that might have been delivered but not acknowledged as "redelivered"
• Restart the delivery sequence including all unacknowledged messages that had been previously delivered. Redelivered messages do not have to be delivered in exactly their original delivery order.

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

Description copied from interface: javax.jms.Session

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.

See Also:

Session.setMessageListener(javax.jms.MessageListener), ServerSessionPool, ServerSession

setMessageListener

public void setMessageListener(MessageListener listener)
                        throws JMSException

Description copied from interface: javax.jms.Session

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.

See Also:

Session.getMessageListener(), ServerSessionPool, ServerSession

run

public void run()

Description copied from interface: javax.jms.Session

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

createProducer

public MessageProducer createProducer(Destination destination)
                               throws JMSException

Description copied from interface: javax.jms.Session

Creates a MessageProducer to send messages to the specified destination.

A client uses a MessageProducer object to send messages to a destination. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageProducer object.

Specified by:

createProducer in interface Session

Parameters:

destination - the Destination to send to, or null if this is a producer which does not have a specified destination.

Throws:

JMSException - if the session fails to create a MessageProducer due to some internal error.

createConsumer

public MessageConsumer createConsumer(Destination destination)
                               throws JMSException

Description copied from interface: javax.jms.Session

Creates a MessageConsumer for the specified destination. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.

Specified by:

createConsumer in interface Session

Parameters:

destination - the Destination to access.

Throws:

JMSException - if the session fails to create a consumer due to some internal error.

createConsumer

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

Description copied from interface: javax.jms.Session

Creates a MessageConsumer for the specified destination, using a message selector. Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.

A client uses a MessageConsumer object to receive messages that have been sent to a destination.

Specified by:

createConsumer in interface Session

Parameters:

destination - the Destination to access

messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

Throws:

JMSException - if the session fails to create a MessageConsumer due to some internal error.

InvalidSelectorException - if the message selector is invalid.

createConsumer

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

Description copied from interface: javax.jms.Session

Creates MessageConsumer for the specified destination, using a message selector. This method can specify whether messages published by its own connection should be delivered to it, if the destination is a topic.

Since Queue and Topic both inherit from Destination, they can be used in the destination parameter to create a MessageConsumer.

A client uses a MessageConsumer object to receive messages that have been published to a destination.

In some cases, a connection may both publish and subscribe to a topic. The consumer NoLocal attribute allows a consumer to inhibit the delivery of messages published by its own connection. The default value for this attribute is False. The noLocal value must be supported by destinations that are topics.

Specified by:

createConsumer in interface Session

Parameters:

destination - the Destination to access

messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

noLocal - - if true, and the destination is a topic, inhibits the delivery of messages published by its own connection. The behavior for NoLocal is not specified if the destination is a queue.

Throws:

JMSException - if the session fails to create a MessageConsumer due to some internal error.

InvalidSelectorException - if the message selector is invalid.

createQueue

public Queue createQueue(String queueName)
                  throws JMSException

Description copied from interface: javax.jms.Session

Creates a queue identity given a Queue name.

This facility is provided for the rare cases where clients need to dynamically manipulate queue identity. It allows the creation of a queue identity with a provider-specific name. Clients that depend on this ability are not portable.

Note that this method is not for creating the physical queue. The physical creation of queues is an administrative task and is not to be initiated by the JMS API. The one exception is the creation of temporary queues, which is accomplished with the createTemporaryQueue method.

Specified by:

createQueue in interface Session

Parameters:

queueName - the name of this Queue

Returns:

a Queue with the given name

Throws:

JMSException - if the session fails to create a queue due to some internal error.

createTopic

public Topic createTopic(String topicName)
                  throws JMSException

Description copied from interface: javax.jms.Session

Creates a topic identity given a Topic name.

This facility is provided for the rare cases where clients need to dynamically manipulate topic identity. This allows the creation of a topic identity with a provider-specific name. Clients that depend on this ability are not portable.

Note that this method is not for creating the physical topic. The physical creation of topics is an administrative task and is not to be initiated by the JMS API. The one exception is the creation of temporary topics, which is accomplished with the createTemporaryTopic method.

Specified by:

createTopic in interface Session

Parameters:

topicName - the name of this Topic

Returns:

a Topic with the given name

Throws:

JMSException - if the session fails to create a topic due to some internal error.

createDurableSubscriber

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

Description copied from interface: javax.jms.Session

Creates a durable subscriber to the specified topic.

If a client needs to receive all the messages published on a topic, including the ones published while the subscriber is inactive, it uses a durable TopicSubscriber. The JMS provider retains a record of this durable subscription and insures that all messages from the topic's publishers are retained until they are acknowledged by this durable subscriber or they have expired.

Sessions with durable subscribers must always provide the same client identifier. In addition, each client must specify a name that uniquely identifies (within client identifier) each durable subscription it creates. Only one session at a time can have a TopicSubscriber for a particular durable subscription.

A client can change an existing durable subscription by creating a durable TopicSubscriber with the same name and a new topic and/or message selector. Changing a durable subscriber is equivalent to unsubscribing (deleting) the old one and creating a new one.

In some cases, a connection may both publish and subscribe to a topic. The subscriber NoLocal attribute allows a subscriber to inhibit the delivery of messages published by its own connection. The default value for this attribute is false.

Specified by:

createDurableSubscriber in interface Session

Parameters:

topic - the non-temporary Topic to subscribe to

name - the name used to identify this subscription

Throws:

JMSException - if the session fails to create a subscriber due to some internal error.

createDurableSubscriber

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

Description copied from interface: javax.jms.Session

Creates a durable subscriber to the specified topic, using a message selector and specifying whether messages published by its own connection should be delivered to it.

If a client needs to receive all the messages published on a topic, including the ones published while the subscriber is inactive, it uses a durable TopicSubscriber. The JMS provider retains a record of this durable subscription and insures that all messages from the topic's publishers are retained until they are acknowledged by this durable subscriber or they have expired.

Sessions with durable subscribers must always provide the same client identifier. In addition, each client must specify a name which uniquely identifies (within client identifier) each durable subscription it creates. Only one session at a time can have a TopicSubscriber for a particular durable subscription. An inactive durable subscriber is one that exists but does not currently have a message consumer associated with it.

A client can change an existing durable subscription by creating a durable TopicSubscriber with the same name and a new topic and/or message selector. Changing a durable subscriber is equivalent to unsubscribing (deleting) the old one and creating a new one.

Specified by:

createDurableSubscriber in interface Session

Parameters:

topic - the non-temporary Topic to subscribe to

name - the name used to identify this subscription

messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

noLocal - if set, inhibits the delivery of messages published by its own connection

Throws:

JMSException - if the session fails to create a subscriber due to some internal error.

InvalidSelectorException - if the message selector is invalid.

createBrowser

public QueueBrowser createBrowser(Queue queue)
                           throws JMSException

Description copied from interface: javax.jms.Session

Creates a QueueBrowser object to peek at the messages on the specified queue.

Specified by:

createBrowser in interface Session

Parameters:

queue - the queue to access

Throws:

JMSException - if the session fails to create a browser due to some internal error.

createBrowser

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

Description copied from interface: javax.jms.Session

Creates a QueueBrowser object to peek at the messages on the specified queue using a message selector.

Specified by:

createBrowser in interface Session

Parameters:

queue - the queue to access

messageSelector - only messages with properties matching the message selector expression are delivered. A value of null or an empty string indicates that there is no message selector for the message consumer.

Throws:

JMSException - if the session fails to create a browser due to some internal error.

InvalidSelectorException - if the message selector is invalid.

createTemporaryQueue

public TemporaryQueue createTemporaryQueue()
                                    throws JMSException

Description copied from interface: javax.jms.Session

Creates a TemporaryQueue object. Its lifetime will be that of the Connection unless it is deleted earlier.

Specified by:

createTemporaryQueue in interface Session

Returns:

a temporary queue identity

Throws:

JMSException - if the session fails to create a temporary queue due to some internal error.

createTemporaryTopic

public TemporaryTopic createTemporaryTopic()
                                    throws JMSException

Description copied from interface: javax.jms.Session

Creates a TemporaryTopic object. Its lifetime will be that of the Connection unless it is deleted earlier.

Specified by:

createTemporaryTopic in interface Session

Returns:

a temporary topic identity

Throws:

JMSException - if the session fails to create a temporary topic due to some internal error.

unsubscribe

public void unsubscribe(String name)
                 throws JMSException

Description copied from interface: javax.jms.Session

Unsubscribes a durable subscription that has been created by a client.

This method deletes the state being maintained on behalf of the subscriber by its provider.

It is erroneous for a client to delete a durable subscription while there is an active MessageConsumer or TopicSubscriber for the subscription, or while a consumed message is part of a pending transaction or has not been acknowledged in the session.

Specified by:

unsubscribe in interface Session

Parameters:

name - the name used to identify this subscription

Throws:

JMSException - if the session fails to unsubscribe to the durable subscription due to some internal error.

acknowledge

public void acknowledge(File readMessageFile)
                 throws JMSException

Throws:

JMSException

start

public void start()
           throws JMSException

Throws:

JMSException

stop

public void stop()
          throws JMSException

Throws:

JMSException

getConnection

public ConnectionImpl getConnection()

getDropboxTransaction

public final DropboxTransaction getDropboxTransaction()

getNewID

public String getNewID()

newDropbox

public Dropbox newDropbox(DestinationImpl destination,
                          String messageSelector,
                          String subscriptionName,
                          boolean noLocal)
                   throws JMSException

Throws:

JMSException

checkClosed

void checkClosed()
           throws IllegalStateException

Throws:

IllegalStateException

addMessageConsumer

protected void addMessageConsumer(MessageConsumerImpl messageConsumer)
                           throws JMSException

Throws:

JMSException

removeMessageConsumer

public void removeMessageConsumer(MessageConsumerImpl messageConsumer)

getConfiguration

public Configuration getConfiguration()

startReparentingMessageToChild

public void startReparentingMessageToChild(MessageImpl message)
                                    throws JMSException

Throws:

JMSException

rollbackReparentingFromChild

public void rollbackReparentingFromChild()

setEndpointConsumer

public void setEndpointConsumer(EndpointConsumer endpointConsumer)

toString

public String toString()

Overrides:

toString in class Object

toObjectString

protected final String toObjectString()