com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'next_previous_links' is unknown.

IBM WebSphere MQ JMS Event Publisher

Owned by Former user (Deleted)
Last updated: Jan 04, 2016 by Former user (Deleted)
6 min read

IBM WebSphere JMS event publisher is used to publish events in  m ap, XML, JSON, and text  formats via JMS transport.

Prerequisites

Follow the steps below to set up the prerequisites before starting the configuration.

  1. Start WSO2 CEP/DAS.
  2. Download and install WebSphere MQ pack with the latest fixes. For more information on installing, see the IBM documentation. 

Configuring WebSphere MQ 

Follow the instructions below to configure WebSphere MQ.  

Configuring JMSAdmin.conf File

  1. Go to the <WebSphere_MQ_HOME>\java\bin directory and open the JMSAdmin.config file in a text editor.

  2.  Comment out the existing INITIAL_CONTEXT_FACTORY and add a INITIAL_CONTEXT_FACTORY named com.sun.jndi.fscontext.RefFSContextFactory.

    INITIAL_CONTEXT_FACTORY=com.sun.jndi.fscontext.RefFSContextFactory 

  3. Comment out the default PROVIDER_URL and use a directory path instead. Ensure the directory is created in the file system (e.g., C:/JNDI-Directory).

    If there are .bindings files of earlier versions already existing in this folder, delete them. It should typically be an empty folder.

    Your JMSAdmin.config file should now look similar to this:

    # appropriate one should be uncommented.
#
#INITIAL_CONTEXT_FACTORY=com.sun.jndi.ldap.LdapCtxFactory
INITIAL_CONTEXT_FACTORY=com.sun.jndi.fscontext.RefFSContextFactory
#INITIAL_CONTEXT_FACTORY=com.ibm.ejs.ns.jndi.CNInitialContextFactory
#INITIAL_CONTEXT_FACTORY=com.ibm.websphere.naming.WsnInitialContextFactory
#INITIAL_CONTEXT_FACTORY=com.ibm.websphere.naming.WMQInitialContextFactory
#
#  The following line specifies the URL of the service provider's initial
#  context. It currently refers to an LDAP root context. Examples of a
#  file system URL and WebSphere's JNDI namespace are also shown, commented
#  out.
#
#PROVIDER_URL=ldap://polaris/o=ibm,c=us
PROVIDER_URL=file:/C:/JNDI-Directory
#PROVIDER_URL=iiop://localhost/
#PROVIDER_URL=localhost:1414/SYSTEM.DEF.SVRCONN
......
  4. Restart the WebSphere MQ service.

Creating the Queue in WebSphere MQ

  1. Start IBM WebSphere MQ Explorer and create a new queue manager. Make sure you select  make this the default queue manager check box. Leave default values on the other fields.
    create query manager
  2. Select the options to  Start Queue Manager ,  Autostart Queue Manager,  and  Create server connection channel , and then click  Next .
  3. Select the option to create a listener configuration for TCP/IP, and provide a port number ( e.g., 1415 ).
  4. Select the created Queue manager and expand its navigation tree. Click  Queues in the tree and create a new local queue (e.g., localq). 
    new local queue
  5. Keep the default configurations and click Finish.
  6. Click Topics in the tree view and create a new local topic (e.g., localt). 
  7. Right-click Channels under Advanced and select New > Server-connection Channel. Provide a name for the channel (e.g., myChannel), and click Next.
    new server connection channel
  8.   Set the transmission protocol as TCP and click Finish.
    A listener is created and is running on the given port (e.g., 1415). You should be able to view it by clicking the  listeners  icon.

Generating the .bindings file 

  1. Go to  the <WebSphere_MQ_HOME> /java/bin directory and invoke the IVT app by running the following command:   

    IVTRun.bat -nojndi -client -m mymgr -host localhost -channel mychannel

  2. Create the default set of JNDI bindings by running the following command on the   command prompt:  

    IVTSetup.bat

  3. Execute the  IVTRun  tool as follows.

    IVTRun.bat -url "file:/C:/JNDI-Directory" -icf com.sun.jndi.fscontext.RefFSContextFactory
  4. You have now enabled and verified JNDI support. Now go to  C:/JNDI-Directory to  view the .bindings file there.
  5. Start the JMSAdmin tool by running the jmsadmin.bat  file.   

  6. Modify  the JNDI bindings by executing the following commands:
    For queues:  

    ALTER QCF(ivtQCF) TRANSPORT(CLIENT)
ALTER QCF(ivtQCF) QMGR(mymgr)

    For topics:

    ALTER TCF(ivtTCF) TRANSPORT(CLIENT)
ALTER TCF(ivtTCF) QMGR(mymgr)
  7. In  IBM WebSphere MQ Explorer,  select JMS Administered Objects from the tree view on the left, and then select Add initial context. Once done, select  File system and enter the JNDI directory path. This will bring up all created queues and   topics.
    You have now set up and configured IBM WebSphere MQ in your environment.

Configuring WSO2 CEP/DAS

Follow the instructions below to configure WSO2 CEP/DAS.

  1.  If you set up WSO2 CEP/DAS on a different machine from WebSphere MQ, copy C:/JNDI-Directory to that machine. The bindings file allows you to access WebSphere queues from any machine in the network.
  2. Copy the following JAR files from the <WebSphere_MQ_HOME>/java/lib directory to the   <PRODUCT_HOME>/repository/components/lib/ directory .  
    • com.ibm.mqjms.jar
    • fscontext.jar
    • providerutil.jar
    • com.ibm.mq.jmqi.jar 
    • dhbcore.jar 
  3. If you are using WebSphere MQ version 6.0 instead of version 7.0, add the following two JAR files. You might not find   com.ibm.mq.jmqi.jar in version 6.0. 
    • com.ibm.mq.jar     
    • connector.jar

    Optionally, you might have to add the following jars as well.

    • jms.jar
    • jndi.jar   
    • jta.jar   
    • ldap.jar
  4. If you are using WebSphere MQ version 7.1 or later, add the following jars to the < PRODUCT _HOME>/repository/components/dropins/  directory.
    • com.ibm.mq_2.0.0.jar 
    • fscontext_1.0.0.jar 

    Add the following files to the < PRODUCT_HOME>/repository/components/lib/ directory.

    • jms.jar
    • jta.jar 

  5. Log in to the JMSAdmin tool and create a queue named bogusq by running the following commands in JMSAdmin   shell.    

    DEFINE Q(bogusq) QMGR(mymgr)
ALTER Q(bogusq) QUEUE(localq)

    localq is the queue we created earlier. We use two queues for the queue scenario, and the queue named bogusq is defined as the default destination since we need the default queue ( ivtQ ) for our proxy service only. If we use ivtQ here, all the services deployed in CEP (XKMS, echo, wso2carbon-sts etc.) will start listening on the same queue. 

  6. Repeat these steps for the topic scenarios. For example:

    DEFINE T(bogust)
ALTER T(bogust) TOPIC(localt)

    localt is the topic we created earlier.

  7. Configure the  <PRODUCT_HOME>\repository\conf\axis2\axis2.xml file as follows: 

    <transportReceiver name="jms" class="org.apache.axis2.transport.jms.JMSListener">
        <parameter name="myTopicConnectionFactory" locked="false"> 
            <parameter name="java.naming.factory.initial"
locked="false">com.sun.jndi.fscontext.RefFSContextFactory</parameter>
            <parameter name="java.naming.provider.url" locked="false">file:/C:/JNDI-Directory</parameter>
            <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">ivtQCF</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">topic</parameter>
        </parameter>  
  
        <!--parameter name="SQProxyCF" locked="false">
            <parameter name="java.naming.factory.initial">com.sun.jndi.fscontext.RefFSContextFactory</parameter>
            <parameter name="java.naming.provider.url">file:/C:/JNDI-Directory</parameter>
            <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">ivtQCF</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">queue</parameter>
        </parameter-->
  
        <parameter name="default" locked="false">
            <parameter name="java.naming.factory.initial"
locked="false">com.sun.jndi.fscontext.RefFSContextFactory</parameter>
            <parameter name="java.naming.provider.url" locked="false">file:/C:/JNDI-Directory</parameter>
            <parameter name="transport.jms.ConnectionFactoryJNDIName" locked="false">ivtQCF</parameter>
            <parameter name="transport.jms.ConnectionFactoryType" locked="false">queue</parameter>
        </parameter>
</transportReceiver>

    You will comment and uncomment the non-default connection factories depending on which scenario you are running, as described in the next section. 

    For details on the JMS configuration parameters used in the code segments, see JMS Connection Factory Parameters.

Creating an IBM WebSphere JMS event publisher

For instructions on creating an IBM WebSphere JMS event publisher, see Configuring CEP to Create Alerts.

Configuring adapter properties

Specify the Static and Dynamic Adapter Properties, when creating an IBM WebSphere JMS event publisher using the management console as shown below.

IBM WebSphere publisher

After entering the above adapter properties, select  the  Message Format   which you want to apply on the published events   . Also, click    Advanced    to define custom output mappings based on the    Message Format    you selected. For more information on custom output mapping types, see    Publishing Events in Various Event Formats .

You can also d efine the respective adapter properties of the event publisher based on the transport type within the    <to>   element of the event publisher configuration in the <PRODUCT_HOME>/repository/deployment/server/eventpublishers/ directory as follows.

<eventPublisher name="IBMWebSphereOutputEventAdapter"
  statistics="disable" trace="disable" xmlns="http://wso2.org/carbon/eventpublisher">
  .................
  <to eventAdapterType="jms">
    <property name="java.naming.factory.initial">com.sun.jndi.fscontext.RefFSContextFactory</property>
    <property name="java.naming.provider.url">file:/C:/JNDI-Directory</property>
    <property name="transport.jms.UserName">jms-user</property>
    <property encrypted="true" name="transport.jms.Password">JP4yDiEh6HogOEjJzQQwHaJFIWZlnJTzaERl4eYrwukNeypm36R+odMkaN9b2q4H9jBQsRV+mhcT1wQVnBpEZn4a+SuFuLKh3NihDEgww6R1tZVo8p1D6TUKvSHXYEpwSOgKrkOmdaFEOQOjfdhfK3Hrnjkz/MYPYQknrLK5MIY=</property>
    <property name="transport.jms.DestinationType">topic</property>
    <property name="transport.jms.Header">header_name1:header_value1,header_name2:header_value2</property>
    <property name="transport.jms.Destination">test_topic</property>
    <property name="transport.jms.ConnectionFactoryJNDIName">ivtQCF</property>
  </to>
</eventPublisher>

Static adapter properties 

Adapter Property
Description
Configuration file propertyExample
JNDI Initial Context Factory Class The JNDI initial context factory class. The class must implement the java.naming.spi.InitialContextFactory interface
java.naming.factory.initial

com.sun.jndi.fscontext.RefFSContextFactory

JNDI Provider URL URL of the JNDI provider
java.naming.provider.url

file:/C:/JNDI-Directory

Username Valid username for the JMS connection
transport.jms.UserName
jms-user
Password Valid password for the JMS connection
transport.jms.Password
jms-password
Connection Factory JNDI Name The JNDI name of the connection factory
transport.jms.ConnectionFactoryJNDIName

ivtQCF

Destination Type The sort order for messages that arrive on a specific destination
transport.jms.DestinationType
topic/queue
Destination The topic or queue to which WSO2 CEP/DAS sends messages by publishing
transport.jms.Destination

test_topic

Dynamic adapter properties 

Adapter PropertyDescriptionConfiguration file propertyExample
Header Define transport headers as a valid header name in a header value pair format   transport.jms.Header
header_name1:header_value1,header_name2:header_value2 
com.atlassian.confluence.content.render.xhtml.migration.exceptions.UnknownMacroMigrationException: The macro 'next_previous_links2' is unknown.