Web Services › User-Written Client Programs

User-Written Client Programs

A client program that use Web Services is an object oriented program that instantiates and populates certain objects. A client stub is required to convert parameters passed between the client and Web Services.

The program developer writes the client program to collect the following information:

• A login user ID and password for access to a specified CA Endevor SCM repository.
• An SCL statement with optional wsParameters.
• If this is a submitSCL request, then parameters for a SOAP Attachment to transport data to and from Web Services are also required.

The program developer creates a client stub from the WSDL published by Web Services so that the program meets the requirements of the web service. The client stub is used to convert the parameters passed between the client application and the web server. After creating the stub, the developer incorporates the stub as an import package in the client program. The developer implements the client application's logic above the client stub.

• For client programs written in C, the stub, in C code, is compiled and the generated header files are required to code the application program. The application program must have the #include structure.h in C++ include wobject.h>
• For client programs written in Java, the stub is a collection of Java sources grouped in a package. The sources are compiled by the javac compiler into a JAR file. This JAR file is required by the sample code. The program code must include an import statement that refers to the generated packages (this allows the java IDE to make the Loginproperties object available to the application program). The client program can instantiate the stub to invoke the web service. For a client to access the stub, the stub class should be present in the classpath of the client application.

  A Java client program instantiates the following objects and populates them with the correct values for a specific request.

  • LoginProperties
  • SCL
  • Attachment

  The client stub created from the Web Services WSDL supports the instantiation of these objects. The data in these objects is required by Web Services. The client program populates the objects with the required parameters.