com.ibm.di.systemqueue.driver
Class IBMMB

java.lang.Object
  com.ibm.di.systemqueue.driver.IBMMB

All Implemented Interfaces:

JMSDriver

Direct Known Subclasses:

IBMMB

public class IBMMB
extends java.lang.Object
implements JMSDriver

A MicroBroker JMS Driver responsible for connection to a MicroBroker server and creating both the QueueConnectionFactore and the TopicConnectionFactory. FOR INTERNAL USE ONLY! THIS CLASS IS NOT SUPPORTED FOR THE TDI 7.0 RELEASE!

Field Summary

protected static java.lang.String	COPYRIGHT
protected java.lang.String	host
protected JMSDriverLog	log
protected static int	MB_DEFAULT_PORT
protected static java.lang.String	MB_JMS_BROKER
protected int	port
protected ResourceHash	resHash
protected java.lang.String	url

Fields inherited from interface com.ibm.di.systemqueue.driver.JMSDriver

ENVIRONMENT_LOG, JMS_DRIVER_TMS_FILE

Constructor Summary

IBMMB()

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(java.util.Hashtable env) 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.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

protected static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

MB_JMS_BROKER

protected static final java.lang.String MB_JMS_BROKER

See Also:

Constant Field Values

MB_DEFAULT_PORT

protected static final int MB_DEFAULT_PORT

See Also:

Constant Field Values

url

protected java.lang.String url

host

protected java.lang.String host

port

protected int port

log

protected JMSDriverLog log

resHash

protected ResourceHash resHash

Constructor Detail

IBMMB

public IBMMB()

Method Detail

getQueueFactory

public javax.jms.QueueConnectionFactory getQueueFactory()
                                                 throws java.lang.Exception

Description copied from interface: JMSDriver

This method retrieves the provider-specific javax.jms.QueueConnectionFactory object

Specified by:

getQueueFactory in interface JMSDriver

Returns:

The QueueConnectionFactory after connecting to the MicroBroker server.

Throws:

java.lang.Exception - in case the provided during the initialization URL is incorrect.

getTopicFactory

public javax.jms.TopicConnectionFactory getTopicFactory()
                                                 throws java.lang.Exception

Description copied from interface: JMSDriver

This method retrieves the provider-specific javax.jms.TopicConnectionFactory object

Specified by:

getTopicFactory in interface JMSDriver

Returns:

The TopicConnectionFactory after connecting to the MicroBroker server.

Throws:

java.lang.Exception - in case the provided during the initialization URL is incorrect.

initialize

public void initialize(java.util.Hashtable env)
                throws java.lang.Exception

Description copied from interface: JMSDriver

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.

Specified by:

initialize in interface JMSDriver

Parameters:

env - a hashtable containing configuration parameters used during the connecting process. This Driver expects only a parameter with a key MB_JMS_BROKER and a value that follows this syntax: <host>:<port> if the port is omitted the default port 1883 is assumed.

Throws:

java.lang.Exception - in case the the required parameter is not provided or if the provided URL is not following the specific format.

terminate

public void terminate()
               throws java.lang.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.

Specified by:

terminate in interface JMSDriver

Throws:

java.lang.Exception - if error while terminating occurs.