Package com.ibm.di.systemqueue.driver

Class IBMMQ

  • All Implemented Interfaces:
    JMSDriver
    Direct Known Subclasses:
    IBMMQ
    public class IBMMQ
extends java.lang.Object
implements JMSDriver
    The Websphere MQ Series JMS Driver implementation. It initialize the JMS Driver and provides specific way for obtaining JMS QueueConnectionFactory.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected JMSDriverLog log  
      protected java.lang.String mChannel
      Driver properties for Channel
      protected java.lang.String mCipherSuite
      Driver properties for CipherSuit
      protected java.lang.String mHost
      Driver properties for Host
      protected int mPort
      Driver properties for Port
      protected java.lang.String mQmgr
      Driver properties for QueueManager
      protected boolean mSSL
      Driver properties for SSL
      protected java.lang.String mURL
      Driver properties for Url
      static java.lang.String PROP_MQ_BROKER
      JMS Driver property name used for broker
      static java.lang.String PROP_MQ_CHANNEL
      JMS Driver property name used for channel
      static java.lang.String PROP_MQ_QMANAGER
      JMS Driver property name used for queue manager
      static java.lang.String PROP_MQ_SSL_CIPHER
      JMS Driver property name used for sslCipher
      static java.lang.String PROP_MQ_SSL_USE_FLAG
      JMS Driver property name used for ssl flag
      protected ResourceHash resHash
      ResourceHash used for access of the TMS messages

    • Constructor Summary

      Constructors 
      Constructor Description
      IBMMQ()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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

      • PROP_MQ_BROKER

        public static final java.lang.String PROP_MQ_BROKER
        JMS Driver property name used for broker
        See Also:
        Constant Field Values

      • PROP_MQ_CHANNEL

        public static final java.lang.String PROP_MQ_CHANNEL
        JMS Driver property name used for channel
        See Also:
        Constant Field Values

      • PROP_MQ_QMANAGER

        public static final java.lang.String PROP_MQ_QMANAGER
        JMS Driver property name used for queue manager
        See Also:
        Constant Field Values

      • PROP_MQ_SSL_CIPHER

        public static final java.lang.String PROP_MQ_SSL_CIPHER
        JMS Driver property name used for sslCipher
        See Also:
        Constant Field Values

      • PROP_MQ_SSL_USE_FLAG

        public static final java.lang.String PROP_MQ_SSL_USE_FLAG
        JMS Driver property name used for ssl flag
        See Also:
        Constant Field Values

      • mSSL

        protected boolean mSSL
        Driver properties for SSL

      • mURL

        protected java.lang.String mURL
        Driver properties for Url

      • mChannel

        protected java.lang.String mChannel
        Driver properties for Channel

      • mQmgr

        protected java.lang.String mQmgr
        Driver properties for QueueManager

      • mHost

        protected java.lang.String mHost
        Driver properties for Host

      • mCipherSuite

        protected java.lang.String mCipherSuite
        Driver properties for CipherSuit

      • mPort

        protected int mPort
        Driver properties for Port

      • resHash

        protected ResourceHash resHash
        ResourceHash used for access of the TMS messages

    • Constructor Detail

      • IBMMQ

        public IBMMQ()

    • Method Detail

      • initialize

        public void initialize​(java.util.Hashtable env)
                throws java.lang.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.
        Specified by:
        initialize in interface JMSDriver
        Parameters:
        env - Hashtable that holds Driver properties
        Throws:
        java.lang.Exception - if JMS Driver cannot be initialized

      • getQueueFactory

        public javax.jms.QueueConnectionFactory getQueueFactory()
                                                 throws java.lang.Exception
        This method retrieves the provider-specific javax.jms.QueueConnectionFactory object
        Specified by:
        getQueueFactory in interface JMSDriver
        Returns:
        QueueConnectionFactory object of the JMS Driver
        Throws:
        java.lang.Exception - if QueueConnectionFactory cannot be created

      • getTopicFactory

        public javax.jms.TopicConnectionFactory getTopicFactory()
                                                 throws java.lang.Exception
        This method retrieves the provider-specific javax.jms.TopicConnectionFactory object
        Specified by:
        getTopicFactory in interface JMSDriver
        Returns:
        TopicConnectionFactory object of the JMS Driver
        Throws:
        java.lang.Exception - if TopicConnectionFactory cannot be created

      • 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.