This is the Specification User's Guide for the 1.1 Maintenance release of the JSR-147 Workspace Versioning and Configuration Management (WVCM) API. Note that this maintenance release is designed to take advantage of the features provided by Java 5.0, and therefore requires a Java 5.0 or higher compiler and JDK.

For details on how to load the project into Eclipse and re-compile the sources and the Javadoc, read below. These instructions assume you have installed Eclipse. Eclipse details and installation instructions can be found at the Eclipse web site. Eclipse 3.3 was used for development of the 1.1 maintenance release of the WVCM reference implementation (RI) and technology compatibility kit (TCK).

Setup

The specification is usually distributed as a zip file, with the top level directory in this zip file named "javax.wvcm". Extract this to a place of your choosing, e.g. "C:\" to create the "javax.wvcm" subdirectory. This directory is a valid Eclipse project for Eclipse versions 3.1 and higher.

Run Eclipse and import the "javax.wvcm" project. This is typically done by selecting menu item "File->Import" and selecting "Existing Projects into Workspace". Menus and dialogs vary slightly depending on Eclipse version.

Once imported, the Java source should automatically compile without error. The result of the compilation will be Java class files in a "bin" directory beside the "src" directory.

To re-create the wvcm.jar file for the javax.wvcm project, right click the project, select "Export...", and select "JAR file" as the export destination.

To re-create the javadoc for the javax.wvcm project, right click the project, select "Export...", and select "javadoc" as the export destination.

Creating a WVCM Implementation

If you are writing your own WVCM implementation, you will want to make use of the JSR-147 TCK to test your implementation for compliance. See the separately distributed "com.ibm.rational.wvcm.tck" project for details on how to invoke the TCK against your implementation. The source code for the TCK's unit tests can also be useful in understanding how a WVCM implementation is supposed to function.

You may also examine and run tests against the WVCM Reference Implementation (RI) to learn more about the functionality that is expected by the WVCM specification. The RI is the separately distributed "com.ibm.rational.wvcm.ri" project. The com.ibm.rational.wvcm.ri.impl and com.ibm.rational.wvcm.ri.srvc packages contains classes that can be re-used in most implementations. The TCK can also be used to test the RI (and does so by default).