3 Installation
Werbung
Buchkatalog.de Webservice Installation Guide Autor: Benjamin Klatt Datum: 12.12.2005 Inhaltsverzeichnis 1 Allgemeines ................................................................................................................................. 3 1.1 Abnahme ............................................................................................................................. 3 1.2 Verteiler................................................................................................................................ 3 1.3 Änderungsnachweis / Versionsführung ..................................................................... 3 1.4 Abnahmekriterien.............................................................................................................. 3 2 Einführung / Überblick ............................................................................................................. 4 3 Installation ................................................................................................................................... 5 4 3.1 Vorbereitung ....................................................................................................................... 5 3.2 Java Development Kit ...................................................................................................... 5 3.3 Tomcat Servlet Container ............................................................................................... 6 3.4 Webservice ......................................................................................................................... 6 Anhang ......................................................................................................................................... 7 4.1 Glossar................................................................................................................................. 7 Poet AG 2005 Page 2/7 08.04.2017 1 Allgemeines 1.1 Abnahme Version Einheit (*) OK 1.2 Verteiler Version 1.3 Name Unterschrift Status (*) = abgenommen OK+ = abgenommen, aber noch Nacharbeiten erforderlich NOK = nicht abgenommen, Mängelliste siehe Abnahmeprotokoll Einheit Name Datum Papier / Verwendung Elektronis (z.K., z.Abn. ch Änderungsnachweis / Versionsführung Version Datum 1.0 12.12.2005 Klatt 1.4 Datum Ansprechpartner Änderung / Erweiterung gegen Vorversion Initiale Fassung Abnahmekriterien Lfd.Nr.(*) Abnahmekriterium K1 (*) Lesbarkeit und Verständlichkeit K2 (*) K... Widerspruchsfreiheit Im Einzelfall können hier noch weitere Kriterien ergänzt werden (*) = zwingend für ein abzunehmendes Konzept Poet AG 2005 Prüfvorgehen Alle nicht lesbaren bzw. unverständlichen Formulierungen sind zu monieren. Widersprechen sich Aussagen Page 3/7 08.04.2017 2 Einführung / Überblick Der Buchkatalog.de Webservice stellt eine Schnittstelle für Softwarehersteller dar, die in ihren eigenen Produkten auf die Funktionalitäten des Buchkatalogs zurückgreifen möchten. Hierbei werden SOAP/XML Anfragen per HTTP an den Webservice geschickt. Dort werden sie aufbereitet und in Form einer propäritären XML Nachricht über eine Netzwerkverbindung an den Buchkatalog TLD Server weitergeleitet. Dieser verarbeitet sie, erzeugt eine Antwort, die dann auf dem gleichen Weg zuerst an den Webservice und nach einer Aufbereitung von diesem an den Client zurück geschickt wird. Clients Client 1 .Net Webservice J2EE Tomcat Client 2 Java Buchkatalog TLD Server Client 3 ... TLD-XML / HTTP SOAP / HTTP Poet AG 2005 Page 4/7 08.04.2017 3 Installation Für den Betrieb des Webservices sind ein Java Development Kit, einen Tomcat Servlet Container und das Webservices Installationspaket notwendig. Im Folgenden werden die Installationen der einzelnen Komponenten beschrieben. Ein bereits installierter und ansprechbarer Buchkatalog TLD Server wird vorrausgesetzt. 3.1 Vorbereitung Stellen Sie sicher, dass Sie über die Notwendigen Rechte verfügen um Installationen auf dem Gewünschten System vorzunehmen. Stellen Sie sicher, dass Client Software das System auf dem gewünschten Port erreichen und dieser noch nicht von einem anderen Programm benutzt wird. (Beispielsweise Port 8080) Stellen Sie sicher, dass der Buchkatalog TLD Server über den entsprechenden Port von dem System aus erreichbar ist. 3.2 Java Development Kit Der Webservice benötigt eine Java Development Kit Version JDK 1.4.2. Diese kann für das jeweilige Betriebssystem unter http://java.sun.com/j2se/1.4.2/download.html heruntergeladen werden. Bitte beachten Sie, dass Sie ein Java Development Kit und nicht nur eine Java Runtime Environment (JRE) wählen. Installieren Sie diese einfach über das enthaltene Installationsprogramm. Setzen Sie die Umgebungsvariablen JAVA_HOME auf Ihr Java Installationsverzeichnis und fügen Sie den Pfad zu Ihrem bin Unterverzeichnis an die PATH Umgebungsvariable an. Unter Windows Unter Systemsteuerung > System > Verwaltung > Erweitert > Umgebungsvariablen können Sie die neue Variable JAVA_HOME mit dem von Ihnen gewählten Java Installationsverzeichnis als Wert anlegen. (Bspw: JAVA_HOME=C:\java) Hier können Sie auch Ihre PATH Variable erweitern. (Bspw. PATH=........;C:\java\bin) Unter Unix Setzen Sie die Umgebungsvariablen in der Shell, oder in den Startup Skripten mittels „setenv ParameterName ParameterWert“ Für weitere Details kontaktieren Sie bitte Ihren Systemadministrator. Poet AG 2005 Page 5/7 08.04.2017 3.3 Tomcat Servlet Container Benötigt wird ein Tomcat Servlet Container Version 4.1.31. Diesen können Sie unter http://tomcat.apache.org/download-41.cgi herunterladen. Der Servlet Container ist prinzipiell Plattform Unabhängig, für manche Betriebssysteme werden jedoch individuelle Installationsroutinen mitgeliefert. Unter Windows Installieren Sie den Tomcat Container mittels des Setup Programms. Sie sollten den Container als Service installieren, so dass er bei jedem Systemstart mitgestartet wird. Während der Installation können Sie auch den Installationspfad des Containers, sowie den zu verwendenden Port bestimmen. Unter Unix Entpacken Sie den Tomcat Container im gewünschten Verzeichnis und tragen Sie das Startskript TOMCAT_HOME/bin/startup.sh in die Startup Skripte Ihres Servers ein. 3.4 Webservice Bennen Sie das Webservice Installationspaket so, wie es später als URL in dem Servlet Container erreichbar sein soll. Soll es beispielsweise unter http://www.ihredomain.de:8080/webservice erreichbar sein, so nennen Sie das Paket in webservice.war um. Soll es direkt unter http://www.ihredomain.de:8080/ erreichbar sein, so muss das Paket in ROOT.war umbenannt werden. Gehen Sie in das Verzeichnis webapps/ innerhalb Ihrer Tomcat Installation. Sollte sich hier bereits eine Webapplikation mit dem gewünschten Namen befinden, so stoppen Sie den Tomcat, löschen Sie die alte Applikation (ggf. .war Datei und Unterverzeichnis mit diesem Namen). Legen Sie nun ihre .war Datei in den webapps/ Ordner und starten Sie den Tomcat Container neu. Das .war Paket sollte nun entpackt automatisch in dem Verzeichnis entpackt werden. Konfiguration Ggf. müssen Sie den Webservice noch für den anzusprechenden Buchkatalog TLD Server konfigurieren. Hierzu finden Sie in dem Anwendungsverzeichnis des Webservices, das im Vorhergehenden Schritt erstellt wurde in dem Verzeichnis WEB-INF/conf eine Datei Namens webservice.properties. In dieser Textdatei befinden sich die notwendigen Umgebungskonfigurationen für den Webservice. Die einzelnen Parameter sind in der Konfigurationsdatei direkt kommentiert. Wurden Änderungen in der Konfigurationsdatei vorgenommen ist der Tomcat Container neu zu starten, da die Konfiguration des Webservices nur einmalig bei dem Start der Anwendung geladen wird. Poet AG 2005 Page 6/7 08.04.2017 4 Anhang 4.1 Glossar Begriffe SOAP JDK Tomcat Poet AG 2005 Definition Simple Object Access Protocol - http://www.w3.org/TR/soap/ Java Development Kit (Java Laufzeit Umgebung und Tools zur Arbeit mit Java, wie z.B. ein Java Compiler) http://java.sun.com Java Servlet Container der Apache Software Foundation, der auch als Referenz in der Servlet Spezifikation von Sun genutzt wird. http://tomcat.apache.org Page 7/7 08.04.2017
