E-Recht

E-Recht: Signaturclient für MOA SS, V0.9

Systemhandbuch

Inhalt

1. Einführung

2. Überblick
3. Komponenten
   1. Das Servlet Dispatcher
   2. Die JSP-Seiten
   3. Die Klasse MOAInvoker
   4. Die Klasse RequestBuilder
   5. Der Deployment Descriptor web.xml
4. Zusammenspiel der Komponenten

1 Einführung

Das Modul E-Recht Signaturclient für MOA SS ist als plattformunabhängiges Modul ausgelegt, das als Webanwendung über HTTP angesprochen werden kann.

Dieses Handbuch beschreibt den Aufbau des Moduls. Abschnitt 2 bietet einen groben Überblick über seine Funktionsweise. Abschnitt 3 beschreibt die einzelnen Komponenenten, aus denen das Modul aufgebaut ist. Abschnitt 4 schließlich beschreibt das Zusammenspiel der einzelnen Komponenten.

Für die Installation und die Konfiguration des E-Recht Signaturclients für MOA SS siehe Betriebshandbuch.

2 Überblick

Aufgabe des E-Recht Signaturclients für MOA SS ist es zunächst, alle Informationen zu sammeln, die notwendig sind, um ein Rechtsdokument aus E-Recht mit Hilfe des Moduls MOA SS elektronisch zu signieren. Zu diesen Informationen, die vom Benutzer hochgeladen werden müssen, zählen:

• die XML-Präsentation des Rechtsokuments;
• der Stylesheet für die Umwandlung der XML-Repräsentation des Rechtsdokuments in seine HTML-Repräsentation durch MOA SS;
• etwaige Bilder und Grafiken, die in der XML- und damit auch HTML-Repräsentation referenziert werden.

Liegen all diese Informationen vor, steuert der Signaturclient das Modul MOA SS, um die Signatur über das Rechtsdokument herzustellen. Dazu erzeugt es basierend auf einem vorkonfigurierten Template und den vom Benutzer hochgeladenen Informationen einen Signaturerstellungsrequest für MOA SS. Dieser Signaturerstellungsrequest wird über die Webservice-Schnittstelle von MOA SS an diesen Dienst übermittelt.

Aus dem von MOA SS retour übermittleten Signaturerstellungsresponse extrahiert der Signaturclient die erstellte Signatur und stellt sie dem Benutzer zum Download bzw. zur lokalen Speicherung zur Verfügung.

Für den Betrieb des E-Recht Signaturclients ist daher die Verfügbarkeit einer Webservice-Installation von MOA SP in der Version 1.3 oder höher Voraussetzung.

3 Komponenten

3.1 Das Servlet Dispatcher

Das Servlet Dispatcher implementiert die zentrale Programmlogik der Webanwendung, die folgende Einzelaufgaben umfasst:

• Empfang der vom Benutzer hochgeladenen Informationen für die Erstellung des Signaturerstellungsrequests (XML-Rechtsdokument, Stylesheet, ggf. Bilddateien) sowie Speicherung der Informationen im Session-Objekt der zugehörigen Session.
• Einbindung der JSP-Seiten, welche die Bildschirm-Masken für die Interaktion mit dem Benutzer über dessen Webbrowser aufbauen.
• Verwendung von Funktionalität der Klasse RequestBuilder, um aus den hochgeladenen Informationen basierend auf einem vorkonfigurierten XML-Template den Signaturerstellungsrequest für MOA SS zu erzeugen.
• Verwendung von Funktionaliät der Klasse MOAInvoker, um den Signaturerstellungsrequest an MOA SS zu senden bzw. den Signaturerstellungsresponse von MOA SS zu empfangen und auszuwerten. 

3.2 Die JSP-Seiten

Die JSP-Seiten sind für den Aufbau der Bildschirm-Masken für den Webbrowser des Benutzers verantwortlich, über welche die Webanwendung mit dem Benutzer kommuniziert. Sie werden vom Servlet Dispatcher in den Programmfluss eingebunden. Folgende JSP-Seiten existieren:

• UploadXML.jsp: Diese Seite baut die Bildschirm-Maske zum Hochladen der XML-Repräsentation des zu signierenden Rechtsdokuments sowie des Stylesheets für die Erzeugung der HTML-Repräsentation des Rechtsdokuments auf. Die hochzuladenden Dateien werden an das Servlet Dispatcher übermittelt.
• UploadImages.jsp: Diese Seite baut die Bildschirm-Maske zum Hochladen von Bild-Dateien auf, die ggf. in der XML-Repräsentation des zu signierenden Rechtsdokuments referenziert werden. Falls keine Bild-Dateien referenziert werden, wird diese Bildschirm-Maske nicht aufgebaut. Die hochzuladenden Dateien werden an das Servlet Dispatcher übermittelt.
• DownloadSignature.jsp: Diese Seite baut die Bildschirm-Maske auf, von welcher der Benutzer die von MOA SS erzeugte Signatur herunterladen und lokal speichern kann.
• Error.jsp: Diese Seite baut die Bildschirm-Maske auf, die dem Benutzer im Falle eines aufgetretenen Fehlers präsentiert wird. Sie enthält dann eine Beschreibung des sowie Detailinformationen zum aufgetretenen Fehler.

3.3 Die Klasse MOAInvoker

Die Klasse MOAInvoker ist für die Kommunikation der Webanwendung mit dem MOA SS Webservice verantwortlich. Sie sendet den Signaturerstellungsrequest an MOA SS und empfängt die entsprechende Signaturerstellungsresponse. Die Response wird gegen das XML-Schema von MOA SS validiert. 

3.4 Die Klasse RequestBuilder

Die Klasse RequestBuilder  stellt dem Servlet Dispatcher die notwendige Funktionalität zur Verfügung, um aus den hochgeladenenen Informationen des Benutzers basierend auf einem vorkonfigurierten Template den XML-Signaturerstellungsrequest für das MOA SS Webservice zu erzeugen.

 Im Wesentlichen umfasst die Klasse folgende Funktionen:

• Integration der XML-Repräsentation des zu signierenden Rechtsdokuments in den Signaturerstellungsrequest;
• Integration des Stylesheets in den Signaturerstellungsrequest (wurde vom Benutzer ein Stylesheet hochgeladen, wird dieser integriert, ansonsten der vorkonfigurierte Default-Stylesheet);
• Integration der ggf. mitzusignierenden Bild-Dateien in den Signaturerstellungsrequest.

3.5 Der Deployment Descriptor web.xml

Im Deployment Descriptor web.xml des Web Archives (WAR-File) des E-Recht Signaturclients sind im Wesentlichen folgende Konfigurationen eingerichtet, die im Normalfall nicht verändert werden müssen:

• Definition der URLs, unter denen das Servlet Dispatcher in den unterschiedlichen Anwendungsfällen (Hochladen des XML-Rechtsdokuments, Hochladen von Bild-Dateien) relativ zum Root der Web Application erreichbar sind (XML-Elemente servlet bzw. servlet-mapping).
• Definition des Context Listeners für die Initialisierung der Webanwendung (XML Element listener).   

4 Zusammenspiel der Komponenten

Die nachfolgende Grafik eine Übersicht über die Komponenten aus Abschnitt 3 sowie deren Interaktion untereinander sowie mit Anwender und MOA SS dar.

1. Der Anwender beginnt mit dem Aufruf des Servlets Dispatcher unter der URL http://<Hostname>:<Port>//moa-ss-erecht-client/UploadXML.
2. Das Servlet Dispatcher bindet die JSP-Seite UploadXML.jsp ein, um dem Anwender die Maske für den Upload von XML-Rechtsdokument und Stylesheet anzuzeigen.
3. Der Anwender wählt jedenfalls das XML-Rechtsdokument und optional auch den Stylesheet für den Upload aus und startet den Upload, der wiederum an das Servlet Dispatcher gerichtet ist.
4. Das Servlet Dispatcher speichert das XML-Rechtsdokument und ggf. den Stylesheet im Session-Objekt der Anwender-Sitzung. Weiters prüft es das XML-Rechtsdokument, ob darin Bild-Dateien referenziert werden. Ist dies der Fall, bindet es die JSP-Seite UploadImages.jsp ein, um dem Anwender die Maske für den Upload der Bild-Dateien anzuzeigen. Ansonsten fährt das Servlet mit Schritt 7 fort.
5. Der Anwender wählt die hochzuladenden Bild-Dateien aus und startet den Upload, der wiederum an das Servlet Dispatcher gerichtet ist.
6. Das Servlet Dispatcher speichert die Bild-Dateien im Session-Objekt der Anwender-Sitzung.
7. Das Servlet Dispatcher nutzt die Funktionalität der Klasse RequestBuilder, um aus den hochgeladenen Informationen, die im Session-Objekt temporär gespeichert sind, den Signaturerstellungsrequest für MOA SS zu erstellen.
8. Das Servlet Dispatcher verwendet die Funktionalität der Klasse MOAInvoker, um den Signaturerstellungsrequest an MOA SS zu senden, bzw. um den entsprechenden Signaturerstellungsresponse von MOA SS zu empfangen.
9. Das Servlet Dispatcher extrahiert die erstellte Signatur aus dem Signaturerstellungsresponse und bindet die JSP-Seite DownloadSignature.jsp ein, um dem Anwender die Maske für den Download der erstellten Signatur anzuzeigen.