Vibe implements Java Web services, which provide a set of operations that client programs can use to exchange information with Vibe. The alphabetized reference section in this documentation provides syntax for these operations (Section B.0, Deprecated Web Services Operations).
You can view a list of available operations online:
The latest operations are listed under theheader, and the deprecated operations are listed under the header.
You can also access the Vibe Web Services Description Language (WSDL) file:
In the previous two examples, replace the localhost specification with the host and port for your Vibe installation.
NOTE:Vibe does not currently publish its WSDL file with Universal Description, Discovery, and Integration (UDDI) or the Web Services Inspection Language (WSIL). Use the alphabetized reference section in this manual (Section A.0, Web Services Operations) or the URL-generated WSDL file to understand the Vibe operation interface. For reference information about earlier Web Services operations that have been superseded by the current release, see Section B.0, Deprecated Web Services Operations.
When you make calls to Vibe Web services, there are two ways that you can implement lower-level Simple Object Access Protocol (SOAP) calls:
Unzip client-side routines on the system running your application. These routines are Java classes and other files that produce a stub. Your application can use an interface with these stub routines, which make the SOAP calls to and from the server. See Section 1.6, Client Stubs, for more information about implementing these client-side routines on your application’s system.
Have your application perform the SOAP calls by using, for example, routines from the Apache Axis toolkit.
Vibe Web services accepts and provides data by using Java objects and methods defined in the Vibe source code. (Visit the Open Source Community page for more information about downloading the source code.) Although this section provides tips for locating object and method definitions, you might want to apply a tool such as Javadoc to the sources, so that you have reference pages to assist you in working with the Vibe objects and methods.
The primary method of learning to use Vibe Web services is by reviewing sample clients and their source code, which are provided in the Vibe sources.
Vibe provides sample clients in its product code base that can assist you in learning how to use its Web services. The sample clients are located within the source code:
The following sample clients are provided. They are listed in the order of how helpful they are in learning how to make Web service calls:
teamingservice-client-with-stub.bat (Teaming 2.0+): Uses client-side routines to implement a Windows batch file for simple operations. This is the recommended method. Using this batch file requires the installation of the client-side routines.
teamingservice-client-with-call.bat (Teaming 2.0+): Uses the Axis Call object when making Web service calls, as a way to implement a Windows batch file for simple operations.
facade-client.bat (V1+): Uses the deprecated Web services interface.
wsExport.bat and wsImport.bat (Teaming 2.0+): Takes data from a portion of the workspace and folder hierarchy and reproduces it on another file system. These tools are not a complete import and export facility, because they do not retain the workflow states, access-control settings, and history of the original objects.
You can find the source files for the sample clients here:
The TeamingServiceClientWithCall.java file extends the WSClientBase.java file, which is also located in the /ssf/samples/wsclient/src/org/kablink/teaming/samples/wsclient directory.
Before executing the sample .bat programs on a Windows system, you need to do some work in your build to enable them.
Execute the build Ant target in /ssf/samples/wsclient/build.xml by entering ant from the command line.
To use one of the batch files:
Use a command line window to cd to the /ssf/samples/wsclient directory.
Type the filename for the batch file you want to execute.
To see a list of legal commands and arguments for one of the teamingservice or facade batch files, type only the filename of the batch file, then press the Return key.
On the same line, just after the name of the batch file, type a command name and desired arguments.
Press the Return key.
If the command executes successfully, Vibe displays the return value in the command line window.