How to Enable Web Services › Using Web Services › CA Endevor SCM SOAP Web Services

CA Endevor SCM SOAP Web Services

The SOAP client design model requires a client side stub. The web developer must create a client stub from the CA Endevor SCM Web Services WSDL (Web Services Description Language) file. WSDL is a service description protocol. The WSDL file is a dynamic XML file that serves as the interface between a client program and the web service. The Web Service WSDL file describes what CA Endevor SCM operations are available to the client program and the SOAP protocol bindings and message formats required to enable the client to interact with Web Services.

The client stub is responsible for conversion of parameters used in a function call and deconversion of the results passed from the server after execution of the function. The client stub interacts with the web service stub.

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.

Depending on the programing language of the client program, details for generating the client stub can differ, but conceptually the process is very similar. A stub generator is used to produce a stub for a particular programming language. Then the stub is included in the source code.

• 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.