Soapam Client Documentation
Total Page:16
File Type:pdf, Size:1020Kb
SOAPam Client Documentation This documentation is for SOAPam Client version 3.1. Not using this version? See Other Documentation Versions. Welcome to the documentation center for SOAPam Server by NuWave Technologies. You may navigate through the documentation using any of these methods: The table of contents The navigation links in the sidebar to the left The quick links shown below The search bar in the page header If you have comments, corrections, or questions about the product that are not answered here, please email [email protected] or submit a support ticket. Getting Started What is SOAPam Client Installing SOAPam Client For Developers The Developer's Guide Creating and Editing the Client Definition File Accessing Secure Web Services For Administrators The Administrator's Guide Installing SOAPam Client Managing SOAPam Client Command Line Reference Release Notes Table of Contents Table of Contents What is SOAPam Client Administrator's Guide Installing SOAPam Client Managing SOAPam Client Running the Client Process Collecting Process Statistics Using Configuration Files Configuration File Format Log Configuration Message Dump Configuration Statistics Configuration Common Configuration Options Event Message Reference Developers Guide Creating and Editing the Client Definition File Configuring the Client Process Generating IPM Definitions Generating DDL from a CDF Element Name Considerations Generating IPM Definitions from DDL Calling a Web Service Method Web Service Requests Web Service Replies Using the Stream Protocol Accessing Secure Web Services Using HTTP Authentication Using Client Certificates Using Credential Files Using the MAKECF Utility Using Secure Connections Using W-S Security and WS-Addressing Client Definition File Reference Schema Reference <binding> element <body> element <definitions> element <element> element <header> element <message> element <messages> element <part> element <request> element <response> element <service> element <soapMessage> element <type> element <types> element Built-in Types Character Encodings Command Line Reference CDF2DDL MAKECF SOAPAMCP STATSCON WSDL2CDF Glossary Release Notes Upgrade Considerations Upgrade Guide Product Licensing Cumulative Change Log Third Party Software Licenses Standards Compliance How to Obtain Support Other Documentation Versions View as PDF What is SOAPam Client The SOAPam Client allows NonStop applications to access, or "consume", Web services on any platform anywhere in the world. SOAPam hides the complexity of TCP/IP, HTTP, SSL and SOAP required to participate in Web services.Your NonStop application simply sends a formatted interprocess message (IPM) to the SOAPam Client Process (SOAPAMCP) which handles all of the details of mapping the IPM elements to a SOAP envelope, exchanging the SOAP envelope with the Web service provider, and parsing the SOAP response into the reply IPM. What is a Web Service? A Web service is a collection of software "methods" that can be invoked (called) through a network by a client application using the SOAP protocol. Methods typically accept one or more parameters, perform some action and return one or more parameters.An example of a Web service might be a "BankingService" that provides methods such as "getAccountBalance", "debitAccount" and "creditAccount". For example, the "getAccountBalance" method might require an "accountNumber" parameter as input and return a "balance" parameter as output. SOAPam Client Components The diagram below depicts the SOAPam Client components as they are used at design time (during client application development) and at run time. The components of the SOAPam Client product are described below: Client Process (SOAPAMCP) The Client Process relays messages sent from client applications through NonStop’s native inter-process message system to Web services anywhere in the world. SOAPAMCP hides the complexity of the TCP/IP, HTTP, SSL and SOAP protocols required to participate in Web services. When you start the SOAPAMCP process, you specify the name of a Client Definition File (CDF) that contains a description of the Web service you want to access. The CDF is an XML-formatted text file that you create using the WSDL2CDF utility. The SOAPAMCP process can be run as a standalone named process or configured as a Pathway serverclass for scalable access to the target Web service. WSDL2CDF Utility The WSDL2CDF utility creates a Client Definition File (CDF) by reading the Web Service Description Language (WSDL) file that describes the target Web service and augmenting it with mapping information. The Client Definition File (CDF) contains all of the information needed by the SOAPAMCP process to map a request IPM to a Web service request and map the Web service response back to an reply IPM. CDF2DDL Utility Your NonStop application interfaces with the SOAPAMCP process through the native interprocess message system. The format of the request and response interprocess messages (IPMs) used must correspond precisely to the definitions in the CDF file. The CDF2DDL utility facilitates this by producing NonStop DDL source for the IPMs. You then use the NonStop DDL utility to produce the host language-specific definitions that you compile into your application. Administrator's Guide Installing SOAPam Client This section contains all the information you need to install SOAPam Client. Installation Prerequisites Obtaining the Software Selecting an Installation Volume Extracting the Release Files Obtaining and Installing a License Testing the Installation Installation Prerequisites Please refer to the Release Notes for the latest information. The Release Notes can be viewed at the NuWave Technologies Support Center. SOAPam Client requires the following HP NonStop Server software: HP NonStop™ Kernel D48/G06.15/H06.09 or later HP NonStop TCP/IP HP NonStop TM/MP Although not required, SOAPam integrates with these products, if installed: HP Data Definition Language HP TCP/IP Parallel Library, or TCP/IPv6 Obtaining the Software SOAPam Client is distributed as single PAK file which you can download over the Internet. To download the software, use your Web browser to visit the NuWave Technologies Download Center. Click the hyperlink to download the PAK file to your desktop system, then use FTP to upload the file to your NonStop Server (be sure to use binary transfer mode). Note that the PAK file name is in the format CRmnppa where: mnpp indicates the version number in the form major.minor.patch, e.g., 3001 indicates release 3.0.1 a indicates the target architecture, where R indicates TNS/R (S-Series) and E indicates TNS/E (H and J series). Selecting an Installation Volume The SOAPam program files require approximately 30 megabytes of disk space and may be installed on any volume with sufficient space. Extracting the Release Files After copying the WCSPAK PAK file to your NonStop Server, perform the following steps at a TACL prompt. Note that you should substitute the correct PAK file name for your system architecture (WSCPAKR for TNS/R or WSCPAKE for TNS/E).: 1. If you are upgrading an existing installation of SOAPam Client, stop any SOAPAMCP processes running from the current subvolume. This may require shutting down any Pathway systems that are running the SOAPAMCP process as a server. tacl> STATUS *, PROG SOAPAMCP 2. Extract the release files from the archive by running WSCPAK: tacl> UNPAK PAKFILE, (*.*.*), VOL $volume.subvolume, MYID, LISTALL where $volume.subvolume specifies the location to store the extracted files. Because the UNPAK program uses the Guardian RESTORE utility, you must have "execute" permission for that program. If you are extracting the the TNS/E version, specify WSCPAKE instead of WSCPAKR. 3. You may delete the PAK file at this time if you wish: tacl> PURGE PAKFILE Obtaining and Installing a License SOAPam Client requires the installation of a license. The license is installed in an edit file on the NonStop Server which is read by the SOAPAMCP program to validate the installation. If you have purchased the product your license will be delivered via email. If you are using a trial copy of the product, trial licenses may be requested at the NuWave Technologies License Center. You must know your system number in order to request a trial license. The system number can be determined using the NonStop SYSINFO program which can be run from the TACL prompt: tacl>SYSINFO SYSINFO - T9268H01 - (01 OCT 2004) SYSTEM \NSKNODE Date 07 Jan 2015, 12:00:00 Copyright 2003 Hewlett-Packard Development Company, L.P. System name \NSKNODE EXPAND node number 001 Current SYSnn SYS00 System number 012345 Software release ID H06.nn Note that when requesting a license from the License Center you must enter all digits of the license including the leading '0's. Once your trial license is delivered via email install the license using the procedure outlined in the section Product Licensing. Testing the Installation The SOAPam Client software includes a TACL routine that tests the installation by connecting to the EchoString sample web service on NuWave's SOAPam demonstration server. You can test your installation by entering the following command at the TACL prompt: Note that. in order to run this test, your NonStop system must have access to the Internet. tacl> run ECHOTEST SOAPam(tm) Client - Echo String Test This TACL routine uses the SOAPam Client Process to access the EchoString service at http://soapam.nuwavetech.com. Starting the SOAPam Client Process ... Sending a request to the EchoString service ... Checking the