< Zurück | Weiter >

ClearQuest CM-API einrichten und installieren

Damit Sie die ClearQuest CM-API verwenden können, müssen Sie Ihrem Klassenpfad Dateien hinzufügen und eine lizenzierte Version von Rational ClearQuest installiert haben.
Die API ist eine allgemeine Komponente zur Ausführung von Operationen für Rational-Produkte. Damit Sie diese API mit einem Rational-Produkt verwenden können, muss das Produkt auf Ihrem System installiert sein. Außerdem müssen Sie die API-Dateien, die bei der Installation des Rational-Produkts auf Ihrem System installiert werden, in Ihren Klassenpfad kopieren.
Die folgenden Java-Pakete sind erforderlich, um Rational ClearQuest-Operationen durch Verwendung der API auszuführen.
  • javax.wvcm: Das WVCM-Paket (Workspace Versioning and Configuration Management).
  • com.ibm.rational.wvcm.stp: Das Rational-Software-Team-Paket ist eine Erweiterung des WVCM-Pakets. Dieses Paket enthält die Schnittstellen der API und stellt das allgemeine Objektmodell für Rational-Produktressourcen bereit. Dieses Paket ist unabhängig von produktspezifischen Repository- oder Implementierungsgrenzen.
  • com.ibm.rational.wvcm.stp.cq: Eine produktspezifische Erweiterung, die Zugriff auf ClearQuest-Datenbanken zur Verfügung stellt. Dieses Paket enthält Funktionen, die einen umfassenderen (produktspezifischen) Zugriff auf die Funktionalität einer ClearQuest-Datenbank und ihre zu Grunde liegenden Ressourcen bereitstellt.

Zwar sollte es prinzipiell möglich sein, die Codebeispiele in diesem Dokument auszuschneiden und in kompilierbaren Java-Code einzufügen. Allerdings wurde der Code nicht kompiliert und er könnte Schreibfehler enthalten, die die Kompilierung möglicherweise verhindern. Sie finden vollständige, kompilierbare Versionen dieser Beispiele in dem Eclipse-Projekt mit dem Namen samples in der ergänzenden Archivdatei, die zusammen mit der API-Dokumentation verteilt wird.

Die JAR-Datei für die ClearQuest CM-API und weitere erforderliche JAR-Dateien werden standardmäßig an den folgenden Positionen installiert. Dabei ist Installationsverzeichnis das Verzeichnis, in dem die Rational-Produktdateien installiert wurden. Standardmäßig lautet dieses Verzeichnis /opt/rational auf UNIX®- und Linux®-Systemen und C:\Programme\IBM Rational auf Windows®-Systemen.
  • Auf Windows-Systemen:
    • <Installationsverzeichnis>/Common/stpwvcm.jar: Die JAR-Datei für die ClearQuest CM-API-Schnittstelle.
    • <Installationsverzeichnis>/Common/stpcmmn.jar: Eine JAR-Datei für allgemeine Implementierung.
    • <Installationsverzeichnis>/ClearQuest/stpcq.jar: Erweiterung für das ClearQuest-Produkt.
    • <Installationsverzeichnis>/ClearQuest/cqjni.jar: Eine JAR-Datei für Rational ClearQuest.
  • Auf UNIX- und Linux-Systemen:
    • <Installationsverzeichnis>/common/stpwvcm.jar
    • <Installationsverzeichnis>/common/stpcmmn.jar
    • <Installationsverzeichnis>/clearquest/cqweb/lib/stpcq.jar
    • <Installationsverzeichnis>/clearquest/cqweb/lib/cqjni.jar

Sie müssen die Positionen der API-JAR-Dateien Ihrem Klassenpfad hinzufügen, damit Sie die API verwenden können.

Führen Sie die folgenden Schritte aus, um von einem Eclipse-Plug-in auf die ClearQuest CM-API zuzugreifen:

  1. Erstellen Sie ein Eclipse-Plug-in unter Verwendung der Dateien im Verzeichnis \plugins\com.ibm.rational.stp.cmapi in der Archivdatei %RATIONAL_INSTALL%\common\cm\teamapi.zip.
  2. Kopieren Sie das Plug-in in Ihre Eclipse-Instanz oder erstellen Sie eine neue Installationsposition für die Erweiterung, um das Plug-in für die ClearQuest CM-API Ihrer Laufzeitkonfiguration hinzuzufügen. Dadurch wird ein neues Verzeichnis für die API erstellt (beispielsweise C:\eclipse\plugins\com.ibm.rational.stp.cmapi). Das neue Plug-in umfasst die JAR-Dateien für die ClearQuest CM-API und die JAR-Dateien für Rational ClearQuest.
  3. Nach der Erstellung des Plug-in-Verzeichnisses müssen Sie alle installierten JAR-Dateien von ihrem Installationspfad in dieses Verzeichnis kopieren. Für die ClearQuest-JAR-Dateien sind die JAR-Dateien der ClearQuest CM-API erforderlich. Das Plug-in kann ab dem nächsten Start von Eclipse verwendet werden.
  4. Zur Verwendung der ClearQuest CM-API von Ihrem Plug-in aus geben Sie com.ibm.rational.stp.cmapi als Abhängigkeit an.
Jetzt können Sie damit beginnen, Java-Programme unter Verwendung der ClearQuest CM-API zu schreiben.
Sie müssen über eine lizenzierte und installierte Version von Rational ClearQuest verfügen, damit Sie die API mit ClearQuest-Ressourcen verwenden können. Wenn Sie die JAR-Dateien installieren und konfigurieren, ohne dass das zugehörige Produkt installiert ist, scheitern die Aufrufe an dieses Java-Paket.

Prüfpunkt der Lerneinheit

Nachdem Sie Ihr System für die Programmierung mit der ClearQuest CM-API eingerichtet haben, können Sie damit beginnen, sich mit dem Objekt- und Programmiermodell der API vertraut zu machen.
In dieser Lerneinheit haben Sie folgende Kenntnisse erworben:
  • Sie haben gelernt, welche Beziehung zwischen der ClearQuest CM-API und Rational ClearQuest besteht.
  • Sie haben gelernt, wie Sie Ihr System für die Programmierung mit der ClearQuest CM-API einrichten.
  • Sie haben gelernt, welche Dateien in der ClearQuest CM-API für Ihr System erforderlich sind.
< Zurück | Weiter >

Feedback