Message Driven Bean In Liberty Profile V8.5...WP102363 – Message Driven Bean In Liberty Profile...

WebSphere Application Server for z/OS Version 8.5.5

Message Driven BeanIn Liberty Profile V8.5.5

This document can be found on the web at:www.ibm.com/support/techdocs

Search for document number WP102363 under the category of "White Papers"

Version Date: November 4, 2013See "Document Change History" on page 20 for a description of the changes in this version of the document

John CowelIBM Certified IT Specialist

[email protected]

IBM IOT East andIBM Advanced Technical Skills

WP102363 – Message Driven Bean In Liberty Profile V8.5.5

Many thanks to the following people for their assistance and contributions to this effort:

Mike Loos - Washington Systems Center

Mitch Johnson - Washington Systems Center

Lee-Win Tai - Washington Systems Center

Don Bagwell - Washington Systems Center

Mike Cox - Washington Systems Center

© 2013, IBM CorporationIBM Americas Advanced Technical Skills - 2 -

ibm.com/support/techdocsVersion Date: Monday, November 04, 2013


Table of ContentsOverview of Environment........................................................................................................4

Software Environment........................................................................................................................4Overview of Sample Enterprise Applications........................................................................5

MDBDriver.ear....................................................................................................................................5MDBListener.ear.................................................................................................................................6

Liberty Server Configuration...................................................................................................7Definition of Liberty Server.................................................................................................................7Configure Liberty server for CLIENT Mode Connection to MQ...........................................................7Configure Liberty server for BINDINGS Mode Connection to MQ.......................................................9Define Enterprise Applications..........................................................................................................10

Execute Sample Enterprise Applications............................................................................11MDBDriver........................................................................................................................................ 11MDBListener.....................................................................................................................................12

Appendix A – Complete server.xml for Client Mode...........................................................14Appendix B – Complete server.xml for BINDINGS Mode...................................................16Document Change History....................................................................................................18




Overview of EnvironmentThis White Paper is intended to facilitate initial testing of a simple Message Driven Bean (MDB) enterprise application in WebSphere Application Server for z/OS V8.5.5 Liberty Profile with WebSphere MQ V7.1. The enterprise applications associated with this document make use of the JMS feature of WebSphere MQ to support both JMS and MDB components deployed in the WebSphere z/OS Liberty Profile run-time environment.

The setup instructions for the enterprise applications outlined in this document do not make use of the Embedded Messaging Server or a Service Integration Bus (SIBus), both of which are elements of WebSphere z/OS V8.5.5 Liberty Profile. Although the Embedded Messaging Server or SIBus could be used for this purpose, the intent is to configure and test using an external MQ JMS provider.

This document outlines both CLIENT and BINDINGS mode connections to WebSphere MQ, For BINDINGS mode it is assumed you already have WebSphere MQ installed in the same LPAR as WebSphere Application Server.

Two queues need to be defined to WebSphere MQ. They should be defined as PERSISTENT, with GET and PUT ENABLED and also should be marked SHARE. You may name the queues whateveryou wish. The instructions for defining these queues to WebSphere MQ are not included in this document.

Given the instructions in this document, a WebSphere Systems Programmer or Application Developer may simply take the EAR files included and use them to test the run-time infrastructure. The EAR files contain source code. The EAR files may be imported into IBM Rational Application Developer (RAD) so you may browse the applications to ensure they do nothing malicious, or use them as a starting point for future development of MDB applications. These applications were written to be very simple so the focus would be on the customization and configuration of JMS and MDB infrastructures in WebSphere Liberty Profile.

Software Environment

Application Development EnvironmentIBM Rational® Application Developer™ for WebSphere® Software

Version: 9.0.0

Build ID: RADO90-I20130531_1619

z/OS Environment

Product Version Service Level

z/OS V1.13 PUT1305

WebSphere application Server V8.5.5 8.5.5.0

WebSphere MQ V7.1.0 07/01/00




Overview of Sample Enterprise ApplicationsThe drawing below shows a high level overview of the interaction between the two enterprise applications:

MDBDriver.ear

This is a very simple application that consists of a web component that puts one or more messages to an MQ queue.

If application MDBListener is not deployed, the MDBDriver application may also be used to retrieve the message(s) put to the MQ queue.

This application deployed alone could be used to verify all the plumbing is in place to communicate with WebSphere MQ. Without an MDB the activation specification will not be exercised.

Application artifacts:

index.jsp Default page of application

putMsgs.jsp Put message(s) on MQ queue

MDBDriverServlet.java Java servlet to put/get message(s) on MQ queue using JMS API. Accepts input from jsp's and forwards results to jsp's.

The message put on the queue is based on the text passed from the jsp. The servlet name is added to the beginning of the message before it is put on the queue.

getMsgs.jsp Get message(s) from MQ queue – if MDBListener.ear is not deployed

displayResults.jps Display message(s) retrieved from MQ queue – if MDBListener.ear is not deployed




MDBListener.ear

This application consists of both a web component and an EJB component. The artifacts of thisapplication are:

EJB Component

MDBListenerEJBBean.java This Message Driven Bean makes use of an Activation Specification to retrieve messages from an MQ queue as opposed to a Listener Port.

The Activation Specification is notified when a message shows up onthe Destination to which the Activation Specification is listening - the output queue of the MDBDriver application - and presents the message to the onMessage method of the MDB.

The MDB extracts the text of the message, adds the EJB name to thebeginning of the message, then writes the message to an output queue (another MQ queue) using JMS API.

This MDB is written at spec level 3.1.

Web Component

index.jsp Default page of application

getMsgs.jsp Get message(s) from MDBlistenerEJBBean output queue

MDBListenerServlet.java Java servlet to get message(s) from MQ queue using JMS API.These message(s) were put on the queue by the Message Driven Bean.

displayResults.jsp Display message(s) retrieved from MDBlistenerEJBBean output queue




Liberty Server ConfigurationDefinition of Liberty Server

As stated earlier, this White Paper is intended to facilitate initial testing of a simple Message Driven Bean (MDB) enterprise application in WebSphere Application Server for z/OS V8.5.5 Liberty Profile with WebSphere MQ V7.1. For instructions to define/create a Liberty Server, referto WP102110 WAS V8.5 Liberty Quick Start Guide1.

The following sections in this document outline the necessary modifications to your Liberty Server for the execution of the sample Message Driven Bean applications. A complete copy of server.xml for both CLIENT and BINDINGS mode may be found in Appendix A and AppendixB respectively.

Configure Liberty server for CLIENT Mode Connection to MQ

This section outlines the necessary updates to server.xml for connection to MQ using CLIENT mode.

Feature Manager updates:

<featureManager> <feature>servlet-3.0</feature> <feature>jsp-2.2</feature> <feature>ejbLite-3.1</feature> <feature>jmsMdb-3.1</feature> <feature>wmqJmsClient-1.1</feature> <feature>jndi-1.0</feature></featureManager>

In order to connect to WebSphere MQ from the Liberty Profile, the WebSphere MQ Resource Adapter must be used - wmq.jmsra.rar. The Liberty Profile does not contain the WebSphere MQ Resource Adapter. At the time this document was written, the wmq.jmsra.rar file from MQ does not work, nor does the file that ships with WebSphere. This rar file must be obtained separately. Information about obtaining the appropriate WebSphere MQ Resource Adapter maybe found at the following web site:

http://www-01.ibm.com/support/docview.wss?uid=swg21633761

Place the following statement in server.xml to point to this file:

<variable name="wmqJmsClient.rar.location" value="/<rar_location>/wmq.jmsra.rar"/>

Define the Queue Connection Factory:

<jmsQueueConnectionFactory jndiName="jms/MQ_MDBQCF"> <properties.wmqJms transportType="CLIENT" hostname="<host>" port="<port>" channel="<channel>" queueManager="<qmgr>"/> <connectionManager maxPoolSize="10"/></jmsQueueConnectionFactory>

1 http://www.ibm.com/support/techdocs/atsmastr.nsf/WebIndex/WP102110© 2013, IBM CorporationIBM Americas Advanced Technical Skills - 7 -


http://www-03.ibm.com/support/techdocs/atsmastr.nsf/WebIndex/WP102110



Define the MQ Queues:

<jmsQueue id="MQ_MDBDriverQ" jndiName="jms/MQ_MDBDriverQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/></jmsQueue>

<jmsQueue id="MQ_MDBListenerQ" jndiName="jms/MQ_MDBListenerQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/></jmsQueue>

Define the Activation Specification:

<jmsActivationSpec id="MDBListener/MDBListenerEJB/MDBListenerEJBBean"> <properties.wmqJms destinationRef="MQ_MDBDriverQ" transportType="CLIENT" hostname="<host>" port="<port>" queueManager="<qmgr>"/></jmsActivationSpec>

Here is a snippet of messages you will see in log(s) after the server is started when configured for CLIENT mode connection to MQ:

Messages from /<wlp_user_dir>/servers/<server_name>/logs/messages.log

CWWKE0001I: The server <server_name> has been launched.CWWKB0101I: The angel process is not available. No authorized services will be loaded.CWWKB0104I: Authorized service group SAFCRED is not available.CWWKB0104I: Authorized service group TXRRS is not available.CWWKB0104I: Authorized service group ZOSDUMP is not available.CWWKB0104I: Authorized service group ZOSWLM is not available.CWWKB0108I: IBM product WAS FOR Z/OS version 8.5 successfully registered with z/OS.CWWKE0002I: The kernel started after 1.435 secondsCWWKF0007I: Feature update started.CWWKO0219I: TCP Channel defaultHttpEndpoint has been started and is now listening for requests on host * (IPv4) port <port#>.CWWKZ0058I: Monitoring dropins for applications. CWWKF0008I: Feature update completed in 2.118 seconds.CWWKF0011I: The server <server_name> is ready to run a smarter planet.

Messages from STDOUT (if server was started from a PROC):

Launching <server_name> (WebSphere Application Server 8.5.5.0, ... ÝAUDIT ¨ CWWKE0001I: The server <server_name> has been launched.ÝAUDIT ¨ CWWKZ0058I: Monitoring dropins for applications.ÝAUDIT ¨ CWWKF0011I: The server <server_name> is ready to run a smarter planet.




Configure Liberty server for BINDINGS Mode Connection to MQ

This section outlines the necessary updates to server.xml for connection to MQ using BINDINGS mode.

Connectiing to MQ from Liberty using BINDINGS mode will require that you configure the “Angel” process. For information about this refer again to WP102110 in the section 'Overview of the “Angel” process'.

Feature Manager updates:

<featureManager> <feature>servlet-3.0</feature> <feature>jsp-2.2</feature> <feature>ejbLite-3.1</feature> <feature>jmsMdb-3.1</feature> <feature>wmqJmsClient-1.1</feature> <feature>jndi-1.0</feature> <feature>zosTransaction-1.0</feature></featureManager>

In order to connect to WebSphere MQ from the Liberty Profile, the WebSphere MQ Resource Adapter must be used - wmq.jmsra.rar. The Liberty Profile does not contain the WebSphere MQ Resource Adapter. At the time this document was written, the wmq.jmsra.rar file from MQ does not work, nor does the file that ships with WebSphere. This rar file must be obtained separately. Information about obtaining the appropriate WebSphere MQ Resource Adapter may be found at the following web site:


Place the following statement in server.xml to point to this file:

<variable name="wmqJmsClient.rar.location"

value="/<rar_location>/wmq.jmsra.rar"/>

To allow JMS applications to connect in BINDINGS mode, define the <nativeLibraryPath> to specify the location of the WebSphere MQ native libraries:

<wmqJmsClient nativeLibraryPath="/<mq_home>/java/lib"/>

Define the Queue Connection Factory:

<jmsQueueConnectionFactory jndiName="jms/MQ_MDBQCF"> <properties.wmqJms transportType="BINDINGS" queueManager="<qmgr>"/> <connectionManager maxPoolSize="10"/></jmsQueueConnectionFactory>

Define the MQ Queues:

<jmsQueue id="MQ_MDBDriverQ" jndiName="jms/MQ_MDBDriverQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/></jmsQueue>

<jmsQueue id="MQ_MDBListenerQ" jndiName="jms/MQ_MDBListenerQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/></jmsQueue>





Define the Activation Specification:

<jmsActivationSpec id="MDBListener/MDBListenerEJB/MDBListenerEJBBean"> <properties.wmqJms destinationRef="MQ_MDBDriverQ" transportType="BINDINGS" queueManager="<qmgr>"/></jmsActivationSpec>

Here is a snippet of messages you will see in log(s) after the server is started when configured for BINDINGS mode connection to MQ:

Messages from /<wlp_user_dir>/servers/<server_name>/logs/messages.log

CWWKE0001I: The server <server_name> has been launched.CWWKB0104I: Authorized service group SAFCRED is available.CWWKB0104I: Authorized service group TXRRS is available.CWWKB0104I: Authorized service group ZOSDUMP is available.CWWKB0104I: Authorized service group ZOSWLM is available.CWWKB0108I: IBM product WAS FOR Z/OS version 8.5 successfully registered withz/OS.CWWKE0002I: The kernel started after 1.480 secondsCWWKF0007I: Feature update started.CWWKO0219I: TCP Channel defaultHttpEndpoint has been started and is now listening for requests on host * (IPv4) port <port#>.CWLIB0103I: Resource manager BBG.DEFAULT.CBD9FCE63E7ED424.IBM with thecorresponding token ID of 01000001025710000000001200000013 has successfully restarted with Resource Recovery Services (RRS). Number of unresolved units of recovery: 0CWLIB0104I: Recovery processing for resource manager BBG.DEFAULT.CBD9FCE63E7ED424.IBM with the corresponding token ID of 01000001025710000000001200000013 has completed.CWWKZ0058I: Monitoring dropins for applications. CWWKF0008I: Feature update completed in 2.203 seconds.CWWKF0011I: The server <server_name> is ready to run a smarter planet.

Messages from STDOUT (if server was started from a PROC):

Launching <server_name> (WebSphere Application Server 8.5.5.0, ... ÝAUDIT ¨ CWWKE0001I: The server <server_name> has been launched.ÝAUDIT ¨ CWWKZ0058I: Monitoring dropins for applications.ÝAUDIT ¨ CWWKF0011I: The server <server_name> is ready to run a smarter planet.

Define Enterprise Applications

The following statements will cause the applications to be deployed upon startup of the server (these statements are valid for either CLIENT or BINDINGS mode):

<application location="${shared.app.dir}/MDBDriver.ear" context-root="MDBDriverWeb" type="ear" id="MDBDriver" name="MDBDriver" />

<application location="${shared.app.dir}/MDBListener.ear" context-root="MDBListenerWeb" type="ear" id="MDBListener" name="MDBListener" />




Execute Sample Enterprise ApplicationsMDBDriver

To execute the MDBDriver application, open a browser and enter the following url:

http://your.host.com:port/MDBDriverWeb

You will see a screen that looks like:

Click Put Messages on MDBDriver Queue

On this screen you may change the text of the message and/or specify the number of messagesyou want to be put on the queue. Once you have filled in the fields, press Put Message(s). Thiswill put the message(s) on the MQ_MDBDriverQ queue with MDBDriverServlet prepended to the message(s).




You will notice a link to Get Messages from MDBDriver Queue. If you click on this link, the MDBDriver application will attempt to retrieve any messages from queue MQ_MDBDriverQ. This link will work, but if you have deployed the MDBListener application there will be no messages on this queue because they will have been delivered to the Message Driven Bean in the MDBListener application via the Activation Specification that has been defined in the environment.

MDBListener

To execute the MDBListener application, open a browser and enter the following url:

http://your.host.com:port/MDBListenerWeb

You will see a screen that looks like:

Click Get Messages from MDBListenerEJB Output Queue.

On the resulting screen you may choose the number of messages to get from the queue – All (the default) or some number from 1 to n:




Once you have chosen how many messages to get, click GET Message(s). You will see a screen similar to the following:



Appendix A – Complete server.xml for Client Mode<server description="<server_name>">

<featureManager> <feature>servlet-3.0</feature> <feature>jsp-2.2</feature> <feature>ejbLite-3.1</feature> <feature>jmsMdb-3.1</feature> <feature>wmqJmsClient-1.1</feature> <feature>jndi-1.0</feature> </featureManager>



         


    <jmsQueueConnectionFactory jndiName="jms/MQ_MDBQCF"> <properties.wmqJms transportType="CLIENT" hostname="<host>" port="<port>" channel="<channel>" queueManager="<qmgr>"/> <connectionManager maxPoolSize="10"/> </jmsQueueConnectionFactory>

   

<jmsQueue id="MQ_MDBDriverQ" jndiName="jms/MQ_MDBDriverQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/> </jmsQueue>

<jmsQueue id="MQ_MDBListenerQ" jndiName="jms/MQ_MDBListenerQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/> </jmsQueue>

   

<jmsActivationSpec id="MDBListener/MDBListenerEJB/MDBListenerEJBBean"> <properties.wmqJms destinationRef="MQ_MDBDriverQ" transportType="CLIENT" hostname="<host>" port="<port>" queueManager="<qmgr>"/> </jmsActivationSpec>





</server>

Appendix B – Complete server.xml for BINDINGS Mode<server description="<server_name>">

<featureManager> <feature>servlet-3.0</feature> <feature>jsp-2.2</feature> <feature>ejbLite-3.1</feature> <feature>jmsMdb-3.1</feature> <feature>wmqJmsClient-1.1</feature> <feature>jndi-1.0</feature> <feature>zosTransaction-1.0</feature> </featureManager>



          


    

<wmqJmsClient nativeLibraryPath="/<mq_home>/java/lib"/>

    <jmsQueueConnectionFactory jndiName="jms/MQ_MDBQCF"> <properties.wmqJms transportType="BINDINGS" queueManager="<qmgr>"/> <connectionManager maxPoolSize="10"/> </jmsQueueConnectionFactory>

   



http://www-01.ibm.com/support/

<jmsQueue id="MQ_MDBDriverQ" jndiName="jms/MQ_MDBDriverQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/> </jmsQueue>

<jmsQueue id="MQ_MDBListenerQ" jndiName="jms/MQ_MDBListenerQ"> <properties.wmqJms baseQueueName="<queue_name>" baseQueueManagerName="<qmgr>"/> </jmsQueue>

   

<jmsActivationSpec id="MDBListener/MDBListenerEJB/MDBListenerEJBBean"> <properties.wmqJms destinationRef="MQ_MDBDriverQ" transportType="BINDINGS" queueManager="<qmgr>"/> </jmsActivationSpec>





</server>


Document Change HistoryCheck the date in the footer of the document for the version of the document.

11/01/13 Original document.

11/04/13 Republished with assigned WP102363 document number

End of WP102363



Message Driven Bean In Liberty Profile V8.5...WP102363 – Message Driven Bean In Liberty Profile...

Documents

Transcript of Message Driven Bean In Liberty Profile V8.5...WP102363 – Message Driven Bean In Liberty Profile...