Configuring, testing and enabling the trace for the WebSphere MQ Bridge for HTTP in WebSphere Application Server V7 and later. IBM Techdoc:

Transcription

1 Page 1 of 29 Configuring, testing and enabling the trace for the WebSphere MQ Bridge for HTTP in WebSphere Application Server V7 and later IBM Techdoc: Updates 10-Jul-2017 Date last updated: 10-Jul-2017 Angel Rivera rivera@us.ibm.com IBM WebSphere MQ Support 1: The IBM MQ bridge for HTTP is deprecated. /q118300_.htm IBM MQ > Product overview > What's changed in IBM MQ Version The IBM MQ bridge for HTTP is deprecated. The WebSockets support that is provided by the IBM Messaging Client for JavaScript should be used as an alternative. 2: Mapping of HTTP verbs and MQ actions: An HTTP POST puts a message to the named queue. An HTTP DELETE removes a message from the queue, and the message is sent to the requesting client. An HTTP GET call will get a message from the queue, and return the message to the requesting client, however the message will remain on the queue. So in MQ terms: - the DELETE is the equivalent of a destructive get, and - the GET is the equivalent of a browse. When using HTTP GET to perform a browse from a web browser, the first message on the queue will be returned. +++ Objective The objective of this technical document is to describe in detail how to configure the WebSphere MQ Bridge for HTTP V7 when using WebSphere Application Server V7. In addition, there are steps to test the servlet via a web browser and to use the provided samples. Finally, there are instructions on how to enable the tracing.

2 Page 2 of 29 The Bridge for HTTP component is shipped with the MQ V7 code and it is fully supported by MQ Support. In contrast, this document does NOT cover the following SupportPac, which is NOT supported by MQ Support. MA0Y: IBM WebSphere MQ Bridge for HTTP This SupportPac is: Category 2 - SupportPacs are provided in good faith and AS-IS. There is no warranty or further service implied or committed and any supplied sample code is not supported via IBM product service channels. The location of the Bridge for HTTP war file and the corresponding Java samples is: Windows (MQ 7): War file: C:\Program Files\IBM\WebSphere MQ\java\lib\http\WMQHTTP.war Samples: C:\Program Files\IBM\WebSphere MQ\tools\http\samples UNIX (MQ 7) War file: /opt/mqm/java/http/wmqhttp.war Samples: /opt/mqm/java/http/samples This techdoc has the following chapters: Chapter 1: Setup the receiving queue manager and test it Chapter 2: Configuration in WAS - connection factory Chapter 3: Deploying the MQ Bridge for HTTP on WAS Chapter 4: Testing the retrieval of messages Chapter 5: Running the samples HTTPPOST (to put) and HTTPDELETE (to get) Chapter 6: How to enable tracing Chapter 7: Troubleshooting +++ Software used: + MQ 7 Host: Linux SLES 11 WebSphere MQ:

3 Page 3 of 29 Queue Manager: QM_VER Port for the MQ Listener: 1414 Queue: HTTPTESTQ Server Connection Channel: MYSVRCON WebSphere Application Server: Host: Windows XP Web Browser (IE V8). +++ References Redbook: WebSphere MQ V7.0 Features and Enhancements (SG ) Chapter 10: WebSphere MQ Bridge for HTTP

4 Page 4 of Chapter 1: Setup the receiving queue manager and test it This chapter shows the implementation of the steps mentioned in the MQ V7 Information Center WebSphere MQ > Web services >> WebSphere MQ bridge for HTTP Create a dedicated queue in a Queue Manager: $ runmqsc QM_VER define QL(HTTPTESTQ) define channel(mysvrconn) chltype(svrconn) trptype(tcp) Test that you can put/get a message into the queue using the channel: $ export MQSERVER=MYSVRCONN/TCP/'veracruz.x.com(1414)' $ amqsputc HTTPTESTQ QM_VER Sample AMQSPUT0 start target queue is HTTPTESTQ FIRST-MESSAGE Sample AMQSPUT0 end $ amqsgetc HTTPTESTQ QM_VER Sample AMQSGET0 start message <FIRST-MESSAGE> no more messages Sample AMQSGET0 end Because amqsgetc did a destructive get, the message is no longer in the queue. In order to test later on the servlet, it is necessary to put another message into the queue: $ amqsputc HTTPTESTQ QM_VER target queue is HTTPTESTQ SECOND-MESSAGE At this time, the queue has 1 message, ready for the servlet.

5 Page 5 of Chapter 2: Configuration in WAS - connection factory Create a connection factory: Name: WMQHTTPBridge JNDI Name: jms/wmqhttpjcaconnectionfactory Queue manager: QM1 Host: veracruz.x.com Port: 1414 Channel: MYSVRCON Transport type: CLIENT 1. In the navigation panel of the WAS Administrative Console, click Resources > JMS > Connection Factories. You can configure at Node, Cell, or Server level, depending on your WebSphere Application Server deployment. The example uses Server level deployment. On the right panel, click on New.

6 Page 6 of 29 Specify "WebSphere MQ messaging provider". Click OK. Accept the default, click Next.

7 Page 7 of 29 Enter the Queue Manager Name. In this case it is "QM_VER". Click Next. Enter the values, then click Next.

8 Page 8 of 29 Ensure to click the button to Test the Connection: You should see a successful test:

9 Page 9 of 29 WARNING!! If you do NOT see a successful connection, then STOP and fix the problem before proceeding (correct values? Queue manager running? If you delay fixing the problem, the problem determination tasks later on could be longer and convoluted.

10 Page 10 of 29 After a successful connection, proceed to create the Connection Factory: Click "Save" to save the configuration changes:

11 Page 11 of 29 At this point, you MUST restart the WAS server: any time that you create or edit JMS resources, you need to restart the WAS server in order for those changes to take effect. Otherwise, you will get errors later on indicating that the JMS resources are not available or that they had incorrect values.

12 Page 12 of Chapter 3: Deploying the MQ Bridge for HTTP on WAS The steps mentioned in this chapter are based on the procedure mentioned in the following web page of the MQ V7 Information Center WebSphere MQ > Web services > WebSphere MQ bridge for HTTP > Installing, configuring, and verifying >> Deploying and verifying WebSphere MQ bridge for HTTP on WebSphere Application Server V The mentioned section does not have screen shots. This techdoc shows the screen shots for all the steps, in that way you can get a visual representation of the steps. In the navigation pane, click Applications > New Application Then "New Enterprise Application"

13 Page 13 of 29 You will need to specify the full path name of the war file: In this case it is from Windows: C:\Program Files\IBM\WebSphere MQ\java\lib\http\WMQHTTP.war Insert the path to WMQHTTP.war into the form, and provide a Context root, click Next. Specify " Detailed - Show all installation options and parameters" Click Next.

14 Page 14 of 29 The following "Application Security Warnings" will be displayed. Click Continue: For Step 1, accept the defaults and continue. Continue with Steps 2 thru Step 5.

15 Page 15 of 29 At Step 6, you may want to customize the Servlet, in case that you did not use the Connection factory that was recommended in this document. You could also modify the maximum_wait_time (default milliseconds)

16 Page 16 of 29 In "Step 7: Map resource references to resources", in the field "Target Resource JNDI Name" enter: jms/wmqhttpjcaconnectionfactory Continue with Step 8 and 9. In "Step 9: Map context roots for Web modules", for the "Context Root" enter: /mq

17 Page 17 of 29 The Context root forms part of the URI identifying WebSphere MQ bridge for HTTP. At Step 10, Summary, click Finish.

18 Page 18 of 29 You need to check that the deployment was successful: ADMA5013I: Application WMQHTTP_war installed successfully. Application WMQHTTP_war installed successfully. Then click on "Save".

19 Page 19 of 29 In the navigation pane, click Applications > Enterprise Applications. Check the selection box for WMQHTTP.war, click Start.

20 Page 20 of 29 Verify the message that the application started successfully: Application WMQHTTP_war on server server1 and node veracruznode01 started successfully.

21 Page 21 of Chapter 4: Testing the retrieval of messages Earlier in the steps in this document, a message was placed into the queue HTTPTESTQ, with the text: SECOND-MESSAGE To test the servlet, you need to specify the following in a web browser: Notice the following: port is 9080 suffix for the link to indicate queue: /mq/msg/queue/httptestq The general syntax for the HTTP URI is: For Queues: For Topics: After you enter the above URL in a web browser, the servlet should read the message from the mentioned queue and display its contents. Early on, during the test of the HTTPTESTQ via amqsput, a message was placed in the queue. Now the servlet will read it: SECOND-MESSAGE The servlet is doing a BROWSE on the message and it is NOT deleting the message from the queue.

22 Page 22 of 29 Thus, if you invoke the servlet again, you will be browsing the same message, until an application does a normal GET (deleting the message from the queue). Notice that if there are no messages in the queue, you will see the following: MQHTTP50401: Message retrieval timed out.

23 Page 23 of Chapter 5: Running the samples HTTPPOST (to put) and HTTPDELETE (to get) WebSphere MQ > Web services > WebSphere MQ bridge for HTTP >> Running the WebSphere MQ Bridge for HTTP samples + Location of the samples - In Windows 7: C:\> cd "C:\Program Files\IBM\WebSphere MQ\tools\http\samples" - In Windows 7: C:\> cd "C:\Program Files\IBM\MQ\tools\http\samples" - In UNIX: cd /opt/mqm/java/http/samples Notice, that after the line for "Target context-root" the servlet will wait for you to enter the text, like in amqsput or amqsputc. After you enter the text and press Enter, then you can enter another text for the next message, and so. To exit, you need to press Enter by itself in the line. + To Put a message: C:\Program Files\IBM\WebSphere MQ\tools\http\samples > java -classpath. HTTPPOST HTTPTESTQ veracruz.x.com:9080 mq HTTPTESTQ veracruz.x.com:9080 mq HTTP POST Sample start Target server is 'veracruz.x.com:9080' Target queue is 'HTTPTESTQ' Target context-root is 'mq' THIRD-MESSAGE HTTP POST Sample end + To Get a message: C:\Program Files\IBM\WebSphere MQ\tools\http\samples> java -classpath. HTTPDELETE HTTPTESTQ veracruz.x.com:9080 mq HTTP DELETE Sample start Target server is 'veracruz.x.com:9080'

24 Page 24 of 29 Target queue is 'HTTPTESTQ' Target context-root is 'mq' THIRD-MESSAGE timestamp = Fri, 23 Sep :06:51 GMT expiry = UNLIMITED persistence = NON_PERSISTENT No more messages HTTP DELETE Sample end

25 Page 25 of Chapter 6: How to enable tracing You will need to use a Generic JVM argument/property (this is described later on) Specify the JVM property: -Dwmqhttp.trace.props=config_file_name Where config_file_name references a plain text file with contents: First, create a local file which will have certain properties to control the tracing. For example: /var/mqm/bridge-http/bridge-http-prop.txt This file has 3 parameters for the Bridge. The property tracedestination needs to be a file name, not just a directory name. It can also be System.out or System.err to route to the STDOUT/STDERR streams. In the following example, the traces will be placed in the file: /var/mqm/bridge-http/bridge-trace.log. + begin quote traceenabled=true tracelevel=all tracedestination=/var/mqm/bridge-http/bridge-trace.log + end quote This is the sequence to specify to the WAS server the location of the above file: Click on Servers > Application Servers > server1. Then, under Server Infrastructure, Click Java and Process Management > Process definition Then select Java Virtual Machine Under Generic JVM arguments Enter: -Dwmqhttp.trace.props=/var/mqm/bridge-http/bridge-http-prop.txt

26 Page 26 of 29 Click OK. Click Save. Restart the WAS server for the changes to be picked up.

27 Page 27 of Chapter 7: Troubleshooting Problem: Trying to do an HTTPPOST but the servlet is not running. C:\Program Files\IBM\WebSphere MQ\tools\http\samples> java -classpath. HTTPPOST HTTPTESTQ veracruz.x.com:9080 mq HTTP POST Sample start Target server is 'veracruz.x.com:9080' Target queue is 'HTTPTESTQ' Target context-root is 'mq' THIRD-MESSAGE There has been an error trying to POST a message to ' HTTP error response follows... <H1>SRVE0255E: A WebGroup/Virtual Host to handle /mq/msg/queue/httptestq has not been defined.</h1><br><h3>srve0255e: A WebGroup/Virtual Host to handle veracruz.x.com:9080 has not been defined.</h3><br><i>ibm WebSphere Applic ation Server</I> HTTP POST Sample end

28 Page 28 of 29 Most likely reason: The application "WMQHTTP_war " is not running in WAS. You need to select the application and click on the "Start" button.

29 Page 29 of 29 After the application has started and the "Application Status" changes to Green: then try the sample again: C:\Program Files\IBM\WebSphere MQ\tools\http\samples> java -classpath. HTTPPOST HTTPTESTQ veracruz.x.com:9080 mq HTTP POST Sample start Target server is 'veracruz.x.com:9080' Target queue is 'HTTPTESTQ' Target context-root is 'mq' THIRD_MESSAGE HTTP POST Sample end +++ end +++