Redpaper

Andrew White

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

In this IBM Redpapers publication, we discuss the built-in integration between IBM WebSphere Service Registry and Repository (WSRR) and IBM WebSphere DataPower, which allows users to create Web Service Proxies based on Web Services Description Language (WSDL) documents and attached Web Service Policy (WS-Policy) documents stored in WSRR. We also describe how to extend the built-in integration between WSRR and WebSphere DataPower to allow dynamic endpoint selection of services based upon meta data stored in WSRR.

Product description
WebSphere DataPower provides the ability to understand and act upon application data as it traverses the network. While this application awareness is not, in itself, a new networking concept, XML has accelerated its appeal and complexity, that is, application awareness comes with many security, complexity, and performance challenges. As a result, a new genre of hardened software, hardware, and XML-centric appliances has arisen to bridge this gap.

Copyright IBM Corp. 2009. All rights reserved.

ibm.com/redbooks

These WebSphere DataPower appliances focus on providing consumability, performance, and hardened security. They can extend the Enterprise Service Bus (ESB) into the network and also provide an service-oriented architecture (SOA) gateway for business-to-business integration.

Value proposition
Integrating WebSphere Service Registry and Repository with WebSphere DataPower provides several benefits: Allows the creation of Web Service Proxy based upon a WSDL stored in WSRR instead of a static file. If the WSDL is updated in WSRR, then the Web Service Proxy synchronizing with that particular WSDL will also be updated the next time WebSphere DataPower synchronizes with WSRR. Using WSRRs policy attachment user interface, users can edit WSDL documents attached to WS-Policies and the results of this edit will be updated in WebSphere DataPower the next time synchronization occurs. By extending the built-in integration between WSRR and WebSphere DataPower, it is possible to configure a Web Service Proxy to dynamically choose an endpoint at run time based on meta data stored in WSRR.

Key integration features

The built-in WebSphere Service Registry and Repository subscription feature in WebSphere DataPower enables WebSphere DataPower to subscribe to a particular concept or WSDL. The subscription can be configured to either synchronize at a timed interval (poll) or when a user logs into WebSphere DataPower and manually runs the synchronization. Web Services Proxies can then be created in WebSphere DataPower based upon a WebSphere Service Registry and Repository subscription. Any changes made to either the WSDL or to any attached Web Service Policies will be reflected in WebSphere DataPower the next time a synchronization takes place, as shown in Figure 1 on page 3.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

WSRR

IBM

WSRR Subscription

Service Requestor

Service Provider

Figure 1 WebSphere DataPower subscription to WSRR

Creating Web Services Proxies based on WSRR subscriptions is covered in Chapter 4, Using Web Service Proxy with WebSphere Registry and Repository, in IBM WebSphere DataPower SOA Appliances Part IV: Management and Governance, REDP-4366.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

WebSphere DataPower can be customized to allow dynamic service endpoint selection based upon meta data stored in WSRR, as shown in Figure 2.

WSRR

IBM
REST Query

Service Provider

Service Requestor

Service Provider

Service Provider
Figure 2 Dynamic endpoint selection using WSRR and WebSphere DataPower

Representational state transfer (REST) queries can be dynamically created at run time to query WSRR for either documents, meta data, or both, and then perform routing decisions made based on the results of those queries.

Dynamic endpoint selection scenario

This scenario describes how a fictitious company, JKHL Enterprises, uses WebSphere DataPower to dynamically retrieve a service endpoint stored in the organizations service repository hosted on WSRR.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

Scenario overview
JKHL Enterprises currently has an Account Creation service running in their production environment. This service has recently been upgraded to run an additional verifyCreation operation, as shown in Figure 3. This minor upgrade of the service is backwards compatible with the first version.

Figure 3 Upgrade to service interface

JKHL Enterprises uses WSRR as their service repository. To shield applications from changes to the Account Creation service, JKHL utilizes a XML firewall in WebSphere DataPower that will look up the active endpoint of the Account Creation service in WSRR. Once Version 1_1 of the Account Creation service is deployed and available, the endpoint for Version 1_0 will be classified as offline. All service consumer requests for the Account Creation service will be directed to the endpoint for Version 1_1, enabling Version 1_0 to be deprecated with no impact on service consumers. Note: In this minor upgrade scenario, there is no change to the name space of the service.

Integration issues
JKHL Enterprises uses dynamic endpoints for service calls in WebSphere DataPower. In this endpoint lookup scenario, WSRR will be accessed to retrieve a single matching endpoint for the latest version of the createAccount operation of the AccountCreation service. Uploading service definitions is explained in Service Lifecycle Governance Using WebSphere Service Registry and RepositoryService Lifecycle Governance with IBM WebSphere Service Registry and Repository V6.3, SG24-7793 and will not be described in this paper.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

Solution overview
The endpoint lookup solution shown in Figure 4 shows how the WebSphere DataPower queries WSRR and selects the account creation service endpoint that is set to be online in WSRR.

WSRR

IBM
REST Query

Account Creation V1_0

Service Consumer V1

Account Creation V1_1

Figure 4 Scenario overview

Performing the integration

Note: In this scenario, the public/private key that WSRR uses is the same public/private key that the production endpoint uses and is the same key store DataPower uses for its HTTPS interface.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

Perform the following steps to accomplish the integration: 1. In this scenario, security is enabled on WSRR and DataPower provides a HTTPS interface. We must obtain the WSRR public key certificate so that DataPower can communicate with WSRR over the HTTPS protocol, and obtain the public/private pair key store that DataPower will use for the HTTPS interface so that the interface will be accessible by consumers. a. Log in to the WebSphere Application Server Integration Solution console. b. Select Security SSL certificate and key management. c. Click Key stores and certificates. d. Click NodeDefaultKeyStore. e. Click Personal certificates. f. Select the Default check box and click Extract.... g. In certificate file name field, enter /tmp/WSRRCert.der, select Binary DER data, and click OK. Note: You must enter an absolute path in the certificate file name field. h. Copy the WSRRCert.der and key.p12 files to the local file system. Note: The key.p12 file is located in /WAS_HOME/profiles/PROFILE_NAME/config/cells/CELL_NAME/nodes/NODE_NA ME/key.p12. 2. Create a Multi-Protocol Gateway. a. Log in to the DataPower Web console. b. Click Multi-Protocol Gateway. c. Click Add.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

d. Enter AccountCreation in the Multi-Protocol Gateway Name field. Click dynamic-backend, select default in the XML Manager drop-down menu, and select default from Multi-Protocol Gateway Policy drop-down menu, as shown in Figure 5 on page 9.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

Figure 5 Creating the Multi-Protocol Gateway

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

e. In the Front Side Protocol field, click +. f. Click HTTPS (SSL) Front Side Handler. g. In the new window that appears, enter HTTPSProdFSH in the Name field, as shown in Figure 6 on page 11. In the SSL Proxy field, click +.

10

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

Figure 6 Creating the Front Side Handler

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

11

h. In the new window that appears, enter SSLProxyProfile in the Name field. Select Reverse from the SSL Direction drop-down menu and click + next to the Reverse (server) Crypto profile, as shown in Figure 7.

Figure 7 Configuring the SSL Proxy Profile

12

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

i. In the new window that appears, enter ReverseCryptoProfile. Click + next to the Identification Credentials field, as shown in Figure 8.

Figure 8 Creating the Crypto Profile

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

13

j. In the new window that appears, enter CryptoIDCreds in the Name field. Click + next to the Crypto Key field, as shown in Figure 9.

Figure 9 Creating the Crypto Identification Credentials

k. In the new window that appears, click Upload, as shown in Figure 10 on page 15.

14

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

Figure 10 Creating the Crypto Certificate

l. In the new window that appears, enter the location of the key.p12 file that you copied from step 1. Click Upload, click Continue, and the window will close. m. Enter the password to the key store in the Configure Crypto Key field (by default, this is WebAS). Click Apply and the window will close. n. In the Configure Crypto Identification Credentials window, click + next to the Certificate field.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

15

o. In the new window that appears, select key.p12 from the File Name drop-down menu, as shown in Figure 11, enter the password for the key store, and click Apply. The window will close.

Figure 11 Configuring the Crypto Certificate

p. In the Configure Crypto Identification Credentials window, click Apply and the window will close. q. In the Configure Crypto Profile window, click Apply and the window will close. r. In the Configure SSL Proxy Profile window, click Apply and the window will close. s. In the Configure HTTPS (SSL) Front Side Handler window, click Apply and the window will close. t. In the Configure Multi-Protocol Gateway window, click Apply. You have now created the basis of the Multi-protocol Gateway. 3. Create the Multi-Protocol Gateway Policy. a. Log in to the DataPower Web console. b. Click Multi-Protocol Gateway. c. Click AccountCreation.

16

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

d. Click + next to the Multi-Protocol Gateway policy. e. In the new window that appears, enter AccountCreationPolicy, select Client to Server from the Rule Direction drop-down menu, and click New Rule, as shown in Figure 12.

Figure 12 Creating a Multi-Protocol Gateway policy rule

f. Double-click the Match action. g. In the new window that appears, click +. In the new window that appears, enter MatchRule in the Name field, click Matching Rule, and click Add. In the new window that appears, select URL, enter *, and click Apply. The window will close. In the Configure Matching Rule window, click Apply and the window will close. In the Configure Match Action window, click Apply and the window will close. Click Done.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

17

h. Click Advanced and drag the icon onto the line, as shown in Figure 13.

Figure 13 Inserting an advanced action into the rule

i. Double-click the Advanced icon previously dragged onto the line. In the new window that appears, select Fetch and click Next.

18

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

j. Select https:// from the Source drop-down menu and enter https://9.42.171.102:9443/WSRR/6.3/Metadata/XML/PropertyQuery?que ry=/WSRR/GenericObject[@namespace=%27http://jkhle.itso.ibm.com/Ac countCreationV1/service%27%20and%20exactlyClassifiedByAllOf%28%27 http://www.ibm.com/xmlns/prod/serviceregistry/v6r3/ServiceModel%2 3SOAPServiceEndpoint%27,%27http://www.ibm.com/xmlns/prod/servicer egistry/lifecycle/v6r3/LifecycleDefinition%23Online%27%29]&p1=nam e in the text box, as shown in Figure 14. Click Done and the window will close.

Figure 14 Configuring the fetch action

Note: This URL is a REST action that queries WSRR to select SOAP Service Endpoints, which are classified as online and have the name space http://jkhle.itso.ibm.com/AccountCreationV1/service.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

19

k. Click the Advanced icon and drag it onto the line, as shown in Figure 15.

Figure 15 Adding another advanced action

l. Double-click the Advanced icon previously dragged onto the line. In the new window that appears, select Extract using Xpath and click Next.

20

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

m. Enter /resources/resource/properties/property/@value () in the XPath field. Click Var Builder, enter JKHLE into the Context field, and enter Endpoint into the Variable Name field, as shown in Figure 16.

Figure 16 Extracting the previous REST query using an XPath expression

Note: This XPath query will give you the actual SOAP endpoint to which you route.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

21

n. Click Use Custom, as shown in Figure 17.

Figure 17 Setting the result of the XPath expression to be a variable

22

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

o. Click Done and the window will close. Click the Route icon and drag it onto the line, as shown in Figure 18.

Figure 18 Adding a route action

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

23

p. Double-click the Route icon previously dragged onto the line. In the new window that appears, select Use Variable to Select Destination. Select var:// and click Var Builder, enter JKHLE into the Context field, and enter Endpoint into the Variable Name field, as shown in Figure 19.

Figure 19 Routing using the variable

q. Click Use Custom. r. Click +. Note: This will create a SSL profile to encrypt the request to the SOAP Endpoint. s. In the window that appears, enter ForwardSSLProxy in the Name field, select Forward in the SSL Direction drop-down menu, and click +. t. In the new window that appears, enter ForwardCryptoProfile into the Name field and click + next to the Validation Credentials field.

24

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

u. In the new window that appears, enter ForwardCryptoCreds in the Name field and click +. v. In the new window that appears, enter ForwardCert in the Name field and click Upload.... w. Enter the location of the WSRRCert.der file (from step 1 on page 7), click Upload, click Continue, and the window will close. x. In the Configure Crypto Certificate window, click Apply and the window will close. y. In the Configure Crypto Validation Credentials window, click Apply and the window will close. z. In the Configure Crypto Profile window, click Apply and the window will close. aa.In the Configure SSL Proxy Profile window, click Apply and the window will close. ab.In the Configure Route (Using Variable) Action window, click Done and the window will close. ac. Click Apply Policy and click Close Window. ad.In the Configure Multi-Protocol Gateway, click Apply. 4. DataPower will try and communicate with WSRR without using either the correct SSL certificate or the correct user information. The Multi-Protocol Gateway will have to be configured to communicate with the secure WSRR. a. Log in to the DataPower Web console. b. Click Multi-Protocol Gateway. c. Click AccountCreation. d. Click + next to the XML Manager field.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

25

e. Enter WSRRXMLManger in the Name field, as shown in Figure 20.

Figure 20 Creating a new XML manager

f. Click + next to the User Agent Configuration field.

26

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

g. In the new window that appears, enter WSRRConnection in the Name field, as shown in Figure 21.

Figure 21 Creating a new user agent

h. Click SSL Proxy Profile Policy and click Add. i. In the new window that appears, enter https://9.42.171.102:9443/WSRR* in the URL Matching Expression field and select ForwardSSLProxy in the SSL Proxy Profile drop-down menu. Note: We can use the same SSL proxy profile for both the WSRR server and the production servers, if they share the same public/private key. j. Click Apply and the window will close. k. Click the Basic-Auth Policy tab. l. Click Add.

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

27

m. In the new window that opens, enter https://9.42.171.102:9443/WSRR* in the URL Matching Expression field and the user name and password for communicating with WSRR, as shown in Figure 22.

Figure 22 Configuring the Basic Auth Policy

n. Click Apply and the window will close. o. In the Configure User Agent window, click Apply and the window will close. p. In the Configure XML Manager window, click Apply and the window will close. q. In the Configure Multi-Protocol Gateway window, click Apply. 5. Every time there is a request to DataPower, there will be a subsequent query to WSRR, which could have adverse performance implications. DataPower needs to be configured to cache the results of WSRR queries. a. Log in to the DataPower Web console. b. Click Multi-Protocol Gateway. c. Click AccountCreation. d. In the XML Manager drop-down menu, click .... e. Click Document Cache Policy. f. Click Add. g. Enter https://9.42.171.102:9443/WSRR* in the URL Match Expression field. h. Click Fixed in the Policy Type drop-down menu. i. Enter 900 in the TTL field. j. Click Apply and the window will close. k. In the Configure XML Manager window, click Apply and the window will close.

28

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

l. In the Configure Multi-Protocol Gateway window, click Apply. Note: This caching policy will cache the results of all queries to the WSRR REST interface.

The team that wrote this IBM Redpapers publication

This paper was produced at the International Technical Support Organization, Raleigh Center. Andrew White is a software developer from the United Kingdom. He has 3 years of experience in middleware development at IBM. Andrew holds a degree in Computer Science from The University of Nottingham. His areas of expertise include WebSphere Application Server, WebSphere Service Registry and Repository (WSRR), WebSphere DataPower, WebSphere Process Server, Tivoli Composite Application Manager for Service Oriented Architecture (ITCAM4SOA), Tivoli Security Policy Manager (TSPM), service-oriented Architecture (SOA), and Microsoft .NET. Thanks to the following people for their contributions to the paper: Martin Keen Nicole Hargrove Ian Heritage Prasad Imandi Wendy Neave Laura Olson Bhargav Perepa

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

29

30

Integrating WebSphere Service Registry and Repository with WebSphere DataPower

Notices
This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing, IBM Corporation, North Castle Drive Armonk, NY 10504-1785 U.S.A. The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrates programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to IBM for the purposes of developing, using, marketing, or distributing application programs conforming to IBM's application programming interfaces. Copyright International Business Machines Corporation 2009. All rights reserved. Note to U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

31

This document REDP-4559-00 was created or updated on November 5, 2009. Send us your comments in one of the following ways: Use the online Contact us review Redbooks form found at: ibm.com/redbooks Send your comments in an email to: redbook@us.ibm.com Mail your comments to: IBM Corporation, International Technical Support Organization Dept. HYTD Mail Station P099, 2455 South Road Poughkeepsie, NY 12601-5400 U.S.A.

Redpaper
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol ( or ), indicating US registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both: DataPower IBM Redpaper Redpapers Redbooks (logo) Tivoli WebSphere

The following terms are trademarks of other companies: Microsoft, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Other company, product, or service names may be trademarks or service marks of others.

32

Integrating WebSphere Service Registry and Repository with WebSphere DataPower