Übersicht über System z Jazz Gateway

Mit Jazz Gateway können Sie Nummern und Status von Arbeitselementen programmgestützt aus dem Repository von Rational Team Concert for System z abrufen.

Jazz Gateway wird als Serverdämon unter z/OS, Windows®, Linux® und anderen Plattformen ausgeführt, um die SSL-Authentifizierung für ein Jazz-Repository auszuführen. Der Gateway übergibt die Nummer eines Arbeitselements in einer REST URI an das Jazz-Repository, um die XML des Arbeitselements abzurufen. Anschließend gibt er entweder den Status des Arbeitselements oder die vollständige XML des Arbeitselements an den Client zurück.

Kommunikation von Jazz Gateway mit dem Jazz-Repository

Der Jazz-Gateway-Serverdämon kommuniziert mit einem bestimmten Port, um die Clientanforderungen abzurufen. Unter z/OS werden diese Anforderungen gestellt, indem Sie einen System z Jazz-Gateway-Serverjob übergeben. Sie können Ihren REXX-Client so modifizieren, dass er einen bestimmten Port angibt, damit der Client und der System z-Jazz-Gateway-Serverdämon über eine Socketverbindung miteinander kommunizieren können.

  1. Verwenden Sie zum Aufrufen des REXX-Clients eine REXX EXEC, z. B. eine eigenständige EXEC oder einen SCLM-Benutzerexit, um die folgenden erforderlichen Parameter zu definieren:
    • userid (Benutzer-ID)
    • password (Kennwort)
    • Jazz repository URL (URL des Jazz-Repositorys)
    • port number (Portnummer)
    • work item number (Nummer des Arbeitselements)
  2. Der REXX-Client übergibt diese Daten an den System z Jazz-Gateway-Serverdämon und wartet auf eine Antwort.
  3. Der System z-Jazz-Gateway-Serverdämon authentifiziert sich beim Jazz-Repository und übergibt die Arbeitselementanforderung über eine REST URI.
  4. Der Jazz-Gateway-Server gibt die Arbeitselementinformationen in XML zurück, und der Serverdämon führt einen der folgenden Arbeitsschritte aus:
    • Er extrahiert den Status des Arbeitselements aus der XML.
    • Er übergibt die gesamte XML zurück an REXX-Client, der sie an die aufrufende EXEC zurückgibt.

Jazz Gateway installieren

Jazz Gateway wird unter z/OS mit SMP/E als Teil der Komponente 'Toolkit für Buildsystem für System z' installiert. Wenn Sie den Gateway auf den unterstützten verteilten Plattformen installieren möchten, müssen Sie auf Jazz.net von der Seite All Downloads von Rational Team Concert for System z die ZIP-Datei für Jazz Gateway herunterladen.

Voraussetzungen für die Installation von Jazz Gateway unter UNIX und Windows
  • IBM Java Software Development Kit (SDK) 1.5 muss installiert sein.
  • Die Umgebungsvariable JAVA_HOME muss auf ein Verzeichnis gesetzt werden, das ein Java 1.5 SDK enthält.
  • Die Datei java.exe muss in die Variable PATH aufgenommen werden.
Weitere Informationen hierzu finden Sie unter Detailed System Requirements for the Rational Team Concert for System z 2.0 server environments.

Jazz Gateway unter UNIX installieren

Führen Sie die folgenden Schritte aus, um Jazz Gateway unter UNIX zu installieren:
  1. Laden Sie die Datei RTCz-JazzRestGateway-2.0.0.2.zip von Jazz.net von der Seite "All Downloads" von Rational Team Concert for System z All heruner: https://jazz.net/downloads/rational-team-concert-z/releases/2.0.0.2.
  2. Dekomprimieren Sie die folgenden JAR-Dateien in Ihrem Jazz-Gateway-Installationsverzeichnis:
    • RTCz-JazzGateway-<Build-ID>.jar
    • log4j-1.2.12.jar
    • com.ibm.team.repository.common_1.0.1.I200909060153.jar
    • org.eclipse.osgi_3.4.3.R34x_v20081215-1030.jar
    • commons-httpclient-3.0.jar

Jazz Gateway unter UNIX mit Java aufrufen

Führen Sie die folgenden Schritte aus, um Jazz Gateway unter UNIX aufzurufen:
  1. Öffnen Sie ein Shell-Terminal.
  2. Wechseln Sie in das Verzeichnis, in dem die Dateien installiert sind.
  3. Geben Sie den folgenden Befehl ein:
    java -cp .\RTCz-JazzGateway-<Build-ID>.jar;.\log4j-1.2.12.jar;
    .\com.ibm.team.repository.common_0.6.1.I200810072228.jar;.\org.eclipse.osgi_3.3.2.R33x_v20080105.jar;.\commons-httpclient-3.0.jar com.ibm.teamz.jazz.gateway.JazzGateway 6666 
    Anmerkung: In diesem Beispiel ist 6666 die vom Gateway verwendete Portnummer.
  4. Stoppen Sie den Gateway mit STRG+C.

Beispiel-UNIX-Shell-Script

Das folgende Beispiel ist ein Shell-Script zum SToppen und Starten von Jazz Gateway. Sie können das Beispiel an Ihre Umgebung anpassen, indem Sie den Wert von JAVA_HOME und GTW_DIR ändern.
#! /bin/sh
#
# RTCzGateway-daemon:       Starts/stops the Jazz Gateway
#
#              
name="IBM Jazz Gateway"
export JAVA_HOME=<Java_sdk_directory>
export GTW_DIR=<Jazz_gateway_directory>

port=${2:-3456}
PID=GtwPid.$port
cmd="$JAVA_HOME/bin/java -classpath $GTW_DIR/RTCz-JazzGateway-I20090929-1150.jar:$GTW_DIR/log4j-1.2.12.jar:$GTW_DIR/com.ibm.team.repository.common_1.0.1.I200909060153.jar:$GTW_DIR/org.eclipse.osgi_3.4.3.R34x_v20081215-1030.jar:$GTW_DIR/commons-httpclient-3.0.jar com.ibm.teamz.jazz.gateway.JazzGateway $port"

Start() {

   if [ -f $PID ] 
   then
      echo "$name $port already started"
   else
      echo "Starting $name $port daemon... "
       $cmd >$PID.log 2>&1& 
      echo $! >$PID
   fi
}


Stop() {
   if [ -f $PID ] 
   then
           echo "Shutting down $name $port daemon: "
      kill -9 `cat $PID`
      rm $PID
   else
           echo "$name $port daemon not started "
   fi
}

Restart() {
   Stop
   Start
}

# See how we were called.
case "$1" in
  start)
   Start
   ;;
  stop)
   Stop
   ;;
  restart)
   Restart
   ;;
  *)
   echo $"Usage: $0 {start|stop|restart} <port_number>"
   exit 1
esac

exit $?
Dieses Script kann als Systeminitialisierungsscript verwendet werden. Die Verwaltung dieser Art von Shell-Scripts ist verschieden je nach UNIX- oder Linux-Plattform, auf der Jazz Gateway unterstützt wird. Die folgende Tabelle listet die Position jedes Systeminitialisierungsscripts für jedes System auf:
System Position
AIX /etc/rc.d
Red Hat /etc/rc.d/init.d
SUSE /etc/init.d
Solaris /etc/init.d

Jazz Gateway unter Windows installieren

Führen Sie die folgenden Schritte aus, um Jazz Gateway unter Windows zu installieren:
  1. Laden Sie die Datei RTCz-JazzRestGateway-2.0.0.2.zip von Jazz.net von der Seite "All Downloads" von Rational Team Concert for System z All heruner: https://jazz.net/downloads/rational-team-concert-z/releases/2.0.0.2.
  2. Dekomprimieren Sie die folgenden JAR-Dateien in Ihrem Jazz-Gateway-Installationsverzeichnis:
    • RTCz-JazzGateway-<Build-ID>.jar
    • log4j-1.2.12.jar
    • com.ibm.team.repository.common_1.0.1.I200909060153.jar
    • org.eclipse.osgi_3.4.3.R34x_v20081215-1030.jar
    • commons-httpclient-3.0.jar

Jazz Gateway unter Windows mit Java aufrufen

Führen Sie die folgenden Schritte aus, um Jazz Gateway unter Windows aufzurufen:
  1. Öffnen Sie ein Fenster mit Eingabeaufforderung.
  2. Wechseln Sie in das Verzeichnis, in dem die Dateien installiert sind.
  3. Geben Sie den folgenden Befehl ein:
    java -cp .\RTCz-JazzGateway-<Build-ID>.jar;.\log4j-1.2.12.jar;.\com.ibm.team.repository.common_0.6.1.I200810072228.jar;.\org.eclipse.osgi_3.3.2.R33x_v20080105.jar;.\commons-httpclient-3.0.jar com.ibm.teamz.jazz.gateway.JazzGateway 6666 
    Anmerkung: In diesem Beispiel ist 6666 die vom Gateway verwendete Portnummer.
Sie können den Gateway mit der Befehlsdatei startgw.cmd starten. Bevor Sie den Gateway starten, aktualisieren Sie die Variable JAVA_HOME im Script.

Beispiel für die Einrichtung eines Windows-Dienstes

Jazz Gateway ist eine Java-Anwendung, die daher keine direkte Unterstützung für die Ausführung als Windows-Dienst enthält. Es stehen jedoch verschiedene Dienst-Wrapper zur Verfügung. In diesem Beispiel wird Java Service Launcher verwendet. Dies ist ein eigenständiges Dienstprogramm, das zwar nicht Teil von Rational Team Concert for System z ist, aber online erhältlich ist. Sie können dieses Beispiel für den Dienst-Wrapper anpassen, den Sie verwenden.

Java Service Launcher konfigurieren

Führen Sie die folgenden Schritte aus, um Java Service Launcher (JSL) für Jazz Gateway zu konfigurieren:
  1. Öffnen Sie ein Fenster mit Eingabeaufforderung, und wechseln Sie in das Verzeichnis "bin", in dem die Datei jsl.ini enthalten ist.
  2. Bearbeiten Sie die Datei jsl.ini im Verzeichnis "bin" wie folgt:
    • Definieren Sie im Abschnitt [define] eine Variable zum Speichern der vom Gateway verwendeten Portnummer.
      • PORT= Gateway-Portnummer
    • Definieren Sie im Abschnitt [define] eine Variable zum Speichern des Pfads zum Installationsverzeichnis des Gateways.
      • GTW_DIR= Gateway-Verzeichnis
    • Ändern Sie appname, servicename, displayname und servicedescription in Namen und Beschreibungen Ihrer Wahl, z. B. IBM Jazz Gateway (%PORT%).
    • Setzen Sie die Einstellung jrepath auf den Wert %JAVA_HOME%.
      Anmerkung: Achten Sie darauf, dass Sie die Einstellung jrepath im Abschnitt [java] der .ini-Datei festlegen und nicht im Abschnitt [service], der einen ähnlichen Kommentar enthält.
    • Setzen Sie die Einstellung useconsolehandler auf den Wert true, um sicherzustellen, dass die Build-Engine nach der Abmeldung ausgeführt wird.
    • Setzen Sie die Einstellung systemout auf einen Wert wie %GTW_DIR%\gtw%PORT%.out.log.
    • Setzen Sie die Einstellung systemerr auf einen Wert wie %GTW_DIR%\lgtw%PORT%.err.log.
    • Fügen Sie im Abschnitt [java] die folgenden Parameter hinzu, die an Java übergeben werden sollen:
      • params = 4
      • param00 = -cp
      • param01 = %GTW_DIR%\RTCz-JazzGateway-I20090929-1150.jar;%GTW_DIR%\log4j-1.2.12.jar;%GTW_DIR%\com.ibm.team.repository.common_0.6.1.I200810072228.jar;%GTW_DIR%\org.eclipse.osgi_3.3.2.R33x_v20080105.jar;.\commons-httpclient-3.0.jar
      • param02 = com.ibm.teamz.jazz.gateway.JazzGateway
      • param03 = %PORT%
  3. Führen Sie in der Eingabeaufforderung den Befehl jsl -debug aus, um Ihre Konfiguration zu testen. Dadurch wird Jazz Gateway ausgeführt. Eine Nachricht wie die folgende sollte angezeigt werden.
    Debugging IBM Jazz Gateway (Gateway-Portnummer)
    Now starting JVM
    ControlHandler registered after JVM start
  4. Bevor Sie fortfahren, lösen Sie alle weiteren Fehler, die eventuell aufgetreten sind.
  5. Prüfen Sie die mit der Einstellung systemout angegebene Protokolldatei, um festzustellen, ob der Gateway an der mit der Variablen PORT angegebenen Portnummer empfangsbereit ist.
  6. Beenden Sie den Debug-Test mit STRG+C.

Windows-Dienst installieren und Jazz Gateway starten

Führen Sie die folgenden Schritte aus, um den Windows-Dienst JSL zu installieren und Jazz Gateway zu starten:
  1. Wechseln Sie in einem Fenster mit Eingabeaufforderung in das JSL-Verzeichnis "bin".
  2. Führen Sie jsl -install aus.
  3. Öffnen Sie die Anzeige mit den Windows-Diensten (Start > Ausführen > services.msc).
  4. Suchen Sie den Dienst mit dem Namen IBM Jazz Gateway (bzw. mit dem Namen, den Sie in der Datei .ini angegeben haben).
  5. Klicken Sie diesen Dienst mit der rechten Maustaste an, und wählen Sie Starten aus.
  6. Fordern sie Builds an, um zu überprüfen, ob Ihre Build-Engine Buildanforderunten erfolgreich verarbeitet.
  7. Nach der Erstkonfiguration wird der Service beim Systemboot automatisch gestartet, da in der .ini-Datei die Einstellung starttype=auto festgelegt ist.
Anmerkung: Wenn die Einstellungen in der .ini-Datei geändert werden müssen, stoppen Sie zunächst den Dienst und deinstallieren Sie ihn (anhand der Anweisungen weiter unten). Nehmen Sie anschließend die erforderlichen Änderungen in der .ini-Datei vor, und installieren sie den Dienst erneut.

Den Dienst Jazz Gateway stoppen

Führen Sie die folgenden Schritte aus, um den Dienst Jazz Gateway zu stoppen:
  1. Öffnen Sie die Anzeige mit den Windows-Diensten (Start > Ausführen > services.msc).
  2. Suchen Sie den Dienst mit dem Namen IBM Jazz Gateway (bzw. mit dem Namen, den Sie in der Datei .ini angegeben haben).
  3. Klicken Sie diesen Dienst mit der rechten Maustaste an, und wählen Sie Stoppen aus.

Windows-Dienst deinstallieren

Führen Sie die folgenden Schritte aus, um den Windows-Dienst JSL zu deinstallieren.
  1. Öffnen Sie die Anzeige mit den Windows-Diensten (Start > Ausführen > services.msc).
  2. Suchen Sie den Dienst mit dem Namen IBM Jazz Gateway (bzw. mit dem Namen, den Sie in der Datei .ini angegeben haben).
  3. Klicken Sie diesen Dienst mit der rechten Maustaste an, und wählen Sie Stoppen aus.
  4. Wechseln Sie in einem Fenster mit Eingabeaufforderung in das JSL-Verzeichnis "bin".
  5. Führen Sie jsl -remove aus.