< Vorherige Lektion | Nächste Lektion >

CM API einrichten und installieren

Bevor Sie die CM API verwenden können, müssen Sie Ihrem Klassenpfad Dateien hinzufügen, und Sie müssen eine lizenzierte Version des Rational-Produkts installiert haben.
Die CM 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 CM-API-Dateien, die bei Installation des Rational-Produkts auf Ihrem System installiert sind, in Ihren Klassenpfad kopieren.
Die CM-API-Dateien, die für die Arbeit mit Rational-ClearQuest-Ressourcen erforderlich sind, umfassen Dateien, die für alle CM-API-Ressourcentypen erforderlich sind, und Dateien, die für Rational-ClearQuest-Ressourcen erforderlich sind. Diese Java-Pakete sind erforderlich, um mit der Rational CM API Rational-ClearQuest-Operationen 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 Rational CM 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 die Rational-ClearQuest-Datenbanken bietet. 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, den Code in diesem Dokument auszuschneiden und in kompilierbaren Java-Code einzufügen. Allerdings wurde der Code nicht kompiliert und könnte Schreibfehler enthalten, die die Kompilierung verhindern können. 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 Dokumentation für die Rational CM API bereitgestellt wird.

Die JAR-Datei der Rational CM API und andere erforderlichen JAR-Dateien sind standardmäßig in den folgenden Positionen installiert. Installationsverzeichnis steht für das Verzeichnis, in dem die Rational-Produktdateien installiert sind. Dies ist unter UNIX und Linux standardmäßig das Verzeichnis /opt/rational und unter Windows das Verzeichnis C:\Programme\IBM Rational.
  • In Windows-Systemen gilt Folgendes:
    • <Installationsverzeichnis>/Common/stpwvcm.jar: Die JAR-Datei der Rational-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 Rational-ClearQuest-JAR-Datei.
  • In UNIX- und Linux-Systemen gilt Folgendes:
    • <Installationsverzeichnis>/common/stpwvcm.jar
    • <Installationsverzeichnis>/common/stpcmmn.jar
    • <Installationsverzeichnis>/clearquest/cqweb/lib/stpcq.jar
    • <Installationsverzeichnis>/clearquest/cqweb/lib/cqjni.jar

Damit Sie die JAR-Dateien der Rational CM API verwenden können, müssen Sie alle ihre Speicherpositionen zu Ihrem Klassenpfad hinzufügen.

Damit Sie über ein Eclipse-Plug-in Zugriff auf die Rational CM API haben, können Sie die Datei com.ibm.rational.stp.teamapi.zip und Beispielprojekte in Eclipse importieren, oder Sie können folgende Schritte ausführen:

  1. Erstellen Sie mit den Dateien, die in der Datei com.ibm.rational.stp.teamapi.zip gepackt sind, ein Eclipse-Plug-in.
  2. Damit das Rational-CM-API-Plug-in zu Ihrer Laufzeitkonfiguration hinzugefügt wird, kopieren Sie es in die Eclipse-Instanz oder erstellen Sie eine neue Position für die Installation der Erweiterung. Dadurch wird ein neues Verzeichnis für die Rational CM API erstellt (z. B. C:\eclipse\plugins\com.ibm.rational.stp.teamapi). Dieses neue Plug-in ist ein einfaches eigenständiges Eclipse-Plug-in, das aus den JAR-Dateien der Rational CM API sowie den produktspezifischen JAR-Dateien besteht. Beachten Sie, dass die .zip-Datei nicht die eigentlichen JAR-Dateien des Produkts enthält.
  3. Nachdem Sie das Plug-in-Verzeichnis erstellt haben, muss jede installierte JAR-Datei aus der Installationsposition in das neue Plug-in-Verzeichnis kopiert werden. Für jede JAR-Datei ist die JAR-Datei der Rational CM API erforderlich. Beim nächsten Start von Eclipse kann das Plug-in verwendet werden.
  4. Damit Sie die Rational CM API aus Ihrem Plug-in verwenden können, legen Sie com.ibm.rational.stp.teamapi als Abhängigkeit fest.
Jetzt können Sie damit beginnen, Java-Programme mit der Rational CM API zu schreiben.
Damit Sie die Rational CM API mit ClearQuest-Ressourcen verwenden können, muss eine lizenzierte und installierte Version von Rational ClearQuest vorhanden sein. 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 jetzt das System für die Programmierung mit der CM API eingerichtet haben, werden Sie im nächsten Schritt das CM-API-Objektmodell und -Programmiermodell kennen lernen.
In dieser Lerneinheit haben Sie folgende Kenntnisse erworben:
  • Sie haben gelernt, welche Beziehung zwischen der CM API und Rational ClearQuest existiert.
  • Sie haben gelernt, wie Sie Ihr System für die Programmierung mit der CM API einrichten.
  • Sie haben gelernt, welche Dateien in der CM API für Ihr System erforderlich sind.

Feedback
< Vorherige Lektion | Nächste Lektion >