diff options
Diffstat (limited to 'erecht.client.ss/handbook/system/system.html')
| -rw-r--r-- | erecht.client.ss/handbook/system/system.html | 170 |
1 files changed, 0 insertions, 170 deletions
diff --git a/erecht.client.ss/handbook/system/system.html b/erecht.client.ss/handbook/system/system.html deleted file mode 100644 index 53682500e..000000000 --- a/erecht.client.ss/handbook/system/system.html +++ /dev/null @@ -1,170 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head> - - <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> - - - - <title>MOA SL - Systemhandbuch</title><link rel="stylesheet" href="../common/handbook.css" type="text/css"></head> - -<body style="color: rgb(0, 0, 0); background-color: white;" alink="#cc9966" link="#990000" vlink="#666666"><table class="logoTable" border="0" cellpadding="10" cellspacing="0" width="100%"> <tbody> <tr><td class="logoTitle" align="center" width="267"><img style="width: 267px; height: 37px; float: left;" alt="Logo BKA" src="../common/LogoBKA.png"></td> <td class="logoTitle" align="center">E-Recht</td> </tr> -</tbody> </table><hr><p class="title"><a href="../index.html">E-Recht: -Signaturclient für MOA SS, V0.9</a></p><p class="subtitle">Systemhandbuch</p> - -<hr> -<h1>Inhalt</h1> - -<ol> - - <li> - <p><a href="#einf%FChrung">Einführung</a></p> - - </li> - - <li><a href="#%FCberblick">Überblick</a></li> - - <li> <a href="#komponenten">Komponenten</a> - <ol> - - <li><a href="#komponenten.dispatcher">Das Servlet <code>Dispatcher</code></a> - </li> - - - - <li><a href="#komponenten.jspseiten">Die -JSP-Seiten</a></li><li><a href="#komponenten.moainvoker">Die Klasse <code>MOAInvoker</code></a></li><li><a href="#komponenten.requestbuilder">Die Klasse <code>RequestBuilder</code></a></li><li><a href="#komponenten.webxml">Der -Deployment Descriptor <code>web.xml</code></a></li> - - </ol> - - </li> - - <li><a href="#zusammenspiel">Zusammenspiel der -Komponenten</a> - <ol></ol> - - </li> - -</ol> - -<hr> -<h1><a name="einführung" id="einführung"></a>1 -Einführung </h1> - -<p>Das Modul <em>E-Recht Signaturclient für MOA SS</em> ist als -plattformunabhängiges Modul ausgelegt, das als Webanwendung -über HTTP angesprochen werden kann. </p> - -<p>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.</p> - -<p>Für die Installation und die Konfiguration des <em>E-Recht Signaturclients für MOA SS</em> -siehe <a href="../operation/operation.html">Betriebshandbuch</a>. -</p> - -<h1><a name="überblick" id="überblick"></a>2 -Überblick</h1><p>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:</p><ul><li> die XML-Präsentation des Rechtsokuments;</li><li>der -Stylesheet für die Umwandlung der XML-Repräsentation des Rechtsdokuments in seine -HTML-Repräsentation durch MOA SS;</li><li>etwaige Bilder und Grafiken, die in der XML- und damit auch -HTML-Repräsentation -referenziert werden.</li></ul><p>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.</p><p>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.</p><p>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.</p><h1><a name="komponenten" id="komponenten"></a>3 -Komponenten</h1> - -<h2><a name="komponenten.dispatcher" id="komponenten"></a>3.1 -Das Servlet <code>Dispatcher</code></h2> - -<p>Das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> implementiert die zentrale Programmlogik der Webanwendung, die folgende Einzelaufgaben umfasst:</p><ul><li>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.</li><li>Einbindung der JSP-Seiten, welche die Bildschirm-Masken für die Interaktion mit dem Benutzer über dessen Webbrowser aufbauen.</li><li>Verwendung von Funktionalität der Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.RequestBuilder">RequestBuilder</abbr></code>, -um aus den hochgeladenen Informationen basierend auf einem -vorkonfigurierten XML-Template den Signaturerstellungsrequest für MOA -SS zu erzeugen.</li><li>Verwendung von Funktionaliät der Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.MOAInvoker">MOAInvoker</abbr></code>, -um den Signaturerstellungsrequest an MOA SS zu senden bzw. den -Signaturerstellungsresponse von MOA SS zu empfangen und -auszuwerten. </li></ul><h2><a name="komponenten.jspseiten" id="komponenten"></a>3.2 -Die JSP-Seiten</h2><p>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 <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> in den Programmfluss eingebunden. Folgende JSP-Seiten existieren:</p><ul><li><code>UploadXML.jsp</code>: -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 <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher </abbr></code>übermittelt.</li><li><code>UploadImages.jsp</code>: -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 <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher </abbr></code>übermittelt.</li><li><code>DownloadSignature.jsp</code>: -Diese Seite baut die Bildschirm-Maske auf, von welcher der Benutzer die -von MOA SS erzeugte Signatur herunterladen und lokal speichern kann.</li><li><code>Error.jsp</code>: -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.</li></ul><h2><a name="komponenten.moainvoker" id="komponenten"></a>3.3 Die Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.MOAInvoker">MOAInvoker</abbr></code></h2><p>Die Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.MOAInvoker">MOAInvoker </abbr></code>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. </p><h2><a name="komponenten.requestbuilder" id="komponenten"></a>3.4 Die Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.RequestBuilder">RequestBuilder</abbr></code><code></code></h2> - -<p>Die Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.RequestBuilder">RequestBuilder</abbr></code><code><abbr title="at.gv.egovernment.moa.spss.slinterface.servlets.HashInputServlet"></abbr></code> stellt dem Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> 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.</p><p> Im Wesentlichen umfasst die Klasse folgende Funktionen:</p><ul><li>Integration der XML-Repräsentation des zu signierenden Rechtsdokuments in den Signaturerstellungsrequest;</li><li>Integration -des Stylesheets in den Signaturerstellungsrequest (wurde vom Benutzer -ein Stylesheet hochgeladen, wird dieser integriert, ansonsten der -vorkonfigurierte Default-Stylesheet);</li><li>Integration der ggf. mitzusignierenden Bild-Dateien in den Signaturerstellungsrequest.</li></ul><h2><a name="komponenten.returnservlet" id="komponenten"></a></h2><h2><a name="komponenten.webxml" id="komponenten"></a>3.5 -Der Deployment Descriptor <code>web.xml</code></h2> -<p> -Im Deployment Descriptor <code><abbr title="WEB-INF/web.xml">web.xml</abbr></code> des -Web Archives (WAR-File) des E-Recht Signaturclients sind im Wesentlichen folgende -Konfigurationen eingerichtet, die im Normalfall nicht verändert -werden müssen:</p> -<ul> - <li>Definition der URLs, unter denen das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> in -den unterschiedlichen Anwendungsfällen (Hochladen des -XML-Rechtsdokuments, Hochladen von Bild-Dateien) relativ zum Root der -Web Application erreichbar sind (XML-Elemente <code>servlet</code> bzw. <code>servlet-mapping</code>).</li> - <li>Definition des <em>Context Listeners</em> für die Initialisierung der Webanwendung (XML Element <code>listener</code><code></code>). </li> -</ul> - -<h1><a name="zusammenspiel" id="zusammenspiel"></a>4 -Zusammenspiel der Komponenten</h1> - - -<p>Die nachfolgende Grafik eine Übersicht über die Komponenten aus -Abschnitt 3 sowie deren Interaktion untereinander sowie mit Anwender -und MOA SS dar.</p> -<p style="text-align: center;"><img style="width: 880px; height: 422px;" alt="Zusammenspiel der Komponenten - Basisablauf" src="images/Zusammenspiel.png" vspace="25"></p>Das Zusammenspiel der Komponenten für einen typischen Ablauf des E-Recht Signaturclients sieht wie folgt aus:<br><ol><li>Der Anwender beginnt mit dem Aufruf des Servlets <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> unter der URL <code>http://<Hostname>:<Port>//moa-ss-erecht-client/UploadXML</code>.</li><li>Das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> bindet die JSP-Seite <code>UploadXML.jsp</code> ein, um dem Anwender die Maske für den Upload von XML-Rechtsdokument und Stylesheet anzuzeigen.</li><li>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 <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> gerichtet ist.</li><li>Das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> -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 <code>UploadImages.jsp</code> ein, um dem Anwender die Maske für den Upload der Bild-Dateien anzuzeigen. Ansonsten fährt das Servlet mit Schritt 7 fort.</li><li>Der Anwender wählt die hochzuladenden Bild-Dateien aus und startet den Upload, der wiederum an das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> gerichtet ist.</li><li>Das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> speichert die Bild-Dateien im Session-Objekt der Anwender-Sitzung.</li><li>Das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> nutzt die Funktionalität der Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.RequestBuilder">RequestBuilder</abbr></code>, -um aus den hochgeladenen Informationen, die im Session-Objekt temporär -gespeichert sind, den Signaturerstellungsrequest für MOA SS zu -erstellen.</li><li>Das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> verwendet die Funktionalität der Klasse <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.moainvoker.MOAInvoker">MOAInvoker</abbr></code>, -um den Signaturerstellungsrequest an MOA SS zu senden, bzw. um den -entsprechenden Signaturerstellungsresponse von MOA SS zu empfangen.</li><li>Das Servlet <code><abbr title="at.gv.egovernment.moa.ss.erechtclient.servlets.Dispatcher">Dispatcher</abbr></code> extrahiert die erstellte Signatur aus dem Signaturerstellungsresponse und bindet die JSP-Seite <code>DownloadSignature.jsp</code> ein, um dem Anwender die Maske für den Download der erstellten Signatur anzuzeigen.</li></ol></body></html>
\ No newline at end of file |