electric.server.jms
Interface IJMSAdapter

All Known Implementing Classes:

BasicJNDIAdapter, J2EEAdapter, JBossMQAdapter, MQSeriesAdapter, SonicMQAdapter, SwiftMQAdapter, TibcoAdapter

public interface IJMSAdapter

IJMSAdapter should be implemented to encapsulate JMS provider specific logic for creation of the JMS administered objects. The administered objects are queues, topics and connection factories for those. Instances of IJMSAdapter must be registered with the JMS subsystem of GLUE, by calling the electric.server.jms.JMS.registerAdapter() method. The method maps a class that belongs to a JMS provider codebase to an instance of IJMSAdapter.

Author:

webMethods

Method Summary

java.lang.String	getClassName() Returns the name of the class unique to the jms provider represented by an implementation of this interface
java.lang.String	getProviderName() Return the name of the provider
javax.jms.Queue	getQueue(java.lang.String queueName, boolean create) This method is called by the JMS subsystem of GLUE to request construction and placement of a JMS Queue object in a JNDI directory The method returns the name of the queue conforming to the requirements of the provider
javax.jms.QueueConnectionFactory	getQueueConnectionFactory(java.lang.String queueConnFactoryName, boolean create) This method is called by the JMS subsystem of GLUE to request construction and placement of a JMS Queue Connection Factory object in a JNDI directory The method returns the name of the queue connection factory conforming to the requirements of the provider
Context	getStartupContext() Get the context with the properties used to initialize/customize this admin.
boolean	isStarted() Test if the admin had been started
void	shutdown() Close any resources used by the admin and shutdown the admin
void	startup(Context context) Get any setting overrides from the context.

Method Detail

startup

public void startup(Context context)
             throws javax.jms.JMSException,
                    javax.naming.NamingException

Get any setting overrides from the context. Perform initialization and start the admin.

Parameters:

context - the context containing any custom settings for the provider

Throws:

javax.jms.JMSException

javax.naming.NamingException

shutdown

public void shutdown()
              throws javax.jms.JMSException,
                     javax.naming.NamingException

Close any resources used by the admin and shutdown the admin

Throws:

javax.jms.JMSException

javax.naming.NamingException

isStarted

public boolean isStarted()

Test if the admin had been started

getStartupContext

public Context getStartupContext()

Get the context with the properties used to initialize/customize this admin. This method is used only when Async objects are persisted. The serialization of Async object requires persisting of any state information used for the reconnection when object is deserialized. If admin is not started the method should throw IllegalStateException

getQueue

public javax.jms.Queue getQueue(java.lang.String queueName,
                                boolean create)
                         throws javax.jms.JMSException,
                                javax.naming.NamingException

This method is called by the JMS subsystem of GLUE to request construction and placement of a JMS Queue object in a JNDI directory The method returns the name of the queue conforming to the requirements of the provider

Parameters:

queueName - JNDI name of the queue

create - if true, create the queue

Throws:

javax.jms.JMSException

javax.naming.NamingException

getQueueConnectionFactory

public javax.jms.QueueConnectionFactory getQueueConnectionFactory(java.lang.String queueConnFactoryName,
                                                                  boolean create)
                                                           throws javax.jms.JMSException,
                                                                  javax.naming.NamingException

This method is called by the JMS subsystem of GLUE to request construction and placement of a JMS Queue Connection Factory object in a JNDI directory The method returns the name of the queue connection factory conforming to the requirements of the provider

Parameters:

queueConnFactoryName - JNDI name of the queue connecion factory

create - if true, create the queue

Throws:

javax.jms.JMSException

javax.naming.NamingException

getClassName

public java.lang.String getClassName()

Returns the name of the class unique to the jms provider represented by an implementation of this interface

getProviderName

public java.lang.String getProviderName()

Return the name of the provider