com.j_spaces.jms

Class GSTopicConnectionImpl

java.lang.Object

com.j_spaces.jms.GSTopicConnectionImpl

All Implemented Interfaces:

javax.jms.Connection, javax.jms.QueueConnection, javax.jms.TopicConnection

public class GSTopicConnectionImpl
extends Object

Implements the javax.jms.TopicConnection interface. GigaSpaces implementation of the JMS TopicConnection Inerface.

 It also extends the GSConnectionImpl and overwrites most of its methods.
 - It holds the list of the sessions that attached to this conn.
 - It returns a LocalTransaction instance
 - It starts, stops and closes the Connection
 

Version:

4.0 Copyright: Copyright (c) 2004 Company: GigaSpaces Technologies,Ltd.

Author:

Gershon Diner

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed true if the connection is closed.
protected boolean	closing true if the connection is closing.
protected boolean	stopped This flag indicates whether the connection is in the started or stopped state

Constructor Summary

Constructors

Constructor and Description
GSTopicConnectionImpl(GSConnectionFactoryImpl _connFacParent) Constructor: Calling super com.j_spaces.jms.GSConnectionImpl.

Method Summary

Modifier and Type	Method and Description
void	close() API method for closing the connection; even if the connection appears to be broken, closes the sessions.
javax.jms.ConnectionConsumer	createConnectionConsumer(javax.jms.Destination destination, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.ConnectionConsumer	createConnectionConsumer(javax.jms.Queue queue, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.ConnectionConsumer	createConnectionConsumer(javax.jms.Topic topic, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.ConnectionConsumer	createDurableConnectionConsumer(javax.jms.Topic topic, String subscriptionName, String messageSelector, javax.jms.ServerSessionPool sessionPool, int maxMessages)
javax.jms.QueueSession	createQueueSession(boolean transacted, int acknowledgeMode)
javax.jms.Session	createSession(boolean transacted, int acknowledgeMode) Use the extended methods, from GSTopicConnectionImpl for Topic and from GSQueueConnectionImpl for Queue.
javax.jms.TopicSession	createTopicSession(boolean transacted, int acknowledgeMode)
protected void	ensureOpen() Verifies that the connection is open
String	getClientID() The connection client ID contains the space name together with the Destination name, "space name_destination name" e.g.
protected String	getCnxKey()
int	getCompressionMinSize()
protected GSConnectionFactoryImpl	getConnFacParent()
javax.jms.ExceptionListener	getExceptionListener()
javax.jms.ConnectionMetaData	getMetaData()
Transaction	getTransaction(boolean localTransaction, long leaseTime) create a new local transaction instance and use it in case of a transacted JMS session.
protected boolean	isStopped() Return the running state of the connection
void	setClientID(String clientID) The connection client ID contains the random connection Key + hostname + space name + destination name "space name_destination name" e.g.
protected void	setCnxKey(String string)
void	setExceptionListener(javax.jms.ExceptionListener listener)
protected void	setModified() Flags this connection as being modified.
void	start() Overwrite of the API method for starting the Topic connection.
void	stop() Overwrite of the API method for stoping the Topic connection.
String	toString()
protected void	updateClientIDInternally(String updatedClientID) This method called internally by the GSSessionImpl and GSTopicConnectionImpl and GSQueueConnectionImpl in order to append another string to the existing clientID to have the final clientID, in which after that no more client modifications can be done from outside.

Methods inherited from class java.lang.Object

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

Field Detail

closing

protected boolean closing

true if the connection is closing.

closed

protected boolean closed

true if the connection is closed.

stopped

protected boolean stopped

This flag indicates whether the connection is in the started or stopped state

Constructor Detail

GSTopicConnectionImpl

public GSTopicConnectionImpl(GSConnectionFactoryImpl _connFacParent)
                      throws javax.jms.JMSException

Constructor: Calling super com.j_spaces.jms.GSConnectionImpl.

Parameters:

_connFacParent - connection factory

Throws:

javax.jms.JMSException

Method Detail

createSession

public javax.jms.Session createSession(boolean transacted,
                                       int acknowledgeMode)
                                throws javax.jms.JMSException

Use the extended methods, from GSTopicConnectionImpl for Topic and from GSQueueConnectionImpl for Queue.

Specified by:

createSession in interface javax.jms.Connection

Returns:

null

Throws:

javax.jms.JMSException

See Also:

Connection.createSession(boolean, int)

getClientID

public String getClientID()
                   throws javax.jms.JMSException

The connection client ID contains the space name together with the Destination name, "space name_destination name" e.g. "JavaSpaces_MyTopic"

Specified by:

getClientID in interface javax.jms.Connection

Returns:

String m_clientID

Throws:

javax.jms.JMSException

See Also:

Connection.getClientID()

setClientID

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

The connection client ID contains the random connection Key + hostname + space name + destination name "space name_destination name" e.g. "JavaSpaces_MyTopic" Client cannot set a clientID more then once.

Specified by:

setClientID in interface javax.jms.Connection

Throws:

javax.jms.JMSException

See Also:

Connection.setClientID(String)

updateClientIDInternally

protected void updateClientIDInternally(String updatedClientID)
                                 throws javax.jms.JMSException

This method called internally by the GSSessionImpl and GSTopicConnectionImpl and GSQueueConnectionImpl in order to append another string to the existing clientID to have the final clientID, in which after that no more client modifications can be done from outside.

Throws:

javax.jms.JMSException

setModified

protected void setModified()

Flags this connection as being modified. Subsequent attempts to invoke setClientID(java.lang.String)will result in an IllegalStateException being thrown

getMetaData

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

Specified by:

getMetaData in interface javax.jms.Connection

Throws:

javax.jms.JMSException

See Also:

Connection.getMetaData(), GSConnectionMetaDataImpl

getExceptionListener

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

Specified by:

getExceptionListener in interface javax.jms.Connection

Throws:

javax.jms.JMSException

See Also:

Connection.getExceptionListener()

setExceptionListener

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

Specified by:

setExceptionListener in interface javax.jms.Connection

Throws:

javax.jms.JMSException

See Also:

Connection.setExceptionListener(ExceptionListener)

start

public void start()
           throws javax.jms.JMSException

Overwrite of the API method for starting the Topic connection. Loops on all the sessions and starts them.

Specified by:

start in interface javax.jms.Connection

Throws:

javax.jms.IllegalStateException - If the connection is closed or broken.

javax.jms.JMSException

stop

public void stop()
          throws javax.jms.JMSException

Overwrite of the API method for stoping the Topic connection.

Specified by:

stop in interface javax.jms.Connection

Throws:

javax.jms.IllegalStateException - If the connection is closed or broken.

javax.jms.JMSException

See Also:

Connection.stop()

close

public void close()
           throws javax.jms.JMSException

API method for closing the connection; even if the connection appears to be broken, closes the sessions. Loops on all the sessions and closes them. If one or more of the connections sessions message listeners is processing a message at the point when connection close is invoked, all the facilities of the connection and its sessions must remain available to those listeners until they return control to the JMS provider. When connection close is invoked it should not return until message processing has been shut down in an orderly fashion. This means that all message listeners that may have been running have returned, and that all pending receives have returned.

Specified by:

close in interface javax.jms.Connection

Throws:

javax.jms.JMSException - Actually never thrown.

isStopped

protected boolean isStopped()

Return the running state of the connection

Returns:

true if stopped, else started state.

ensureOpen

protected void ensureOpen()
                   throws javax.jms.IllegalStateException

Verifies that the connection is open

Throws:

javax.jms.IllegalStateException - if the connection is closed

createConnectionConsumer

public javax.jms.ConnectionConsumer createConnectionConsumer(javax.jms.Destination destination,
                                                             String messageSelector,
                                                             javax.jms.ServerSessionPool sessionPool,
                                                             int maxMessages)
                                                      throws javax.jms.JMSException

Specified by:

createConnectionConsumer in interface javax.jms.Connection

Throws:

javax.jms.JMSException

See Also:

Connection.createConnectionConsumer(Destination, String, ServerSessionPool, int)

createDurableConnectionConsumer

public javax.jms.ConnectionConsumer createDurableConnectionConsumer(javax.jms.Topic topic,
                                                                    String subscriptionName,
                                                                    String messageSelector,
                                                                    javax.jms.ServerSessionPool sessionPool,
                                                                    int maxMessages)
                                                             throws javax.jms.JMSException

Specified by:

createDurableConnectionConsumer in interface javax.jms.Connection

Specified by:

createDurableConnectionConsumer in interface javax.jms.TopicConnection

Throws:

javax.jms.JMSException

See Also:

Connection.createDurableConnectionConsumer(Topic, String, String, ServerSessionPool, int)

getTransaction

public Transaction getTransaction(boolean localTransaction,
                                  long leaseTime)
                           throws com.j_spaces.jms.TransactionCreateException

create a new local transaction instance and use it in case of a transacted JMS session.

Returns:

tr

Throws:

com.j_spaces.jms.TransactionCreateException

getCnxKey

protected String getCnxKey()

Returns:

cnxKey

setCnxKey

protected void setCnxKey(String string)

Parameters:

string -

toString

public String toString()

Overrides:

toString in class Object

getConnFacParent

protected GSConnectionFactoryImpl getConnFacParent()

Returns:

GSConnectionFactoryImpl

getCompressionMinSize

public int getCompressionMinSize()

Returns:

Returns the compressionMinSize. The minimum size (in bytes) which from where we start to compress all the message body. e.g. if a 1 MB Text JMSMessage body is sent, and the compressionMinSize value is 500000 (0.5MB) then we will compress that message body (only), otherwise we will send (write) it as is. TODO Currently this configured via system property later will be part of the JMS-config.xml default value is 0.5 MB

createConnectionConsumer

public javax.jms.ConnectionConsumer createConnectionConsumer(javax.jms.Queue queue,
                                                             String messageSelector,
                                                             javax.jms.ServerSessionPool sessionPool,
                                                             int maxMessages)
                                                      throws javax.jms.JMSException

Specified by:

createConnectionConsumer in interface javax.jms.QueueConnection

Throws:

javax.jms.JMSException

See Also:

QueueConnection.createConnectionConsumer(Queue, String, ServerSessionPool, int)

createQueueSession

public javax.jms.QueueSession createQueueSession(boolean transacted,
                                                 int acknowledgeMode)
                                          throws javax.jms.JMSException

Specified by:

createQueueSession in interface javax.jms.QueueConnection

Throws:

javax.jms.JMSException

See Also:

QueueConnection.createQueueSession(boolean, int)

createConnectionConsumer

public javax.jms.ConnectionConsumer createConnectionConsumer(javax.jms.Topic topic,
                                                             String messageSelector,
                                                             javax.jms.ServerSessionPool sessionPool,
                                                             int maxMessages)
                                                      throws javax.jms.JMSException

Specified by:

createConnectionConsumer in interface javax.jms.TopicConnection

Throws:

javax.jms.JMSException

See Also:

TopicConnection.createConnectionConsumer(Topic, String, ServerSessionPool, int)

createTopicSession

public javax.jms.TopicSession createTopicSession(boolean transacted,
                                                 int acknowledgeMode)
                                          throws javax.jms.JMSException

Specified by:

createTopicSession in interface javax.jms.TopicConnection

Throws:

javax.jms.JMSException

See Also:

TopicConnection.createTopicSession(boolean, int)