Running the Address Book sample

Running the Address Book sample consists of putting messages through the consumer message flow or calling the provider flow directly. Two Test Clients are provided for running the Address Book sample.

Before you run the sample, verify that your Web services consumer is configured correctly for the provider and that JNDI administered objects are configured to run JMS flows. See Setting up the Address Book sample to use HTTP and Setting up the Address Book sample to use JMS transport.

If you encounter any problems when you run the sample, see Resolving problems when running samples in the IBM Integration Bus documentation.

Verifying that the provider has the correct port for the consumer

SOAP over HTTP:
The default port that Web services use is 7800, and the SOAPRequest nodes are set up to use this port. However, if this port is already in use, the port number is incremented by one.

Issue the following mqsireportproperties command to check which port your provider execution group is using:
```
mqsireportproperties IB9NODE -e AddressSampleProvider -o HTTPConnector -n port
```
If you want to verify that your Web services consumer is configured correctly, complete all of the following instructions. If you have set up a TCP/IP Monitor, you have already checked which port the Web services provider is using, but you must still configure the consumer to send the messages to your TCP/IP Monitor and then build and redeploy the broker archive (BAR) file.

To verify that the port that the SOAPRequest nodes are using is the correct port to call the provider flow, change the port of the SOAPRequest nodes to the port that the provider execution group is using by completing the following steps:
1. Open the AddressBookConsumerFlow located in the AddressBook project.
  Perform this step for both of your SOAPRequest nodes.
2. Open the HTTP Transport tab in the Properties view. If the port is correct, you have finished setting up the Address Book sample. If the port is not correct, change the port in the Web service URL field to the correct port for your Web services provider or for your TCP/IP Monitor.
3. Save the message flow. You must now rebuild and redeploy the BAR file.
The sample can be run with or without the TCP/IP Monitor enabled to intercept the SOAP message. The following instructions cover both cases.
SOAP over JMS:
Ensure that JNDI Administered objects are created, as described in Setting up the Address Book sample to use JMS transport. Also ensure that JNDI properties are set on SOAPInput and SOAPRequest nodes. Verify that the following WebSphere MQ queues are created, either through the WebSphere MQ Explorer or the WebSphere MQ command console.
- JMSREQUESTQ
- JMSREPLYQ

Running the sample

How to call the consumer flow, which in turn calls the provider flow:

In the Application Development view, expand the AddressBook project.
Expand Flow Tests. Double-click AddressBookTests.mbtest to open the file in the Test Client.
Select the first Enqueue. Click Send Message.
If you have not enabled the TCP/IP Monitor you can skip this step. Otherwise, with the TCP/IP Monitor set up and started, the monitor is displayed and shows the SOAP message that has been transmitted between the provider and consumer flow.
If the monitor is not displayed, you can add it to your workbench now: Click Window > Show View > Other > Debug > TCP/IP Monitor.

Check the contents of the inbound and outbound SOAP messages. If you want to make the message easier to read, use the menu in the TCP/IP Monitor to change the format from Byte to XML.
Select the first Dequeue. Click Get Message. You now see both the HTTP response from the SOAPRequest node and the XML message. The following response is displayed:
```
<SOAP_Domain_Msg>
<Body>
<NS2:SaveAddressResponse xmlns:NS2="http://addressbook.com/">true<NS2:SaveAddressResponse>
<Body>
<SOAP_Domain_Msg>
```
Select the second Enqueue and click Send Message.
If you have not enabled the TCP/IP Monitor, you can skip this step. Otherwise, check the TCP/IP Monitor to ensure that the SOAP message has been transmitted.

Select the second Dequeue and click Get Message. You now see the HTTP response from the SOAPRequest node and the XML message. You get the following response:

<SOAP_Domain_Msg>
<Body>
<NS2:Address xmlns:NS2="http://addressbook.com/">
<NS2:City>Carlisle</NS2:City>
<NS2:Street>Welton</NS2:Street>
<NS2:Province>Cumbria</NS2:Province>
<NS2:PostalCode>NE2 3HP</NS2:PostalCode>
<NS2:PhoneNumber>
<NS2:Area>1</NS2:Area>
<NS2:Prefix>2</NS2:Prefix>
<NS2:Local>3</NS2:Local>
</NS2:PhoneNumber>
</NS2:Address>
<Body>
<SOAP_Domain_Msg>

To call the provider flow directly in the case of SOAP over HTTP:

In the Application Development view, expand the AddressBook project.
Expand Flow Tests. Double-click AddressBookProviderTest.mbtest to open the file in the Test Client.
Click Send Message.
In the Deployment Location window, select the AddressSampleProvider execution group. Click Finish. The message flow is deployed to the selected execution group, and the test message is sent. You get the following output when the response is received:
Before calling the flow again, to look up the address that you just saved you must prevent the Test Client from redeploying the flow. Redeploying the flow destroys any data in the ESQL shared variable that is used by the address book. To prevent the Test Client from redeploying the flow, select the Configuration tab of the Test Client; select Deployment in the left pane. Select I will deploy the specified Broker Archive manually. Enter the name of the BAR file and save your changes. Go back to the Events tab.
Select the second Invoke Message Flow and click Send Message. If required, select the AddressSampleProvider execution group. Click Finish.
Compare the responses with the output from the consumer. You get the following output when the response is received:

If you have finished with this sample and had previously enabled the TCP/IP Monitor and modified the flow, you must now remove the TCP/IP monitor and change the flow back.

In the workbench, click Window > Preferences > Run/Debug > TCP/IP Monitor.
Highlight your TCP/IP monitor and click Remove followed by OK.
You updated the AddressBookConsumerFlow to interact with the TCP/IP Monitor so, depending on what you now want to do, you can choose to leave the modified flow alone or change it back. If you want to change it back, follow the same steps as before, but change the HTTP port from 5555 back to 7800 in both of the SOAPRequest nodes, and then rebuild and redeploy.

Back to sample home