com.ibm.di.systemqueue.driver
Interface JMSDriver

All Known Implementing Classes:
ActiveMQ, ActiveMQ, IBMMB, IBMMB, IBMMQ, IBMMQ, IBMMQe, IBMMQe, JMSScriptDriver, WebsphereESB

public interface JMSDriver

The JMS Driver interface. It exposes the public method that are specific for different JMS Drivers. getQueueFactory() and getTopicFactory() returns specific QueueConnectionFactory/TopicConnectionFactory of the JMS Driver.


Field Summary
static String ENVIRONMENT_LOG
          This is the key on which is mapped an object of type JMSDriverLog during the call to the initialize(Hashtable) method.
static String JMS_DRIVER_TMS_FILE
          This is the name of the file where the JMS Drivers' translated messages are placed.
 
Method Summary
 javax.jms.QueueConnectionFactory getQueueFactory()
          This method retrieves the provider-specific javax.jms.QueueConnectionFactory object
 javax.jms.TopicConnectionFactory getTopicFactory()
          This method retrieves the provider-specific javax.jms.TopicConnectionFactory object
 void initialize(Hashtable aEnv)
          The initialize(Hastable env) method is passed a java.util.Hashtable object which stores provider-specific parameters, which can be used for connecting to a specific instance of the JMS server.
 void terminate()
          This is a call-back method used to notify the JMS Driver so it could clean any used resources.
 

Field Detail

ENVIRONMENT_LOG

static final String ENVIRONMENT_LOG
This is the key on which is mapped an object of type JMSDriverLog during the call to the initialize(Hashtable) method.

See Also:
Constant Field Values

JMS_DRIVER_TMS_FILE

static final String JMS_DRIVER_TMS_FILE
This is the name of the file where the JMS Drivers' translated messages are placed.

See Also:
Constant Field Values
Method Detail

initialize

void initialize(Hashtable aEnv)
                throws Exception
The initialize(Hastable env) method is passed a java.util.Hashtable object which stores provider-specific parameters, which can be used for connecting to a specific instance of the JMS server. Normally this method would use the supplied parameters to connect to the JMS server and obtain a javax.jms.TopicConnectionFactory object and/or a javax.jms.QueueConnectionFactory object. Then the method would store the object(s) in member variables so that it/they can be later retrieved via the getQueueFactory() and/or the getTopicFactory() method.

Parameters:
aEnv - Hashtable that holds Driver properties
Throws:
Exception - if JMS Driver cannot be initialized

getQueueFactory

javax.jms.QueueConnectionFactory getQueueFactory()
                                                 throws Exception
This method retrieves the provider-specific javax.jms.QueueConnectionFactory object

Returns:
QueueConnectionFactory object of the JMS Driver
Throws:
Exception - if QueueConnectionFactory cannot be created

getTopicFactory

javax.jms.TopicConnectionFactory getTopicFactory()
                                                 throws Exception
This method retrieves the provider-specific javax.jms.TopicConnectionFactory object

Returns:
TopicConnectionFactory object of the JMS Driver
Throws:
Exception - if TopicConnectionFactory cannot be created

terminate

void terminate()
               throws Exception
This is a call-back method used to notify the JMS Driver so it could clean any used resources. This method should be used in very rare cases.

Throws:
Exception - if error while terminating occurs.
Since:
7.0