com.j_spaces.jms.utils

Class GSJMSAdmin

java.lang.Object

com.j_spaces.jms.utils.GSJMSAdmin

public class GSJMSAdmin
extends Object

Admin util for the GigaSpaces JMS implementation. It is used by client to obtain JMS resources like connection factories and destinations. If an instance of the class already exists we return the same static instance. It caches the JMS resources.

Version:

6.0

Author:

Shai Wolf

Method Summary

Modifier and Type	Method and Description
void	createAndBindDestination(boolean isQueue, String destinationName) Creates a Destination (GSTopicImpl or GSQueueImpl) and then binds it to the jndi registry.
void	destroyAndUnBindDestination(String destinationName) Destroys a Destination (GSTopicImpl or GSQueueImpl) and then unbinds from the jndi registry.
int	getCompressionMinSize()
javax.jms.ConnectionFactory	getConnectionFactory(IJSpace space)
javax.jms.ConnectionFactory	getConnectionFactory(IJSpace space, IMessageConverter messageConverter) Returns a ConnectionFactory that works with the specified space proxy.
javax.jms.ConnectionFactory	getConnectionFactory(String spaceURL)
javax.jms.ConnectionFactory	getConnectionFactory(String spaceURL, IMessageConverter messageConverter) Returns a ConnectionFactory that works with the space in the specified spaceURL.
static GSJMSAdmin	getInstance() Returns a GSJMSAdmin instance.
javax.jms.Queue	getQueue(String name)
javax.jms.QueueConnectionFactory	getQueueConnectionFactory(IJSpace space)
javax.jms.QueueConnectionFactory	getQueueConnectionFactory(IJSpace space, IMessageConverter messageConverter) Returns a QueueConnectionFactory that works with the specified space proxy.
javax.jms.QueueConnectionFactory	getQueueConnectionFactory(String spaceURL)
javax.jms.QueueConnectionFactory	getQueueConnectionFactory(String spaceURL, IMessageConverter messageConverter) Returns a QueueConnectionFactory that works with the space in the specified spaceURL.
javax.jms.Topic	getTopic(String name)
javax.jms.TopicConnectionFactory	getTopicConnectionFactory(IJSpace space)
javax.jms.TopicConnectionFactory	getTopicConnectionFactory(IJSpace space, IMessageConverter messageConverter) Returns a TopicConnectionFactory that works with the specified space proxy.
javax.jms.TopicConnectionFactory	getTopicConnectionFactory(String spaceURL)
javax.jms.TopicConnectionFactory	getTopicConnectionFactory(String spaceURL, IMessageConverter messageConverter) Returns a TopicConnectionFactory that works with the space in the specified spaceURL.
javax.jms.XAConnectionFactory	getXAConnectionFactory(IJSpace space)
javax.jms.XAConnectionFactory	getXAConnectionFactory(IJSpace space, IMessageConverter messageConverter) Returns a XAConnectionFactory that works with the specified space proxy.
javax.jms.XAConnectionFactory	getXAConnectionFactory(String spaceURL)
javax.jms.XAConnectionFactory	getXAConnectionFactory(String spaceURL, IMessageConverter messageConverter) Returns a XAConnectionFactory that works with the space in the specified spaceURL.
javax.jms.XAQueueConnectionFactory	getXAQueueConnectionFactory(IJSpace space)
javax.jms.XAQueueConnectionFactory	getXAQueueConnectionFactory(IJSpace space, IMessageConverter messageConverter) Returns a XAQueueConnectionFactory that works with the specified space proxy.
javax.jms.XAQueueConnectionFactory	getXAQueueConnectionFactory(String spaceURL)
javax.jms.XAQueueConnectionFactory	getXAQueueConnectionFactory(String spaceURL, IMessageConverter messageConverter) Returns a XAQueueConnectionFactory that works with the space in the specified spaceURL.
javax.jms.XATopicConnectionFactory	getXATopicConnectionFactory(IJSpace space)
javax.jms.XATopicConnectionFactory	getXATopicConnectionFactory(IJSpace space, IMessageConverter messageConverter) Returns a XATopicConnectionFactory that works with the specified space proxy.
javax.jms.XATopicConnectionFactory	getXATopicConnectionFactory(String spaceURL)
javax.jms.XATopicConnectionFactory	getXATopicConnectionFactory(String spaceURL, IMessageConverter messageConverter) Returns a XATopicConnectionFactory that works with the space in the specified spaceURL.
Object	jndiLookup(String name) Creates a JNDI API InitialContext object if none exists yet.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static GSJMSAdmin getInstance()

Returns a GSJMSAdmin instance.

Returns:

a GSJMSAdmin instance.

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory(String spaceURL)
                                                 throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory(String spaceURL,
                                                        IMessageConverter messageConverter)
                                                 throws javax.jms.JMSException

Returns a ConnectionFactory that works with the space in the specified spaceURL. First it tries to find a cached ConnectionFactory. If the required instance doesn't exist in the cache, it finds the space and creates a new ConnectionFactory to work with that space.

Parameters:

spaceURL - space URL

Returns:

a ConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory(IJSpace space)
                                                 throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getConnectionFactory

public javax.jms.ConnectionFactory getConnectionFactory(IJSpace space,
                                                        IMessageConverter messageConverter)
                                                 throws javax.jms.JMSException

Returns a ConnectionFactory that works with the specified space proxy. First it tries to find a cached ConnectionFactory. If the required instance doesn't exist in the cache, it creates a new ConnectionFactory to work with that space.

Parameters:

space - the space proxy

Returns:

a ConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getQueueConnectionFactory

public javax.jms.QueueConnectionFactory getQueueConnectionFactory(String spaceURL)
                                                           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getQueueConnectionFactory

public javax.jms.QueueConnectionFactory getQueueConnectionFactory(String spaceURL,
                                                                  IMessageConverter messageConverter)
                                                           throws javax.jms.JMSException

Returns a QueueConnectionFactory that works with the space in the specified spaceURL. First it tries to find a cached QueueConnectionFactory. If the required instance doesn't exist in the cache, it finds the space and creates a new QueueConnectionFactory to work with that space.

Parameters:

spaceURL - space URL

Returns:

a QueueConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getTopicConnectionFactory

public javax.jms.TopicConnectionFactory getTopicConnectionFactory(String spaceURL)
                                                           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getTopicConnectionFactory

public javax.jms.TopicConnectionFactory getTopicConnectionFactory(String spaceURL,
                                                                  IMessageConverter messageConverter)
                                                           throws javax.jms.JMSException

Returns a TopicConnectionFactory that works with the space in the specified spaceURL. First it tries to find a cached TopicConnectionFactory. If the required instance doesn't exist in the cache, it finds the space and creates a new TopicConnectionFactory to work with that space.

Parameters:

spaceURL - space URL

Returns:

a TopicConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getQueueConnectionFactory

public javax.jms.QueueConnectionFactory getQueueConnectionFactory(IJSpace space)
                                                           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getQueueConnectionFactory

public javax.jms.QueueConnectionFactory getQueueConnectionFactory(IJSpace space,
                                                                  IMessageConverter messageConverter)
                                                           throws javax.jms.JMSException

Returns a QueueConnectionFactory that works with the specified space proxy. First it tries to find a cached QueueConnectionFactory. If the required instance doesn't exist in the cache, it creates a new QueueConnectionFactory to work with that space.

Parameters:

space - the space proxy

Returns:

a QueueConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getTopicConnectionFactory

public javax.jms.TopicConnectionFactory getTopicConnectionFactory(IJSpace space)
                                                           throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getTopicConnectionFactory

public javax.jms.TopicConnectionFactory getTopicConnectionFactory(IJSpace space,
                                                                  IMessageConverter messageConverter)
                                                           throws javax.jms.JMSException

Returns a TopicConnectionFactory that works with the specified space proxy. First it tries to find a cached TopicConnectionFactory. If the required instance doesn't exist in the cache, it creates a new TopicConnectionFactory to work with that space.

Parameters:

space - the space proxy

Returns:

a TopicConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getXAConnectionFactory

public javax.jms.XAConnectionFactory getXAConnectionFactory(String spaceURL)
                                                     throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getXAConnectionFactory

public javax.jms.XAConnectionFactory getXAConnectionFactory(String spaceURL,
                                                            IMessageConverter messageConverter)
                                                     throws javax.jms.JMSException

Returns a XAConnectionFactory that works with the space in the specified spaceURL. First it tries to find a cached XAConnectionFactory. If the required instance doesn't exist in the cache, it finds the space and creates a new XAConnectionFactory to work with that space.

Parameters:

spaceURL - space URL

Returns:

a XAConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getXAConnectionFactory

public javax.jms.XAConnectionFactory getXAConnectionFactory(IJSpace space)
                                                     throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getXAConnectionFactory

public javax.jms.XAConnectionFactory getXAConnectionFactory(IJSpace space,
                                                            IMessageConverter messageConverter)
                                                     throws javax.jms.JMSException

Returns a XAConnectionFactory that works with the specified space proxy. First it tries to find a cached XAConnectionFactory. If the required instance doesn't exist in the cache, it creates a new XAConnectionFactory to work with that space.

Parameters:

space - the space proxy

Returns:

a XAConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getXAQueueConnectionFactory

public javax.jms.XAQueueConnectionFactory getXAQueueConnectionFactory(String spaceURL)
                                                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getXAQueueConnectionFactory

public javax.jms.XAQueueConnectionFactory getXAQueueConnectionFactory(String spaceURL,
                                                                      IMessageConverter messageConverter)
                                                               throws javax.jms.JMSException

Returns a XAQueueConnectionFactory that works with the space in the specified spaceURL. First it tries to find a cached XAQueueConnectionFactory. If the required instance doesn't exist in the cache, it finds the space and creates a new XAQueueConnectionFactory to work with that space.

Parameters:

spaceURL - space URL

Returns:

a XAQueueConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getXATopicConnectionFactory

public javax.jms.XATopicConnectionFactory getXATopicConnectionFactory(String spaceURL)
                                                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getXATopicConnectionFactory

public javax.jms.XATopicConnectionFactory getXATopicConnectionFactory(String spaceURL,
                                                                      IMessageConverter messageConverter)
                                                               throws javax.jms.JMSException

Returns a XATopicConnectionFactory that works with the space in the specified spaceURL. First it tries to find a cached XATopicConnectionFactory. If the required instance doesn't exist in the cache, it finds the space and creates a new XATopicConnectionFactory to work with that space.

Parameters:

spaceURL - space URL

Returns:

a XATopicConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getXAQueueConnectionFactory

public javax.jms.XAQueueConnectionFactory getXAQueueConnectionFactory(IJSpace space)
                                                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getXAQueueConnectionFactory

public javax.jms.XAQueueConnectionFactory getXAQueueConnectionFactory(IJSpace space,
                                                                      IMessageConverter messageConverter)
                                                               throws javax.jms.JMSException

Returns a XAQueueConnectionFactory that works with the specified space proxy. First it tries to find a cached XAQueueConnectionFactory. If the required instance doesn't exist in the cache, it creates a new XAQueueConnectionFactory to work with that space.

Parameters:

space - the space proxy

Returns:

a XAQueueConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getXATopicConnectionFactory

public javax.jms.XATopicConnectionFactory getXATopicConnectionFactory(IJSpace space)
                                                               throws javax.jms.JMSException

Throws:

javax.jms.JMSException

getXATopicConnectionFactory

public javax.jms.XATopicConnectionFactory getXATopicConnectionFactory(IJSpace space,
                                                                      IMessageConverter messageConverter)
                                                               throws javax.jms.JMSException

Returns a XATopicConnectionFactory that works with the specified space proxy. First it tries to find a cached XATopicConnectionFactory. If the required instance doesn't exist in the cache, it creates a new XATopicConnectionFactory to work with that space.

Parameters:

space - the space proxy

Returns:

a XATopicConnectionFactory instance

Throws:

javax.jms.JMSException - if the was a problem to return the factory

getQueue

public javax.jms.Queue getQueue(String name)

Parameters:

name - the name of the Queue

Returns:

a Queue with the specified name.

getTopic

public javax.jms.Topic getTopic(String name)

Parameters:

name - the name of the Topic

Returns:

a Topic with the specified name.

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

jndiLookup

public Object jndiLookup(String name)
                  throws NamingException

Creates a JNDI API InitialContext object if none exists yet. Then looks up the string argument and returns the associated JMS administrated object.

Parameters:

name - the name of the object to look for

Returns:

the JMS administrated object bound to the name.

Throws:

NamingException - if name cannot be found

createAndBindDestination

public void createAndBindDestination(boolean isQueue,
                                     String destinationName)
                              throws NamingException,
                                     javax.jms.JMSException

Creates a Destination (GSTopicImpl or GSQueueImpl) and then binds it to the jndi registry.

Throws:

NamingException

javax.jms.JMSException

destroyAndUnBindDestination

public void destroyAndUnBindDestination(String destinationName)
                                 throws javax.jms.JMSException

Destroys a Destination (GSTopicImpl or GSQueueImpl) and then unbinds from the jndi registry.

Throws:

javax.jms.JMSException