Gebäude- und Wohnungsregister 2018 (gwr-2018)

Autoren der Dokumentation: Björn Scheppler

Dokumentation letztmals aktualisiert: 4.10.2019

Dieses Maven-Projekt simuliert das Gebäude- und Wohnungsregister der Schweiz, welches Operationen über SOAP bereitstellt.

Dieses Projekt wird in der eUmzugPrototyp-Lösung verwendet, welche eumzug.swiss nachbildet. Erarbeitet am Institut für Wirtschaftsinformatik an der ZHAW School of Management and Law im Rahmen des Bachelor-Studiengangs Wirtschaftsinformatik im Modul Geschäftsprozessintegration.

Die Simulation orientiert sich an der offiziellen Dokumentation des Bundesamtes für Statistik, abgelegt in src/docs/gwr_dokumentation.pdf.

Komponenten / Funktionalität

1. Spring Boot-Applikation mit Tomcat Server, usw.
2. Persistierungskomponenten:
   1. H2-Datenbank
   2. Gebäude- und Wohnungs-Entitäten inklusive separate Entität für den zusammengesetzten Primärschlüssel der Wohnungs-Entität
   3. Gebäude- und Wohnungs-JPA-Repositories
   4. data.sql mit initialen Testdaten, die beim Starten der Applikation in die Datenbank eingefügt werden. Diese wurden über die Exceldatei src\test\resources\initialData.xlsx erstellt
3. SOAP WebService-Komponenten (PS: mit Apache CXF gelöst statt nur spring-boot-starter-webservices, da letzteres mit der komplexen Struktur des XSD nicht umgehen kann)
   1. SOAP-Webservice-Komponenten (Java API for XML Web Services-Komponenten, CXF-Servlet-Komponenten)
   2. WebServiceConfiguration-Klasse
   3. JAXB-Konfiguration für Wohnungen (global.xjb)
   4. XML-Schema Definition als Basis für das WSDL und die durch ein Maven-Plugin generierten Klassen (gwr.xsd)
   5. Schnittstellen-Definition (Endpoint: GebaeudeUndWohnungsRegisterServiceEndpoint)
4. Geschäftslogik (controller):
   1. GwrBuildingController mit der Methode, um zu prüfen, ob an einer Adresse ein Gebäude existiert
   2. GwrDwellingController mit einer Methode, um Wohnungen an einer Adresse zurück zu erhalten
5. Test-Fälle als soapUI-Projekt (GebaeudeUndWohnungsRegisterServiceTests-soapui-project.xml)

Deployment

1. Erstmalig oder bei Problemen ein mvn clean install durchführen
2. Bei Änderungen am POM-File oder bei (Neu)kompilierungsbedarf genügt ein mvn install
3. Dabei werden auch mit einem Maven-Plugin die Java-Klassen aus der XSD generiert.

Nutzung

SOAP-Client allgemein

1. Für den Start ist ein Run (Netbeans), respektive java -jar .\target\NAME DES JAR-FILES.jar (Cmd) erforderlich. Dabei wird Tomcat gestartet, die Datenbank erstellt/hochgefahren mit den Eigenschaften (application.properties) und die verschiedenen Resourcen-URL-Mappings vorgenommen.
2. Beim Starten werden die Insert-Statements in src\main\ressources\data.sql ausgeführt.
3. Über http://localhost:8090/soap prüfen, ob die WSDL aufgerufen werden kann.
4. In einem SOAP-Client (z.B. soapUI) mit dieser WSDL Requests bauen und aufrufen oder alternativ das bereits in src\test\resources\GebaeudeUndWohnungsRegisterServiceTests-soapui-project.xml vorhandene soapUI-Projekt nutzen.
5. Das Beenden geschieht mit CTRL+C

SOAP-Client Umzugsplattform

Hierzu den Anweisungen folgen in https://github.com/zhaw-gpi/eumzug-plattform-2018

Fortgeschrittene Nutzung (Datenbank-Konsole)

1. Um auf die Datenbankverwaltungs-Umgebung zuzugreifen, http://localhost:8090/console eingeben.
2. Anmeldung über:
   1. Benutzername sa
   2. Passwort: leer lassen
   3. URL jdbc:h2:./DATENBANKNAME_GEMAESS_APPLICATION.PROPERTIES

Mitwirkende

1. Björn Scheppler: Hauptarbeit
2. Peter Heinrich: Der stille Support im Hintergrund mit vielen Tipps sowie zuständig für den Haupt-Stack mit SpringBoot & Co.
3. Studierende Michèle Aggeler, Laura Attinger, Daniel Fernandes Costa, Flora Ferat und Jasmin Schleeh: Zusammengesetzter Primärschlüssel für DwellingEntity