Administrationshandbuch

Klarschiff Backend

erstellt von

• Stefan Audersch

Änderungsübersicht

Inhaltsverzeichnis

1. Klarschiff Backend aufsetzen
2. Einstellungen
   1. Mailversand
   2. Datenbank
   3. Datenbanksynchronisation
   4. Automatische Jobs
   5. Geo
   6. Kartendarstellung mit OpenLayers
   7. Darstellung eines Vorgangs bzw. des Ortes in einem externen System
   8. Anbindung des WFS für den Zuständigkeitsfinder
   9. Proxy
   10. LDAP
   11. Loginseite
   12. Anzahl Unterstützer bei Ideen
   13. Fehlermeldungen
   14. Connector
   15. Version
3. Webanwendung in einem Cluster laufen lassen

Klarschiff Backend aufsetzen

Voraussetzung für das Backend ist eine PostgreSQL-Datenbank mit PostGIS, eine Java-Laufzeitumgebung und ein Servlet-Container. Das Aufsetzen sollte in den folgenden Schritten erfolgen:

1. PostgreSQL herunterladen und installieren
Für die Datenhaltung wird eine PostgreSQL-Datenbank benötigt. Für das Backend sollte ein PostgreSQL ab der Version 8.x verwendet werden. Diese kann hier

• http://www.postgresql.org/download/ bzw. hier
• http://www.enterprisedb.com/products-services-training/pgdownload

heruntergeladen werden.

Bei der Installation können alle Standardeinstellungen beibehalten bleiben. Beim Kodierung sollte UTF-8 als Standard eingestellt werden.

2. PostGIS installieren
Die Installation von PostGIS kann bei der PostgreSQL-Installation mit dem installierten Application Stack Builder erfolgen. Hierzu ist dieser mit Adminrechten zu starten. Unter dem Punkt Spatial Extension ist PostGIS zu finden, welches ab der Version 1.5 installiert werden sollte.

3. Benutzer und Datenbank anlegen
Mit Hilfe des pgAdmin III kann nun bei der Datenbank ggf. ein spezieller Benutzer und eine Datenbank angelegt werden. Im Standardfall sollte der Benutzer für das Backend den Rollennamen klarschiff_backend und das Passwort klarschiff_backend haben. Die neu erstellte Rolle sollte mit entsprechenden Rechten zum Erzeugen von Tabellen, Triggerfunktionen und Triggern sowie mit Rechten zum Schreiben, Lesen und Löschen von Daten in Tabellen ausgestattet sein.

Für das Backend kann nun mit pgAdmin III eine neue Datenbank angelegt werden. Die Datenbak sollte im Standardfall den Namen klarschiff_backend haben und als Template sollte template_postgis gewählt werden.

4. Datenbank für das Frontend und dblink einrichten (optional)
Soll vom Backend die FrontendDb initialisiert werden und während des Betriebes die Daten von der BackendDB an die FrontendDB publiziert werden, so sind die hier in diesem Abschnitt beschreibenen Schritte notwendig.

In der Datenbank für das Frontend sind eine neue Rolle (default: klarschiff_frontend) und eine DB (default: klarschiff_frontend) mit dem Template template_postgis in einem Schema (default: klarschiff) zu erstellen. Die Kommunikation der BackendDB mit der FrontendDB erfolgt über dblink. Damit dieses funktioniert ist in der BackendDB die entsprechende Extension einzurichten:

• PostgreSQL v8.x: Mit Hilfe von pgAdmin III muss das SQL-Script aus der Datei dblink.sql ausgeführt werden. Die Datei befindet sich an folgender Stelle PostgreSQL\8.4\share\contrib\dblink.sql.
• PostgreSQL v9.x: Mit Hilfe von pgAdmin III muss der SQL-Befehl CREATE EXTENSION dblink; ausgeführt werden.

Damit das Backend die entsprechenden Scripte ausführt sind in der settings.properties (siehe Punkt 7) die entsprechenden Einstellungen vorzunehmen.

5. Java herunterladen und installieren
Als Runtime ist Java in der Version ab 1.6 notwendig. Ein JDK oder JRE kann unter http://www.oracle.com/technetwork/java/javase/downloads/jdk-6u27-download-440405.html heruntergeladen werden. Dieses ist auf dem Rechner zu installieren.

6. Servlet-Container (Tomcat) herunterladen und installieren
Das in der Entwicklungsumgebung erzeugte Backend ist eine WAR-Datei, welche in einem Servlet-Container ausgeführt wird. Hierfür kann beispielsweise ein Tomcat verwendet werden. Ein Tomcat ab der Version 7.0 ist notwendig und kann unter http://tomcat.apache.org/download-70.cgi heruntergeladen werden.

Hinweis: Wenn ein Rechner mit Windows Vista oder Windows 7 verwendet wird, sollte die Installation des Tomcats nicht im normalen Programmordner erfolgen, da in diesem das Schreiben von Dateien notwendig ist, was teilweise durch das UAC verhindert bzw. erschwert wird.

Der Tomcat sollte bei der Installation als Dienst eingerichtet werden. Um ein OutOfMemory zu verhindern, sollte der Speicher für die VM beim Tomcat entsprechend hoch gesetzt werden.

Die Webanwendung kann ebenfalls in einem Cluster laufen. Hierzu sind dann spezielle Einstellungen notwendig ( siehe Webanwendung in einem Cluster laufen lassen ).

7. settings.properties ggf. anpassen
In der WAR-Datei der Webanwendung befindet sich im Verzeichnis WEB-INF\classes\ die Datei settings.properties mit den Einstellungen für das Backend. Hier sollten ggf. Anpassungen vorgenommen werden (siehe Einstellungen ).

8. Webanwendung deployen
Die WAR-Datei ist beim Tomcat in das Verzeichnis webapps zu kopieren und damit zu deployen.

9. Tomcat starten
Der Tomcat kann nun gestartet werden. Beim Start werden dabei die notwendigen Tabellen in der Datenbank angelegt.

Unter der URL http://localhost:8080/klarschiff.webapp/ sollte nun das Backend erreichbar sein.

Einstellungen

Die Konfigurationen und Einstellungen der Anwendung werden an verschiedenen Stellen vorgenommen. Zentraler Punkt für die Einstellungen ist die settings.properties. Hier können alle Parameter für den Lauf der Anwendung angepasst werden.

Systemspezifischere Anpassungen, die z.B. bei der Weiterentwicklung vorgenommen werden müssen, können im ApplicationContext (src_main\META-INF\spring\..xml), dem WebApplicationContext (WebContent\WEB-INF\spring\webmvc-config.xml) oder an anderen Stellen vorgenommen werden.

Bei den Einstellungen in der settings.properties können Profile verwendet werden. Diese ermöglichen es, verschiedene Einstellungen zu definieren, die gleiche Webanwendung auf verschiedenen Rechner zu deployen und die jeweils unterschiedlichen Konfigurationen zu verwenden. Welches Profil verwendet wird, kann über die Variable KLARSCHIFF_HRO_PROFILE an den folgenden Stellen festgelegt werden:

• Umgebungsvariable des Rechners
• Java-Laufzeit-Umgebungsvariable
• in der Datei settings.properties

Die Spezialisierung eines Parameters für ein bestimmtes Profil erfolgt durch ein Voranstellen des Profilnamens in der settings.properties. Werden die Einstellungen beispielsweise folgendermaßen definiert:

mail.from=klarschiffhro@googlemail.com
igd_dev.mail.from=klarschiffhro@igd-r.fraunhofer.de

so wird im Normalfall als Absenderadresse die E-Mail-Adresse von Google verwendet. Ist das Profil igd_dev eingestellt, so wird die E-Mail-Adresse von Fraunhofer verwendet.

Die folgenden Einstellungen können in der settings.properties vorgenommen werden:

Mailversand

Datenbank

Datenbanksynchronisation

Automatische Jobs

Geo

Kartendarstellung mit OpenLayers

Darstellung eines Vorgangs bzw. des Ortes in einem externen System

Anbindung des WFS für den Zuständigkeitsfinder

Proxy

LDAP

Es kann ein LDAP-Server verwendet werden oder auf der Basis einer LDIF-Datei lokal ein LDAP mitgestartet werden, der dann verwendet wird. Hierzu ist jeweils der eine Parameter ldap.server.ldif oder ldap.server.url zu setzen und der andere frei zu lassen.

Die folgenden Abbildungen stellen zur näheren Erläuterung dar, wie Benutzer und Gruppen im LDAP abzubilden sind und wie die Einstellungen in der settings.properties hierzu in Beziehung stehen.

Abbildung: Abbildung von Benutzern im LDAP

Benutzer benötigen eine uid und ein userPassword, welche für das Login verwendet werden. Der Name (cn) und die Mailadresse (mail) werden im Backend für die Anzeige von Verlaufsdaten und für den Mailversand verwendet.

Abbildung: Abbildung von Gruppen im LDAP

Bei den Gruppen wird zwischen intern, extern, dispatcher und admin unterschieden. Die Gruppen dispatcher und admin existieren im LDAP nur jeweils einmal. Die Gruppen für intern und extern existieren i.d.R. mehrfach. Die Namen der Gruppen (cn) und die Beschreibung (ou) werden bei der Anzeige der Zuständigkeit bzw. beim Delegieren verwendet.

Abbildung: Beziehungen zwischen Benutzern und Gruppen im LDAP

Die Verknüpfung der Gruppen mit Benutzern erfolgt über das Attribut member bei der Gruppe. Einer Gruppe können dabei mehrere Benutzer zugeordnet sein und auch ein Benutzer kann mehreren Gruppen angehören.

Loginseite

Anzahl Unterstützer bei Ideen

Fehlermeldungen

Connector

Version

Webanwendung in einem Cluster laufen lassen

Das Backend von Klarschiff ist für den Lauf in einem Cluster vorbereit. Hierzu wurden die folgenden Vorbereitungen getroffen:

• Die Sessionattribute implementieren das Interface java.io.Serializable, damit die Sessions zwischen den einzelnen Clients im Cluster synchronisiert werden können.
• Die Hintergrundjobs werden mit Hilfe der DB synchronisiert, damit beispielsweise Mails nicht mehrfach versendet werden.
• In der web.xml ist der Tag <distributable/> aktiviert.

Damit das Backend in einem Cluster laufen kann, müssen die folgenden Schritte vorgenommen werden:

• Laufen auf einem Rechner mehrere Clients, so sind beim tomcat entsprechend die Ports anzupassen, damit es nicht zu Konflikten kommt.
• In der server.xml des einzelnen Tomcat muss eine ID für den Client (jvmRoute="worker1") vergeben werden und der Lauf in einem Cluster muss aktiviert werden (<Cluster .../>).

	<Engine defaultHost="localhost" name="Catalina" jvmRoute="worker1">
		<Cluster className="org.apache.catalina.ha.tcp.SimpleTcpCluster"/>
	...
	</Engine>

• Ein Loadbalancer für die Verteilung der Anfragen auf die einzelnen Clients muss eingerichtet werden. Hierzu kann beispielsweise ein Apache oder Pound verwendet werden.

Loadbalancing mit einem Apache

Nähere Information zum Einrichten eines Tomcat in einem Cluster mit einem Apache ist beispielsweise unter http://www.easywayserver.com/implementation-tomcat-clustering.htm zu finden.

Loadbalancing mit Pound

Damit das Clustering mit Pound funktioniert, darf das Attribut jvmRoute in der server.xml der einzelnen Tomcats nicht gesetzt sein. Naher Informationen zum Verwenden und Einrichten von Pound als Loadbalencer sind unter http://www.apsis.ch/pound/ zu finden.