< 上一课 | 下一课 >

设置和安装 ClearQuest CM API

在可以使用 ClearQuest® CM API 之前,必须将文件添加至类路径,并且安装了 Rational® ClearQuest 许可版本。
API 是用于执行有关 Rational 产品操作的公共组件。要将这个 API 用于 Rational 产品,必须在自己的系统上安装该产品。 必须还将 API 文件复制到您的类路径下,这些 API 文件是在安装 Rational 产品时安装到了系统上。
以下 Java 包是使用 API 执行 Rational ClearQuest 操作所必需的。
  • javax.wvcm:工作空间版本控制和配置管理软件包(WVCM)。
  • com.ibm.rational.wvcm.stp:Rational 软件团队软件包是 WVCM 软件包的扩展。该包包含 API 接口,并且 为 Rational 产品资源提供公共对象模型。该软件包独立于针对产品的存储库或独立于实现。
  • com.ibm.rational.wvcm.stp.cq: 是特定于产品的扩展, 该扩展提供了对 ClearQuest 数据库的访问。 通过该软件包可以更全面地(针对产品)使用 ClearQuest 数据库的功能及其底层资源。

尽管您应该能够将本文档中的代码示例剪贴并复制到可编译的 Java 中,但是该代码可能无法编译,可能包含印刷性错误,导致无法编译。这些示例完整的可编译版本位于 Eclipse 项目,该项目名称为 samples,位于随 API 文档分发的补充归档文件中。

缺省情况下,ClearQuest CM API JAR 文件 和其他必要的 JAR 文件安装在以下位置, 其中 install-dir 表示 Rational 产品 文件的安装目录。缺省情况下,该目录是 /opt/rational(UNIX® 系统和 Linux® 系统上)或者 C:\Program Files\IBM Rational( Windows® 系统上)。
  • 在 Windows 系统上:
    • <install-dir>/Common/stpwvcm.jar: ClearQuest CM API 接口 JAR 文件。
    • <install-dir>/Common/stpcmmn.jar:公共实现 JAR 文件。
    • <install-dir>/ClearQuest/stpcq.jar:ClearQuest 产品的扩展。
    • <install-dir>/ClearQuest/cqjni.jar:Rational ClearQuest JAR 文件。
  • 在 UNIX 和 Linux 系统上:
    • <install-dir>/common/stpwvcm.jar
    • <install-dir>/common/stpcmmn.jar
    • <install-dir>/clearquest/cqweb/lib/stpcq.jar
    • <install-dir>/clearquest/cqweb/lib/cqjni.jar

在可以使用 API 之前,必须将 API JAR 文件位置添加到您的类路径中。

要从 Eclipse 插件访问 ClearQuest CM API,请执行以下步骤:

  1. 使用归档文件 %RATIONAL_INSTALL%\common\cm\teamapi.zip 中位于目录 \plugins\com.ibm.rational.stp.cmapi 中的文件来创建一个 Eclipse 插件。
  2. 要将 ClearQuest CM API 插件添加到运行时配置中,请将该插件复制到 Eclipse 实例中或创建一个新的扩展安装点。 这样会为 API 创建新的目录(例如,C:\eclipse\plugins\com.ibm.rational.stp.cmapi)。 这个新插件由 ClearQuest CM API JAR 文件和 Rational ClearQuest JAR 文件组成。
  3. 创建好插件目录后,必须将各个已安装的 JAR 文件从其安装位置复制到该目录中。 ClearQuest JAR 文件需要 ClearQuest CM API JAR 文件。 下次启动 Eclipse 时,该插件就已可供使用。
  4. 要从插件使用 ClearQuest CM API,请确定与 com.ibm.rational.stp.cmapi 存在依存关系。
现在,您已经准备好开始使用 ClearQuest CM API 来编写 Java 程序。
您必须安装了 Rational ClearQuest 的许可版本,才能使用 API 月 ClearQuest 资源。 如果安装并配置了 JAR 文件,但未安装相应的产品,那么调用这个 Java 软件包会失败。

课程检查点

既然您已经设置好系统来用 ClearQuest CM API 编程,接下来准备开始学习 API 对象模型和编程模型。
在本课程中,您学习到了以下内容:
  • ClearQuest CM API 和 Rational ClearQuest 之间的关系
  • 如何设置系统来利用 ClearQuest CM API 进行编程
  • ClearQuest CM API 中哪些文件是系统必需的。
< 上一课 | 下一课 >

反馈