AWS - Installations howto

Dieses Dokument beschreibt, wie der Annotation Web Service (AWS) installiert wird. Der Annotation Web Service (AWS) wurde mit Hilfe des Apache Axis SOAP Frameworks entwickelt, d.h. für die Installation wird Apache Axis benötigt. Apache Axis benötigt wiederum einen Servlet Container. AWS wurde erfolgreich mit Apache Tomcat 4.1.24 getestet. Für das Speichern der Daten wird die XML-Datenbank Apache Xindice verwendet, die ebenfalls installiert werden muss. Apache Xindice kann ebenfalls als Servlet in Tomcat installiert werden. Alle Komponenten benötigen Java 2. AWS wurde mit Java SDK Version 1.4.1 entwickelt und getestet. Frühere Versionen wurden nicht getestet.

Um das Web Service zu installieren, müssen folgende Schritte durchgeführt werden. Um AWS kompilieren zu können, muss für jedes Softwarepaket, das installiert wird, der Java CLASSPATH entsprechend erweitert werden. Die Einzelheiten stehen dabei in den jeweiligen Installationsanweisungen der einzelnen Komponenten.

Das Annotation Web Service benötigt Java 2 Runtime Environment Version 1.4. Erfolgreich getestet wurde es mit der Version 1.4.1. Die neueste Version der Java 2 Plattform kann man von http://java.sun.com/ bekommen. Man muss darauf achten, dass die Umgebungsvariable JAVA_HOME auf das Java Verzeichnis zeigt.

Apache Tomcat kann von http://jakarta.apache.org/tomcat/ heruntergeladen werden. Dort stehen auch die nötigen Anweisung, um Tomcat zu installieren und zu starten. Die Umgebungsvariable CATALINA_HOME sollte auf das Tomcat Verzeichnis zeigen. Zum Starten und Beenden von Tomcat können folgende Befehle ausgeführt werden:

zum Starten:

• $CATALINA_HOME/bin/startup.sh (Unix)
• %CATALINA_HOME%\bin\startup (Windows)

zum Beenden:

• $CATALINA_HOME/bin/shutdown.sh (Unix)
• %CATALINA_HOME%\bin\shutdown (Windows)

Nach dem Start sollte unter http://localhost:8080/ die Standard Tomcat Web Seite erscheinen.

Nach erfolgreicher Installation von Tomcat muss Apache Axis installiert werden. Der Annotation Web Service wurde mit Apache Axis Version 1.1RC2 entwickelt. Apache Axis kann von http://ws.apache.org/axis/ heruntergeladen werden. Eine genaue Installationsanweisung ist ebenfalls auf dieser Seite zu finden. Es darf nicht vergessen werden den CLASSPATH entsprechend den Anweisungen zu setzen. Nach erfolgreicher Installation sollte in einem Browser die Apache Axis Startseite unter http://localhost:8080/axis/index.html zu sehen sein.

Apache Xindice und die Installationsanweisungen findet man unter http://xml.apache.org/xindice/ Xindice wird als Servlet in Tomcat installiert. Der Annotation Web Service wurde mit Xindice Version 1.1b entwickelt und getestet. Da es mit den Source und Binary Releases Probleme gab, wurde der Sourcecode aus dem CVS verwendet. Dies ist auch die hier empfohlene Methode. Anweisungen wie auf das CVS Repository zugegriffen werden kann findet man unter http://xml.apache.org/cvs.html. Kurz zusammengefasst müssen folgende Anweisungen ausgeführt werden:

• cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login
• password: anoncvs
• cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout xml-xindice

Anschließend muss der Sourcecode compiliert werden indem ./build.sh ausgeführt wird. Nach erfolgreichem compilieren befinden sich im dist/ Verzeichnis verschiedene Dateien, darunter xindice-1.1b.war. Diese Datei muss in das webapps Verzeichnis des Servlet Containers kopiert werden (bei Tomcat ist dies $CATALINA_HOME/webapps).

Wichtig: Zusätzlich muss die Tomcat Konfigurationsdatei server.xml noch editiert werden. Dazu müssen die Zeilen aus $XINDICE_HOME/dist/xindice-1.1b.xml (entsprechen der verwendeten Version) in die Tomcat Konfigurationsdatei $CATALINA_HOME/conf/server.xml direkt nach der Zeile mit '<!- Tomcat Root Context ->' eingetragen werden. Dies sollte wie folgt aussehen:

...
<!- Tomcat Root Context ->
<!- <Context path="" docBase="ROOT" debug="0"/> ->
<Context path="/Xindice" docBase="xindice-1.1b2" debug="0" reloadable="true">
<Logger className="org.apache.catalina.logger.FileLogger" debug="0" verbosity="1" prefix="xindice_log." directory="logs" timestamp="true" suffix=".txt"/>
</Context>
...

Nach dem Neustart von Tomcat sollte die Datenbank funktionieren. Zum Testen kann man dazu die folgende Adresse in einem Browser aufrufen: http://localhost:8080/xindice-1.1b. Wenn es funktioniert sollte eine Seite mit folgender Meldung zu sehen sein: "THIS IS AN UGLY DEBUG TOOL!".

Das Anlegen einer Datenbank für den Annotation Web Service wird später erklärt.

Der Annotation Web Service benötigt ebenfalls noch das Castor Framework. Castor ist ein Open-Source 'data binding Framework' für Java, d.h. es bietet die Möglichkeit, Java Objekte in XML Repräsentationen umzuwandeln und umgekehrt. Castor kann von http://castor.exolab.org/ heruntergeladen werden. Es muss lediglich das Castor Jar-Archiv in den Java CLASSPATH eingebunden werden.

Zunächst das Archiv aws-server.tar.gz in ein beliebiges Verzeichnis entpacken. Anschließend in das ./aws Unterverzeichnis wechseln und den Quellcode gegebenenfalls mit javac *.java kompilieren. In dem Verzeichnis $CATALINA_HOME/webapps/axis/WEB-INF/classes/ ein Verzeichnis mit dem Namen aws erstellen und alle Klassendateien in dieses Verzeichnis kopieren:

• cp *.class $CATALINA_HOME/webapps/axis/WEB-INF/classes/aws/

Nun muss der Web Service noch registriert werden. Dazu muss Tomcat gestartet werden. Im aws Verzeichnis befindet sich eine Datei deploy.wsdd Datei. Mit folgendem Befehl wird der Web Service in den Applikationsserver eingebunden:

• java org.apache.axis.client.AdminClient deploy.wsdd

Auf http://localhost:8080/axis/servlet/AxisServlet müsste jetzt der Annotation Web Service mit seinen zugehörenden Methoden aufgelistet sein (ggf. Tomcat neu starten, damit die Änderungen wirksam werden).

Das Friki ist ein Wiki das einfach zu installieren ist, wenn man eine Servlet Engine wie Tomcat bereits installiert hat. Friki selbst, sowie die Installations- und Konfigurationsanweisungen sind von folgender Adresse zu bekommen: http://www.efsol.com/download/friki-install.html. Für die Installation muss lediglich friki.war in das webapps Verzeichnis des Servlet Containers kopiert werden. Nach einem eventuellen Neustart des Servlet Containers sollte auf Friki über einen Browser zugegriffen werden können. Läuft der Server z.B. auf Port 8080 auf dem lokalen Rechner, so lautet die URL http://localhost:8080/friki.

Wichtig: Vor der ersten Benutzung des Web Services muss eine Datenbank angelegt werden. Dazu müssen folgende 'Collections' in der Datenbank angelegt werden, die mit folgenden Befehlen erzeugt werden können (siehe Xindice administrator guide):

• xindice ac -c /db -n aws
• xindice ac -c /db/aws -n annotations
• xindice ac -c /db/aws -n users
• xindice ac -c /db/aws -n groups

Anschließend sollte der Annotation Web Service funktionieren!

XMLdbGUI ist ein Java Programm, welches das Betrachten und Verändern von Einträgen einer XML:DB konformen XML-Datenbank erlaubt. Es ist unter http://titanium.dstc.edu.au/xml/xmldbgui/ frei herunterladbar. Mit dem Programm lassen sich die Benutzer- und Gruppendaten komfortabel anschauen und löschen. Ebenfalls können unerwünschte Annotationen gelöscht werden.

Mit Hilfe von tcpmon, das im Axis Framework enthalten ist, können die SOAP Nachrichten, die zwischen einem Client und dem Server ausgetauscht werden betrachtet werden. Das Tool kann mit folgendem Befehl gestartet werden:

• java org.apache.axis.utils.tcpmon

Unter 'Listen Port #' wird die Portnummer angegeben auf der tcpmon auf eingehende SOAP Nachrichten wartet, hier z.B. 8081 eingeben. 'Act as a... listener' auswählen und unter 'Target Hostname' und 'Target Port' die IP und den Port des Rechners eingeben auf dem der Annotation Web Service läuft, z.B. 'localhost' und Port 8080. Im verwendeten Client muss nun die IP und der Port entsprechend angepasst werden, z.B. http://localhost:8081/axis/services/Aws.