Package com.ibm.di.systemqueue.driver

Class WebsphereESB

  • All Implemented Interfaces:
    JMSDriver
    public class WebsphereESB
extends java.lang.Object
implements JMSDriver
    The JMS Client implementation for Enterprise Servcie Bus. It initialize the JMS client and provides specific way for obtaining JMS ConnectionFactory. JMS Client is limited for only one ConnectionFactory for Queue/Topic at a JVM.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected JMSDriverLog log
      Driver properties for log
      static java.lang.String PROP_WESB_BROKER
      JMS Driver property name used for broker
      static java.lang.String PROP_WESB_BUSNAME
      JMS Driver property name used for channel/Bus name of WebsphereESB
      protected ResourceHash resHash
      ResourceHash used for access of the TMS messages
      protected java.lang.String wesbChannel
      Driver properties for Channel
      protected java.lang.String wesbHost
      Driver properties for Host
      protected int wesbPort
      Driver properties for Port
      protected java.lang.String wesbSIB
      Driver properties for SIB End Point
      protected java.lang.String wesbURL
      Driver properties for Url

    • Constructor Summary

      Constructors 
      Constructor Description
      WebsphereESB()  

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

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

      • PROP_WESB_BUSNAME

        public static final java.lang.String PROP_WESB_BUSNAME
        JMS Driver property name used for channel/Bus name of WebsphereESB
        See Also:
        Constant Field Values

      • wesbURL

        protected java.lang.String wesbURL
        Driver properties for Url

      • wesbChannel

        protected java.lang.String wesbChannel
        Driver properties for Channel

      • wesbHost

        protected java.lang.String wesbHost
        Driver properties for Host

      • wesbPort

        protected int wesbPort
        Driver properties for Port

      • wesbSIB

        protected java.lang.String wesbSIB
        Driver properties for SIB End Point

      • resHash

        protected ResourceHash resHash
        ResourceHash used for access of the TMS messages

    • Constructor Detail

      • WebsphereESB

        public WebsphereESB()

    • Method Detail

      • 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

      • 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

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