Introduction

This article introduces J2EE developers to the steps involved in building a simple solution to showcase integration between WebSphere Enterprise Service Bus V7 (hereafter called Service Bus) and WebSphere Service Registry and Repository V7 (hereafter called Service Registry). The development tooling of choice will be WebSphere Integration Developer V7 (hereafter called Integration Developer).

Service Registry is a central repository used to manage reusable service documents, including Web Services Description Language (WSDL), Service Component Definition Language (SCDL), Extensible Markup Language (XML), and XML Schema Definition (XSD) document types. The said service documents can be used as building blocks to develop composite applications that can be deployed on the Service Bus runtime.

The enterprise service bus of choice will be Service Bus, which is a runtime environment based on WebSphere Application Server (hereafter known as WAS). The mediation layer in Service Bus is used to execute mediation flows comprising of mediation primitives, which provides pre-built functionality to facilitate the rapid construction of integration solutions. One such mediation primitive is Endpoint Lookup, which we will be using to query the Service Registry from within a mediation flow.

The summary of steps we will take to complete this solution is to first create a backend service that resides on Service Bus, followed by defining the mediation flow that performs the lookup against Service Registry. This mediation flow will run on the same Service Bus runtime as the backend service. Lastly, we will create a Java API for XML Web Services (JAX-WS) JavaServer Page (JSP) based web service client to test the integration scenario.

Pre-requisites

Before proceeding with steps in this article, the following pre-requisites will have to be met:

• Integration Developer is installed on a Windows operating environment.
• Service Bus is installed with either a single server or clustered configuration and relevant servers started.
• Service Registry is installed (local to the Service Bus installation) with either a single server or clustered configuration and relevant servers started.
• Service Registry definition configured and connection established successfully.
• IBM HTTP Server V7 (hereafter known as IHS) is installed (local to the Service Bus installation) and configured.

Creating the sample service

We will start off by creating a sample backend service that is represented by a Java implementation. The said service will return the application server name on which the service is executed. The application server profile used in this scenario will be that of the Service Bus.

1. Launch Integration Developer by selecting Start > All Programs > IBM WebSphere Integration Developer > IBM WebSphere Integration Developer V7.0 > WebSphere Integration Developer V7.0.
2. In the Integration Developer workspace, click File > New > Integration Solution.
3. In the dialog shown in Figure 1, type IntegrationSolution in the Integration solution name field and click Next.

4. In the next dialog, select all three projects with the default names as depicted in Figure 2 and click Finish to complete the wizard.

5. Verify that the three projects appear in the list as depicted in Figure 3.

6. Expand IntegrationSolution_Library in the Business Integration view, right-click on Interfaces and select New > Interface from the context menu.

7. Type ServiceInterface in the name field and click Finish to complete the wizard.

8. The interface is launched in the Interface Editor as shown in Figure 6.

9. Click the Add Request Response Operation icon and name the operation getServerResponse as shown in Figure 7.

10. Click File > Save to save changes made thus far.
11. Expand IntegrationSolution_BackendModule (under Projects in the Business Integration view) and double-click on Assembly Diagram to launch the Assembly Editor.

12. Insert a Java component (under the Components folder in the Palette list) onto the blank canvas and name it BackendComponent.

13. Select BackendComponent and click the Add Interface icon in the popup as shown in Figure 10.

14. In the Add Interface dialog, select ServiceInterface and click OK.

15. Verify the interface is added successfully.

16. Right-click on BackendComponent and select Generate Implementation from the context menu.
17. When prompted for a package name, key in com.ibm.au.samples and click OK.
18. The BackendComponentImpl1.java class will be displayed in the Java Editor as shown in Figure 13.

19. Replace the getServerResponse method body with the code snippet shown in Figure 14.

20. Click File > Save All to save changes made thus far.
21. Switch to the IntegrationSolution_BackendModule Assembly Diagram.
22. Right-click on BackendComponent and select Generate Export > Web Service Binding from the context menu.
23. Select the SOAP1.1/HTTP transport protocol and click Finish to complete the wizard.

24. Verify that the Web Service Binding Export is generated successfully.

25. Expand IntegrationSolution_Library > Web Service Ports (under Projects in the Business Integration view) and double-click on ServiceInterfaceExport1_ServiceInterfaceHttpPort to launch the said file in the WSDL Editor.
26. Select ServiceInterfaceExport1_ServiceInterfaceHttpPort and type http://<hostname>:<port>/ IntegrationSolution_BackendModuleWeb/sca/ServiceInterfaceExport1 in the Address field. (The <hostname> refers to the fully qualified domain name of the machine on which Service Bus is installed and <port> refers to the value found at Servers > Server Types > WebSphere application servers > [Service Bus application server] > Ports > WC_defaulthost of the Integrated Solutions Console, where [Service Bus application server] represents the default application server of the Service Bus profile.)

27. Click File > Save All to save changes made thus far.
28. Click File > Export to launch the export wizard.
29. In the dialog shown, select Integration modules and libraries under the Business Integration folder and click Next to proceed.

30. In the subsequent dialog, select Files for server deployment, the IntegrationSolution_BackendModule project and click Next to proceed.

31. Type in an archive file name e.g. IntegrationSolution_BackendModule.ear, specify a Target directory to export the project to and click Finish to complete the wizard.

32. To export the WSDL files which are to be uploaded to Service Registry, click File > Export.
33. In the subsequent dialog, select WSDL and XSD under the Business Integration folder and click Next to proceed.

34. In the dialog as shown in Figure 22, complete the following.
    • Select the IntegrationSolution_Library project.
    • Select the IntegrationSolution_BackendModule_ServiceInterfaceExport1.wsdl and ServiceInterface.wsdl WSDL files.
    • Specify a Target directory to export the WSDL files to.
    • Click Finish.

Upload the service to Service Registry

In this section, we will showcase steps to upload the newly created service to Service Registry. We will then proceed to add properties to the said service and perform a query of the service using the properties as part of the query string.

1. Log on to the Service Registry console at http://<hostname>:<port>/ServiceRegistry. (The <hostname> refers to the fully qualified domain name of the machine on which Service Registry is installed and <port> refers to the value found at Servers > Server Types > WebSphere application servers > [Service Registry application server] > Ports > WC_defaulthost of the Integrated Solutions Console, where [Service Registry application server] represents the default application server of the Service Registry profile.)
2. Click Actions > Load Documents

3. Select IntegrationSolution_BackendModule_ServiceInterfaceExport1.wsdl from the local file system and complete the following:
   • Select WSDL as the Document type.
   • Type ServiceBackend as the document description.
   • Type 1.0 as the document version.
   • Click OK.

4. In the next screen, click Add.

5. Select ServiceInterface.wsdl from the local file system and complete the following:
   • Select WSDL as the Document type.
   • Type ServiceInterface as the document description.
   • Type 1.0 as the document version.
   • Click OK.

6. In the next screen, click Finish to complete the wizard.

7. Verify that the service documents are loaded successfully.

8. In the search field as depicted in Figure 29, type ServiceInterfaceExport1_ServiceInterfaceHttpPort and click on the search icon.

9. Click on the ServiceInterfaceExport1_ServiceInterfaceHttpPort link of object type Port.

10. Expand the Additional Properties section and click on Edit Properties.

11. Click on Add Property.

12. Type sampleProperty in the Custom Property Name field and click Add.

13. Type abc123def in the value field of the custom property and click OK.

14. Expand the Additional Properties section to verify that the custom property has been added successfully.

15. Click Actions > Query Wizard.

16. Select WSDL Ports from the entity type drop down list and click Next.

17. In the details page of the query wizard, specify the values below and click Next to proceed.
    • Type sampleProperty in the Property name field.
    • Type abc123def in the Property value field

18. At the summary page of the query wizard, click Finish to perform the query.

19. Click on the ServiceInterfaceExport1_ServiceInterfaceHttpPort link.

20. Verify the custom property sampleProperty exists.

Defining the mediation flow

In this section, we will discuss steps to define a mediation flow that will encompass the use of the Endpoint Lookup and Trace mediation primitives. The former mediation primitive will perform a lookup against the default service registry (which should already be defined in Service Bus and connection established successfully). The latter mediation primitives are to facilitate troubleshooting in the event of a failure.

1. From within Integration Developer, double-click Assembly Diagram under the IntegrationSolution_MediationModule project to launch the Assembly Editor and name the Mediation Flow component SampleMediation. (Note that a default Mediation Flow component exists upon creating the Mediation Module.)

2. Select SampleMediation and click the Add Interface icon in the popup as shown in Figure 43.

3. In the Add Interface dialog, select ServiceInterface and click OK.
4. Select SampleMediation and click the Add Reference icon in the popup as shown in Figure 44.

5. In the Add Reference dialog, select ServiceInterface and click OK.
6. Right-click on SampleMediation and select Generate Implementation from the context menu.
7. In the Generate Implementation dialog, select the IntegrationSolution_MediationModule folder and click OK.
8. The SampleMediation component will be launched in the Mediation Flow Editor as shown in Figure 45.

9. Click on the getServerResponse link in the Mediation Flow Editor followed by the Service Integration link in the pop up as shown in Figure 46.

10. In the Integrate Services dialog, click Add to select the ServiceInterfacePartner reference, leave the option to Create a separate response flow... checked and click OK to create the mediation flow.

11. Verify that both the Request and Response tabs are shown in the Mediation Flow Editor.

12. Add 3 Trace mediation primitives (under the Tracing folder in the Palette) to the Request flow and name them BeforeLookup, AfterLookup and NoMatchFound, as shown in Figure 49.

13. Add an Endpoint Lookup mediation primitive (under the Routing folder in the Palette) and name it WSRREndpointLookup.

14. Connect all mediation primitives in the Request flow as shown in Figure 51.

15. Click on the Response tab in the Mediation Flow Editor, add a Trace mediation primitive and name it TraceResponse, as shown in Figure 52.

16. Connect all mediation primitives in the Response flow as shown in Figure 53.

17. Switch back to the Request flow (by clicking on the Request tab in the Mediation Flow Editor), select BeforeLookup and add in the prefix BeforeLookup --- in the Message field (under the Details section of the Properties view).

18. Repeat step 17 for AfterLookup as shown in Figure 55.

19. Select NoMatchFound and update the following fields under the Details section of the Properties view.
    • Select File in the Destination drop down list.
    • Specify an absolute File path e.g. C:\temp\dWSampleNoMatchFound.log
    • Add in the prefix NoMatchFound --- in the Message field.

20. Select WSRREndpointLookup and verify the fields under the Details section of the Properties view are as shown in Figure 57.

21. Select WSRREndpointLookup, click Advanced in the Properties view and click Add.

22. In the Add/Edit properties dialog as shown in Figure 59, type sampleProperty in the Name field, /body/getServerResponse/input1 in the Value field and click Finish.

23. Verify that the user property added in step 22 is listed in the Advanced section of the Properties view.

24. Double-click Assembly Diagram under the IntegrationSolution_MediationModule project in the Business Integration view to launch the Assembly Editor.
25. Right-click SampleMediation in the Assembly Editor and select Generate Export > Web Service Binding from the context menu.
26. In the Select a Transport Protocol dialog, select SOAP1.1/HTTP and click Finish to generate the export.
27. Verify the Web Service Binding Export is generated successfully.

28. Double-click the ServiceInterfaceExport1_ServiceInterfaceHttpPort web service port under the IntegrationSolution_Library project in the Business Integration view as shown in Figure 62.
29. Select ServiceInterfaceExport1_ServiceInterfaceHttpPort in the WSDL Editor and type http://<hostname>:<port>/IntegrationSolution_MediationModuleWeb/sca/ServiceInterfaceExport1 in the Address field. (The <hostname> refers to the fully qualified domain name of the machine on which Service Bus is installed and <port> refers to the value found at Servers > Server Types > WebSphere application servers > [Service Bus application server] > Ports > WC_defaulthost of the Integrated Solutions Console, where [Service Bus application server] represents the default application server of the Service Bus profile.)

30. Click File > Save All to save changes made thus far.
31. To export the deployable artifacts for this project, click File > Export.
32. In the subsequent dialog, select Files for server deployment, the IntegrationSolution_MediationModule project and click Next to proceed.
33. In the final dialog of the Export wizard, specify an Archive File Name e.g. IntegrationSolution_MediationModule.ear, select a Target directory to export the project to and click Finish to complete the export.

Creating the JAX-WS client

In the following section, we will cover steps to create a web application comprising of JSPs and classes generated by the JAX-WS web service client wizard. JAX-WS is a web services programming model that builds on the foundation of the Java API for XML-based RPC (JAX-RPC) model and provides a more platform agnostic approach to defining web service clients. The web application will be used to verify integration between Service Bus and Service Registry by invoking the web service binding export of the SampleMediation mediation flow.

1. In the Integration Developer workspace, click File > New > Other.
2. In the dialog shown in Figure 63, select Enterprise Application Project under the Java EE folder and click Next to proceed.

3. In the next dialog, type SampleClient in the Project name field, leave the rest as default and click Next to proceed.

4. Next, click New Module.

5. In the subsequent dialog, select Web module, leave the value as default and click Finish.

6. Lastly, verify SampleClientWeb is selected and click Finish to complete the wizard.

7. When prompted to switch to the Java EE perspective, click No.
8. Next, click File > New > Other and select Web Service Client under the Web Services folder.
9. In the subsequent dialog, type /IntegrationSolution_Library/IntegrationSolution_MediationModule_ServiceInterfaceExport1.wsdl in the Service definition field and click on the Server:... link.

10. Next, select WebSphere ESB Server v7.0 as the Server, IBM WebSphere JAX-WS as the Web service runtime and click OK.

11. Next, click on the Client project:... link.

12. In the subsequent dialog, select SampleClientWeb as the client project and click OK.
13. Verify that the Configuration is as shown in Figure 71 and click Next to proceed.

14. In the final dialog of the wizard, check Generate portable client, leave the rest as default and click Finish. (When the Generate portable client option is checked, a local copy of the WSDL files are stored in the <WebModule>/WebContent/WEB-INF/wsdl folder.)

15. Switch to the Java EE perspective by clicking Window > Open Perspective > Other > Java EE.
16. Verify that the Java classes as shown in Figure 73 are listed in the Enterprise Explorer view.

17. Verify that a Service Bus server configuration exists within the Integration Developer workspace.

18. Right-click on ServiceInterfaceExport1_ServiceInterfaceHttpPortProxy.java under SampleClientWeb > Java Resources > integrationsolution_library.serviceinterface.binding2 and select Web Services > Generate JAX-WS JSPs from the context menu.
19. In the Web Service Client Test dialog, check Test the generated proxy, type form in the Folder field, uncheck Run test on Server, leave the rest as default and click Finish to complete the wizard.

20. Verify JSPs as shown in Figure 76 are listed in the Enterprise Explorer view.

21. To export the deployable artifacts for this project, click File > Export.
22. In the subsequent dialog, select EAR file under the Java EE folder and click Next to proceed.
23. Next, select SampleClient as the EAR project, specify a Destination to export the project to, leave the rest as default and click Finish to complete the export.

Deploying the applications to Service Bus

Next, we will deploy the exported integration modules and web project to the Service Bus runtime via the Integrated Solutions Console. Web modules of all applications will be mapped to both the Service Bus application server and IHS.

1. Log on to the Integrated Solutions Console at http://<hostname>:<port>/ibm/console. (The <hostname> refers to the fully qualified domain name of the machine on which Service Bus is installed and <port> refers to the default value of 9060.)
2. Navigate to Applications > New Application > New Enterprise Application.
3. Select the IntegrationSolution_BackendModule.ear file from the Local file system and click Next.
4. Select Fast Path and click Next.
5. In the subsequent screen, leave the values as default and click Next.
6. Next, map IntegrationSolution_BackendModuleWeb to the Service Bus application server and web server in the Cluster and servers list, then click Next to proceed.

7. Review the summary of the deployment and click Finish to install the application.
8. Click Review after the installation completes.
9. Select Synchronize changes with Nodes and click Save.
10. When the synchronization is complete, click OK.
11. Navigate to Applications > Application Types > WebSphere enterprise applications, select IntegrationSolution_BackendModuleApp and click Start.
12. Repeat steps 1 – 11 to install and start the following applications.
    • IntegrationSolution_MediationModule.ear
    • SampleClient.ear

Testing the application

In this final section, we will access the SampleClientWeb web application via a browser. The said application receives an input string from the web form and either returns the Service Bus application server name on which the backend service is executed or a null value if no match is found in Service Registry. Upon executing the said test, we will review the SystemOut.log file of the Service Bus application server to verify that messages have been logged by the Trace mediation primitives.

1. Launch the web application in a browser by accessing http://<hostname>/SampleClientWeb/form/TestClient.jsp (The <hostname> refers to the fully qualified domain name of the machine on which IHS is installed. We do not explicitly specify a port as the web module of the enterprise application is mapped to IHS.)

2. Click on the getServerResponse link in the Methods frame, type 10 (or any alphanumeric string value other than 'abc123def') in the input1 field and click Invoke.
3. Verify that 'null' is displayed in the Results frame as shown in Figure 79.

4. Open C:\temp\dWSampleNoMatchFound.log in a text editor and view message logged by Trace mediation primitive.

5. Next, type abc123def in the input1 field and click Invoke.
6. Verify that 'Server response from <Service Bus application server> with input abc123def' is displayed in the Results frame as shown in Figure 81. (The <Service Bus application server> refers to the default application server of the Service Bus profile.)

7. Switch back to the Integrated Solutions Console and navigate to Troubleshooting > Logs and trace > [Service Bus application server] > JVM Logs. (The [Service Bus application server] is the default application server of the Service Bus profile.)
8. Click on the Runtime tab and click View next to SystemOut.log.
9. View messages logged by Trace mediation primitives as shown in Figure 82.

Conclusion

In this article, you learned how to develop a solution using Integration Developer that showcases integration between Service Bus and Service Registry. You started off by creating a sample backend service and then uploaded the said service to Service Registry. You then defined a mediation flow that performs the lookup against Service Registry and generated a JAX-WS web service client to test the integration scenario.

Acknowledgements

I would like to thank my team mate, Damien McAullay at the Australia Development Laboratory WebSphere Services team for reviewing this article.

Resources

• Find more details on Service Registry in the WebSphere Service Registry and Repository V7 Information Center.
  
  
• Find more details on Services Details in the WebSphere Enterprise Service Bus V7 Information Center.
  
  
• Learn how to implement WebSphere Business Process Management V7 topologies by referring to the WebSphere Business Process Management V7 Production Toplogies Redbook.
  
  
• Read details about Java API for XML Web Services.
  
  

About the author

Ben is part of the Australia Development Laboratory WebSphere Services team and provide implementation services to a variety of customers on the WebSphere stack of products primarily WebSphere Process Server, WebSphere Enterprise Service Bus and WebSphere Application Server.

Rate this article

Comments

Back to top

Table of contents

• Introduction
• Creating the sample service
• Upload the service to Service Registry
• Defining the mediation flow
• Creating the JAX-WS client
• Deploying the applications to Service Bus
• Testing the application
• Conclusion
• Acknowledgements
• Resources
• About the author
• Comments

Local resources

• IBM Innovation Center - Austin, TX
• IBM Innovation Center - Chicago, IL
• IBM Innovation Center - Dallas, TX
• IBM Innovation Center - San Mateo, CA
• IBM Innovation Center - Waltham, MA
• Technical Briefings in North America

Dig deeper into SOA and Web services on developerWorks

Try IBM PureSystems. No charge.

Experience today!

---

Get started with the cloud-based trial and pattern development kit.

Special offers