Patent Application
20070055678
1.0 Field of the Invention
This invention relates to a deployment utility; and in particular, to a utility to enable an Information Management System (IMS™ (Trademark of International Business Machines Corporation)) application to be accessed as a web service using SOAP.
2.0 Description of the Related Art
There is enormous demand from legacy system customers to enable their applications with the eXtensible Markup Language (XML). One example of a legacy system is the IBM® (Registered trademark of International Business Machines Corporation) IMS system. The Simple Object Access Protocol (SOAP) is an industry standard protocol for exchanging information in a distributed environment. SOAP is an XML-based protocol that defines the use of XML and HyperText Transport Protocol (HTTP) to access services, objects and servers independent of the platform. However, the process involved in order to enable a legacy system application to be accessed as a web service using SOAP can be complex and error-prone. Therefore, there is a need for a utility which simplifies the process of enabling legacy system applications for access as Web services which use SOAP.
To overcome the limitations in the prior art described above, and to overcome other limitations that will become apparent upon reading and understanding the present specification, various embodiments of a computer-implemented method, system and article of manufacture enable an application in a legacy system to be accessed as a web service. In response to a command from a user, a web service is deployed to a gateway server, and a connection bundle and a correlator file are provided such that they are accessible to the gateway server. The web service was generated based on a web service description language file that is based on an input-output message description of the application. The web service is accessible to a client using a SOAP message. The gateway server is to send a request message to the application based on the SOAP message in accordance with the web service. The gateway server is to receive a reply message from the application and return a SOAP response to the client based on the reply message in accordance with the web service. The connection bundle comprises connection information to interface with the application. The correlator file comprises a name of an interface module associated with the application and the name of the connection bundle.
In this way, a deployment utility is provided which enables an IMS application to be accessed as a web service at an IMS SOAP gateway.
The teachings of the present invention can be readily understood by considering the following description in conjunction with the accompanying drawings, in which:
To facilitate understanding, identical reference numerals have been used, where possible, to designate identical elements that are common to some of the figures.
After considering the following description, those skilled in the art will clearly realize that the teachings of the various embodiments of the present invention can be utilized to enable an IMS application to be accessed as a web service at an IMS-SOAP gateway. Various embodiments of a computer-implemented method, system and article of manufacture enable an application in a legacy system to be accessed as a web service. In response to a command from a user, a web service is deployed to a gateway server, and a connection bundle and a correlator file are provided such that they are accessible to the gateway server. The web service was generated based on a web service description language file that is based on an input-output message description of the application. The web service is accessible to a client using a SOAP message. The gateway server is to send a request message to the application based on the SOAP message in accordance with the web service. The gateway server is to receive a reply message from the application and return a SOAP response to the client based on the reply message in accordance with the web service. The connection bundle comprises connection information to interface with the application. The correlator file comprises a name of an interface module associated with the application and the name of the connection bundle.
Various artifacts are generated and deployed to the IMS SOAP gateway 20 so that the IMS application 24 can be accessed as a web service. In some embodiments, the artifacts comprise a web service 34, a correlator file 40 and a connection bundle 51.
The IMS application 24 typically uses a programming language, for example, the COmmon Business Oriented Language (COBOL) or Programming Language One (PL/1), to implement the business logic. In some embodiments, as part of enabling IMS applications for Web services, IBM WebSphere® (Registered trademark of International Business Machines Corporation) Developer for zSeries (WDz) 52 utility is used to generate Web service artifacts without changing the IMS application code. In various embodiments, WDz 52 takes a copybook 36, for example, a COBOL copybook, which describes the input and output message format for IMS transactional applications and generates the following web service artifacts: a converter-driver file 37, the correlator file 40 and a Web Services Description Language (WSDL) file 42.
The converter-driver file 37 comprises one or more XML converters 38 and a driver 39. In response to receiving an XML request message from the IMS SOAP gateway 20 which specifies the driver 39, an XML-language Adapter 22 calls that driver 39 which invokes one of the converters 38. In some embodiments, the XML converters 38 comprise an input XML converter and an output XML converter. The converters 38 are used to transform the XML message from the IMS SOAP gateway 20 into a specific language, for example, COBOL bytes, for the IMS application 24 and then back to XML and sent to the IMS SOAP gateway. In various embodiments, the XML-language adapter 22 is an XML adapter for the COmmon Business Oriented Language (COBOL). Alternately, the XML-language adapter 22 is an XML adapter for Programming Language One (PL/1). However, the XML-language adapter 22 is not meant to be limited to COBOL or PL/1 and other languages may be used. In some embodiments, XML converters 38 are not generated and not used.
The correlator file 40 contains one or more correlator properties which enables the IMS SOAP gateway 20 to set one or more IMS properties and call the IMS application 24. In various embodiments, the correlator file 40 specifies an interface module, that is, the driver 39, and in some embodiments, the converter(s) 38, to be used with the web service 34, in addition to other correlator properties. In some embodiments, the correlator file 40 is in the XML format.
The WSDL file 42 provides a description of the IMS application 24 so that the client application 26 can communicate with the IMS application 24 as web service 34. WSDL is an XML-based language which can be used to describe a web service's capabilities as collections of communication endpoints capable of exchanging messages.
In some embodiments, the IMS SOAP gateway 20 sends requests to and receives replies from IMS 28 using TCP/IP. The IMS SOAP gateway 20 provides an interface between the client application 26 and IMS Connect 46. IMS Connect 46 receives the requests from and replies to the IMS SOAP gateway 20 and interfaces with the IMS application 24. Typically, the IMS application 24 is executing within a z/OS environment. In various embodiments, the client application 26 can be a Java, .Net, SAP® (Registered Trademark of SAP AKTIENGELLSCHAFT Corporation, Federal Republic of Germany) or other third-party client. The client application 26 sends a SOAP message to the IMS SOAP gateway 20 over HTTP. The IMS SOAP gateway 20 processes the SOAP message envelope and header sections, and passes the SOAP message's body section's payload data to IMS Connect 46 in XML format using TCP/IP. To process the SOAP message, the IMS SOAP gateway 20 accesses the web service 34, correlator file 40 and connection bundle 51. In some embodiments, the connection bundle 51 is a connection bundle file. In other embodiments, a connection bundle file comprises multiple connection bundles. In some embodiments, the connection bundle is stored in XML format. Within IMS Connect 46, the adapter task manager 50 calls the XML-Language adapter 22, and the XML-Language adapter 22 maps the request from the IMS SOAP gateway to the appropriate XML driver 39 which calls an appropriate XML converter 38 to convert the XML payload data to a specific language, for example, COBOL bytes, which are sent to the IMS application 24. For the response, the IMS application 24 sends the response to IMS Connect 46. The adapter task manager 50 invokes the appropriate XML-language adapter 22 which calls the appropriate driver 39 which calls the appropriate converter 38 to convert the response to XML format. IMS connect 46 sends the XML response to the IMS SOAP gateway 20 which converts the XML response to SOAP message(s) and sends the SOAP message(s) to the client application 26.
Typically, a Java or web service developer, a web server administrator, a system programmer and a Java or Net developer are involved in order to allow a client application to interact with the IMS application 24. The Java or web service developer typically generates the WSDL file 42, correlator file 40 and XML converters 38 based on the copybook 36 using WDz 52. In some embodiments, the web service developer publishes the WSDL file 42 to a Universal Description Discovery and Integration (UDDI) registry or a local repository. UDDI is an XML-based protocol that provides a registry service for Web services that manages information about service providers, implementations and metadata. The web server administrator deploys the WSDL file 42 and the correlator file 40 to the IMS SOAP gateway 20 and creates a connection bundle 51. The system programmer typically configures IMS Connect 46 and compiles the XML converters 38. The Java or .Net developer typically generates the client code, for example, the Client-Side proxy 54, from the WSDL file 42 and writes the client application to invoke the web service 34.
Using WDz 52, the web service developer steps through multiple wizards in order to create the WSDL file 42, correlator file 40, and converter-driver file 37. Stepping through each wizard is very tedious and time-consuming, and especially when processing hundreds and thousands of IMS COBOL copybooks. In various embodiments, the deployment utility 56 simplifies the deployment of one or more of the artifacts, such as the web service 34 generated from the WSDL file 42, correlator file 40 and connection bundle 51, to the IMS SOAP gateway 20, and the XML converters 38 and driver 39 to IMS 28.
In various embodiments, the deployment utility 56 is a stand-alone utility that generates the WSDL file 42, the converter-driver 37, client code 54, web service 34 and correlator file 40 based on the IMS application copybook 36 and appropriately deploys the generated files and code to the IMS SOAP gateway server 58, IMS 28 and client system 27. In some embodiments, the deployment utility 56 invokes other utilities or tools 61, such as WDz and Apache Axis, to perform various aspects of deploying a web service to the IMS SOAP gateway 20. In various embodiments which use WDz, an options file 60 is also created and will be explained in further detail below with reference to
In step 68, correlator parameters are received. In step 70, a correlator file is generated based on the correlator parameters. In various embodiments, the correlator file provides a reference to the driver. In some embodiments, the correlator file provides a reference to at least one XML converter. In some embodiments, a utility, such as WDz, is invoked to generate the correlator file. In step 72, the deployment utility receives connection bundle parameters. In step 74, the deployment utility generates a connection bundle based on the connection bundle parameters.
In step 76, the deployment utility invokes yet another utility to generate a web service based on the WSDL file. To generate the web service, the deployment utility invokes a conversion utility, for example, a conversion utility of Apache Axis, to convert the WSDL file to Java code, that is, one or more Java classes. The Java classes provide one or more methods which can be invoked by a client application to access the IMS application. In other words, the web service is implemented using Java classes. In other embodiments, the web service may be implemented using other programming languages, for example, C and C++. In some embodiments, the WSDL file, the web service comprising one or more classes and method(s), the correlator file and the connection bundle are associated with each other based on predefined naming conventions used by the deployment utility and IMS SOAP gateway.
In step 78, the deployment utility deploys the web service, the correlator file and connection bundle to the IMS SOAP gateway. The IMS SOAP gateway is configured to provide the web service. The correlator file is stored in a sub-directory of the IMS SOAP gateway. The connection bundle is stored in a connection bundle file of the IMS SOAP gateway. In this way, the correlator file and connection bundle are deployed or provided, that is, made accessible to, the IMS SOAP gateway.
In step 80, the deployment utility configures IMS connect with one or more of the XML converters and the driver. In various embodiments, the deployment utility installs the XML converter(s) and driver such that the XML converter(s) and driver are known and accessible to the XML-language adapter of IMS Connect. In other embodiments, step 80 is omitted.
In step 82, the deployment utility invokes a utility to generate the client-side proxy, that is, client code, based on the WSDL file. In some embodiments, an Apache Axis utility is invoked to generate the client code; however, in other embodiments, other utilities may be used. The client code is stored in a predetermined location and made available for a user, for example, a Java developer, to use with the client application. For example, the client application can invoke a method in the client code to invoke the web service. In other embodiments, step 82 is omitted.
In some embodiments, a user invokes WDz to generate the XML converter-driver file, the correlator file and the WSDL file (steps 64, 66 and 70), prior to invoking the deployment utility. In other embodiments, the deployment utility invokes WDz to generate the XML converters, the correlator file and the WSDL file (steps 64, 66 and 70). In other embodiments, utilities other than WDz are used to generate the WSDL file.
In another embodiment, converters are not used; therefore the converters are omitted from steps 64 and 80.
In step 87, the deployment utility generates one or more instructions to compile the Java code and create jar file(s). In some embodiments, the deployment utility also provides a Java compiler, and the generated instructions invoke that Java compiler. In other embodiments, the conversion utility also compiles the Java code and creates the jar file(s) and step 87 is omitted. In some embodiments which use Apache Axis, one or more jar file(s) are also modified to reference the IMS SOAP gateway.
In step 88, the deployment utility generates one or more instructions to create a sub-directory on the IMS SOAP gateway to contain the jar file(s) with the Java classes. In step 89, the deployment utility generates one or more instructions to store the jar file(s) with the Java class(es) in the sub-directory. In step 90, the deployment utility generates one or more instructions to invoke an administration utility, passing the name of the deployment file, which makes the Java class(es) and allowed method(s) accessible to the IMS SOAP gateway based on the deployment file. In some embodiments which use Apache Axis, the administration utility is an AdminClient utility and the deploy.wsdd file is passed to the AdminClient utility. However, in other embodiments, other administration utilities may be used.
In some embodiments, the deployment utility provides various tasks which guide the user through the deployment of the IMS application to the IMS SOAP gateway as a web service. Thus, the deployment utility simplifies the process for the user so that the user does not need to have prior knowledge about what steps need to be performed and the order of performing the steps. In various embodiments, the deployment utility has different invocation modes such as novice, expert and batch.
Task 1102,
Task 2104,
Task 3106,
Task 4108,
Task 5110,
Task 6112,
Task 7114,
Task 8116,
Task 9118,
Task 10120,
In some embodiments, the tasks will lead the user through entering information to perform that task. To invoke a task, a user enters the task number, as a command, at a prompt of the deployment utility. For example, a user invokes Task 4 by entering a “4” at a prompt of the deployment utility.
Task 4108 of
As shown in
In step 144, the deployment utility receives the full path and name of the WSDL file. In some embodiments, if the name of the WSDL file is provided without the path, the deployment utility searches a predetermined default folder for the specified name of the WSDL file. In step 146, the deployment utility retrieves the WSDL file.
In step 148, the deployment utility creates and/or updates application system properties. In various embodiments, the application system properties comprise connection properties of a connection bundle and correlator (interaction) properties which are stored in a correlator file. In various embodiments, the application system is IMS. In some embodiments, step 148 implements steps a and b, 122 and 124, of
Steps 150 and 152 correspond to step c 126 of
Steps 154 and 156 correspond to step d 128 of
If in step 172, the user responds “Yes” to view available connection bundles, in step 176, the deployment utility displays the connection bundle. In step 178, a connection bundle is selected. In step 180, the connection properties are retrieved from the selected connection bundle.
If in step 170, the user responds “No” to not use an existing connection bundle, in step 182, the deployment utility prompts the user to enter the connection properties. In some embodiments, for example, the connection properties comprise connection bundle name, an IMS Connect host name, an IMS Connect port number (default: 9999), the IMS data store name, an optional resource access control facility (RACF) user identifier, an optional RACF group name and optional RACF password and the deployment utility prompts the user to enter each of the connection properties. In some embodiments, if a user does not enter a mandatory connection property, a default value is used for that connection property. In step 184, the connection properties are stored in the connection bundle having the specified name.
In some embodiments, the correlator properties are used to correlate or associate a web service with a driver in addition to specifying other interaction properties. The IMS SOAP gateway uses the correlator file to correlate an incoming SOAP request from the client application with an appropriate driver and, in some embodiments, a converter, on the application system based on one or more correlator properties. The IMS SOAP gateway also uses the correlator file to retrieve the name of connection bundle to use.
In step 196, the deployment utility stores the correlator properties in the correlator file. One example of a correlator file, called IVTNO.xml, is shown below:
The exemplary correlator file above is for accessing an IMS application using IMS Connect and a driver named “cancel” in response to a web service having a urn called “IVTNO” being invoked on the IMS SOAP gateway. In other embodiments, the correlator file may comprise different correlator properties.
In some embodiments, step 148 of
In response to the WSDL file and converter(s), and in some embodiments, a driver, not being provided in step 204, for example, the user responds “No”, step 208 determines whether an existing options file is to be used. In various embodiments, step 208 asks the user whether to use an existing options file either from user input or a default value. In response to a reply of “Yes,” the deployment utility retrieves the path and name of the options file, and WDz is invoked to generate the WSDL file, driver, converters and correlator file based on the options file. The options file is used by WDz. Step 210 proceeds to step 148.
If step 208 determines that an existing options file is not to be used, step 212 prompts the user to determine if the user wants to generate the options file. If not, in step 214, the deployment utility exits. If so, in step 216, the deployment utility retrieves parameters and a copybook location. In step 218, the deployment utility generates the options file based on the parameters and copybook at the copybook location. In some embodiments, to generate the options file, the deployment utility prompts the user for the parameters of the options file. In various embodiments, the option parameters of the options file comprise: a copybook file name, input data type name, output data type name, inbound codepage, outbound codepage, host codepage, IMS SOAP gateway host name, IMS SOAP gateway port number, and file output file. In some embodiments, the copybook is a COBOL copybook. The options for generation of artifacts are stored in the options file. In step 220, the deployment utility invokes WDz to generate a WSDL file, driver, converter and correlator file based on the options file; therefore advantageously the user does not need to open WDz. Step 220 proceeds to step 148.
Steps 148-158 of
In other embodiments, the deployment utility allows a user to set up their own default properties for the correlator file, connection bundle, and in some embodiments, the options file, rather than using predefined default properties of the deployment utility.
Other tasks of the deployment utility will now be described. In various embodiments, the deployment utility provides a task, Task 3 (
In various embodiments, Task 5 (
The user is prompted to enter the full path of the correlator file. If no path is provided, the deployment utility uses a default path. The deployment utility stores the correlator properties in the correlator file. In various embodiments, if a user does not enter a correlator property, the deployment utility uses a default value for that correlator property.
If the user has chosen to update the correlator properties, the user is prompted as to whether they want to view the correlator file. The user is then prompted to select the property to update: driver name(d), socket timeout(s), execution timeout(e), LtermName(1), inbound codepage (i), host codepage(h), outbound codepage(o) and connection bundle(c). In response to selecting a correlator property, the current value is displayed and the user is prompted to enter a new value. The deployment utility saves the new value in the correlator file.
Task 6 (
In Task 6 (
In Task 6 (
Task 7 (
Task 8 (
Task 9 (
In expert mode, the deployment utility provides a command line interface comprising a plurality of deployment-utility commands. The command line interface comprises a deployment-utility command to start the IMS SOAP gateway: iogtool −1. The command line interface also comprises a deployment-utility command to stop the IMS SOAP gateway: iogtool −2.
To deploy an application, the command line interface provides a deployment-utility command as follows:
iogtool −7 −2 [WSDL file name] −c [correlator file name]
In various embodiments, this deployment-utility command causes the function of Task 7 (
To generate client code the following deployment-utility command is used:
iogtool −8 −w [WSDL file name] −d [client code destination]. The order of the −w and −d parameters does not matter. In various embodiments, this command causes the functions of Task 8 (
To undeploy an application, the following deployment-utility command is provided:
iogtool −9 −w [WSDL name].
In various embodiments, this command causes the functions of Task 9 (
To create a new correlator using the command line interface, the following deployment-utility command is provided:
iogtool −5 −c −w [WSDL file name] [−parameters]
The parameters comprise:
Parameters having predefined values comprise:
Inbound Codepage: 1208
Host Codepage: 1140
Outbound Codepage: 1208.
Parameters are entered at the end of the command line and can be entered in any order. Parameters −n is mandatory in this command. Default values will be used for any parameters that are unspecified. A parameter that is entered but not followed by a value will also use a default value. Codepage parameters cannot be changed.
In various embodiments, the deployment utility checks the validity of each parameter and returns an error if a parameter is invalid. For example, the deployment utility checks that the socket timeout value is greater than zero, that the execution timeout is between −1 and 3600000, that the Iterm name is less than eight characters, that when the −n parameter is specified that the connection bundle name is provided, and that the connection bundle name is less than twenty characters and does not contain spaces.
The following deployment-utility command can be used to update an existing correlator file:
iogtool −5 −u −x [Correlator file name] [−parameters]
The parameters comprise:
Parameters having predefined values comprise:
Inbound Codepage: 1208
Host Codepage: 1140
Outbound Codepage: 1208.
Parameters are entered at the end of the command line and can be entered in any order. Specifying the additional parameters will update the correlator file. A parameter that is entered but not followed by a value will be changed to the default value. Codepage parameters cannot be updated.
Connection bundle properties can also be set using the command line interface. To create a connection bundle, the following deployment-utility command is provided:
iogtool −6 −c −n [Connection bundle name] [−parameters]
The parameters comprise:
Parameters are entered at the end of the command line and can be entered in any order. Default values will be used for any parameters that are not specified. A parameter that is entered but not followed by a value will use a default value.
In some embodiments, the deployment utility also checks the validity of the parameters and returns an error if a parameter is invalid. For example, the deployment utility checks that the connection bundle name has not been used and that the datastore name, the user identifier (Id) and password are less than or equal to eight characters.
The following command is used to update a connection bundle:
iogtool −6 −u −n [Connection bundle name] [−parameters]
The parameters comprise those listed above to create a connection bundle. In addition, the following parameter is provided:
−r [Connection bundle rename].
Parameters are entered at the end of the command line and can be entered in any order. Specifying the additional parameters will update the connection bundle. An option that is entered but not followed by a value will be changed to the default value.
The following deployment-utility command is used to delete an existing connection bundle:
iogtool −6 −d −n [Connection bundle name]
Various IMS SOAP gateway properties may be set or changed using the command line interface. The following deployment-utility command is used to set or change IMS SOAP gateway properties:
iogtool −3 [−parameters]
The parameters comprise:
Values will remain unchanged for any parameters that are not specified. A parameter that is entered but not followed by a value will use a default value.
Various embodiments of the deployment utility provide a batch facility to support the deployment of an IMS application to an IMS SOAP gateway as a web service. A user creates a batch file comprising one or more deployment-utility commands of the command line interface of the deployment utility, and uses the deployment utility to execute the commands in the batch file.
The memory 240 generally comprises different modalities, illustratively semiconductor memory, such as random access memory (RAM), and disk drives. In various embodiments, the memory 240 stores an operating system 258, the deployment utility 56, the SOAP gateway 260, and in some embodiments WDz 52. The SOAP gateway 260 has a web service 34. In various embodiments, the SOAP gateway 260 is the IMS SOAP gateway 20 of
Computer systems 270 and 280 are coupled to the network 252 via transmission mediums 282 and 284, respectively. Computer system 270 comprises an application system 286. In some embodiments, the application system 286 is IMS 28 of
In various embodiments, the specific software instructions, data structures and data that implement various embodiments of the present invention are typically incorporated in the deployment utility 56. Generally, an embodiment of the present invention is tangibly embodied in a computer-readable medium, for example, the memory 240, and is comprised of instructions which, when executed by the processor 232, cause the computer system 230 to utilize the present invention. The memory 240 may store the software instructions, data structures and data for any of the operating system 258 and deployment utility 56 in semiconductor memory, in disk memory, or a combination thereof. Other computer memory devices presently known or that become known in the future, or combination thereof, may be used for memory 240.
The operating system 258 may be implemented by any conventional operating system such as AIX® (Registered Trademark of International Business Machines Corporation), UNIX (Trademark of the Open Group in the United States and other countries), Windows® (Registered Trademark of Microsoft Corporation), Linux® (Registered trademark of Linus Torvalds), Solaris® (Registered trademark of Sun Microsystems Inc.) and HP-UX® (Registered trademark of Hewlett-Packard Development Company, L.P.).
In various embodiments, the present invention may be implemented as a method, computer system, apparatus or article of manufacture using standard programming and/or engineering techniques to produce software, firmware, hardware, or any combination thereof. The term “article of manufacture” (or alternatively, “computer program product”) as used herein is intended to encompass a computer program accessible from any computer-readable device, carrier or media. In addition, the software in which various embodiments are implemented may be accessible through the transmission medium, for example, from a server over the network. The article of manufacture in which the code is implemented also encompasses transmission media, such as the network transmission line and wireless transmission media. Thus the article of manufacture also comprises the medium in which the code is embedded. Those skilled in the art will recognize that many modifications may be made to this configuration without departing from the scope of the present invention.
The exemplary computer system illustrated in
In some embodiments, the utility provides a light-weight, stand-alone command line utility, including a batch facility, to help IMS customers retarget IMS applications to support Web services without changing the existing IMS applications. In various embodiments, the deployment utility provides the customer with an end-to-end utility to automate the process of enabling IMS applications as web services. Although various embodiments have been described with respect to XML, in other embodiments, other mark-up languages may be used rather than XML.
The foregoing detailed description of various embodiments of the invention has been presented for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise form disclosed. Many modifications and variations are possible in light of the above teachings. It is intended that the scope of the invention be limited not by this detailed description, but rather by the claims appended thereto.
