IBM WebSphere MQ Adapter Sample

Contents

Overview
Running This Sample in StreamBase Studio
Running This Sample in Terminal Windows
Importing This Sample into StreamBase Studio
Sample Location

Overview

This sample demonstrates the use of the TIBCO StreamBase® Adapter for IBM MQ Series.

IBM MQ Middleware Dependencies

You must obtain the required IBM MQ Java libraries directly from IBM. The easiest way to make the IBM MQ API accessible to StreamBase is to copy the required API JARs into the StreamBase installation in the lib/ext directory.

If copying the JAR files to lib/ext is impractical, then for running IBM MQ adapter applications in StreamBase Studio, you must add the IBM MQ JARs to the Java Build Path. For running IBM MQ adapter applications from the command line, you must add the IBM MQ API JARs to the server's CLASSPATH, either by setting an environment variable, or via the <java-vm> element of the server configuration file.

Obtain the following required IBM MQ JAR files from an IBM MQ Series 7.0 installation, or directly from IBM:

com.ibm.mq.commonservices.jar
com.ibm.mq.headers.jar
com.ibm.mq.jar
com.ibm.mq.jmqi.jar
com.ibm.mq.pcf.jar
connector.jar

Running This Sample in StreamBase Studio

Note

To use this sample, you must have access to a valid IBM WebSphere MQ server.

  1. In the Package Explorer view, double-click ibm-websphere-mq.sbapp.

  2. Select the MQInput adapter icon to open the Properties view for the adapter.

  3. Select the Adapter Properties tab and enter valid values for Host Name, Port Number, Queue Manager, Queue Name, and Channel.

  4. Repeat the previous two steps for the MQOutput adapter. Enter values for Reply To Queue Manager and Reply To Queue Name as well.

  5. Click the Run button. This opens the SB Test/Debug perspective and starts the application.

  6. In the Test/Debug Perspective, open the Application Output view. If connectivity to your IBM WebSphere MQ server is configured correctly, look for tuples emitted on the InputStatus and OutputStatus streams indicating the adapter has connected successfully.

  7. In the Manual Input view, select the SendMessage stream. Enter a value in the Payload field, set the MyTuple field to null, and press Send Data.

  8. Observe that the payload value is emitted on the ReceivedMessage stream.

  9. When done, press F9 or click the Stop Running Application button.

Running This Sample in Terminal Windows

This section describes how to run the sample in UNIX terminal windows or Windows command prompt windows. On Windows, be sure to use the StreamBase Command Prompt from the Start menu as described in the Test/Debug Guide, not the default command prompt.

  1. Open three terminal windows on UNIX, or three StreamBase Command Prompts on Windows. In each window, navigate to your workspace copy of the sample, as described above.

  2. In window 1, type:

    sbd ibm-websphere-mq.sbapp

  3. In window 2, type:

    sbc dequeue -v

    This window displays the tuples dequeued from the adapters' output ports.

  4. In window 3, send a message to the MQ server:

    echo This is the payload,null | sbc enqueue SendMessage

  5. Observe in windows 2 that a tuple containing the payload value from above is emitted on the ReceivedMessage stream.

  6. In window 3, type the following command to terminate the server and dequeuer:

    sbadmin shutdown

Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

  • From the top menu, click File → Load StreamBase Sample.

  • Select this sample from the Embedded Input Adapters list.

  • Click OK.

StreamBase Studio creates a project for this sample.

Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids the permission problems that can occur when trying to work with the initially installed location of the sample. The default workspace location for this sample is: 

studio-workspace/sample_ibm-websphere-mq

See Default Installation Directories for the location of studio-workspace on your system.

In the default TIBCO StreamBase installation, this sample's files are initially installed in: 

streambase-install-dir/sample/ibm-websphere-mq

See Default Installation Directories for the location of streambase-install-dir on your system. This location may require administrator privileges for write access, depending on your platform.