diff options
Diffstat (limited to 'erecht.client.ss/handbook')
| -rw-r--r-- | erecht.client.ss/handbook/common/LogoBKA.png | bin | 8062 -> 0 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/common/handbook.css | 300 | ||||
| -rw-r--r-- | erecht.client.ss/handbook/constraints.txt | 8 | ||||
| -rw-r--r-- | erecht.client.ss/handbook/index.html | 34 | ||||
| -rw-r--r-- | erecht.client.ss/handbook/operation/operation.html | 464 | ||||
| -rw-r--r-- | erecht.client.ss/handbook/system/images/Zusammenspiel.VSD | bin | 113152 -> 0 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png | bin | 48649 -> 0 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png | bin | 36106 -> 0 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/system/images/Zusammenspiel.png | bin | 51511 -> 0 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/system/system.html | 170 |
10 files changed, 0 insertions, 976 deletions
diff --git a/erecht.client.ss/handbook/common/LogoBKA.png b/erecht.client.ss/handbook/common/LogoBKA.png Binary files differdeleted file mode 100644 index 6a92647fd..000000000 --- a/erecht.client.ss/handbook/common/LogoBKA.png +++ /dev/null diff --git a/erecht.client.ss/handbook/common/handbook.css b/erecht.client.ss/handbook/common/handbook.css deleted file mode 100644 index b8428d58d..000000000 --- a/erecht.client.ss/handbook/common/handbook.css +++ /dev/null @@ -1,300 +0,0 @@ -body -{ - font-family: "Times New Roman", Times, serif; - font-size: medium; - font-weight: normal; - margin-left: 2.5em; - margin-right: 2.5em; -} - -p -{ - margin-top: 0pt; - margin-bottom: 0.5em; - text-align: justify -} - -pre -{ - font-family: "Courier New", monospace; - font-size: 90%; - background-color: #cccccc; - color: #000000; - margin-left:1.5%; - margin-right:1.5%; - margin-top: 1em; - margin-bottom: 1em; - border: #008000 none; -} - -hr -{ - color: #000080; - background-color: #000080; - margin-top: 0.5em; - margin-bottom: 0.5em; -} - -table.fixedWidth -{ - width: 97%; - margin-left:1.5%; - margin-right:1.5%; - margin-top: 1em; - margin-bottom: 1em; -} - - -table.varWidth -{ - margin-left:1.5%; - margin-top: 1em; - margin-bottom: 1em; -} - -th -{ - text-align: left; -} - -h1 -{ - color: #000080; - text-align: left; - font-size: 167%; - font-family: Arial, Helvetica, sans-serif; - font-weight: normal -} - -h2 -{ - color: #000080; - font-size: 150%; - font-family: Arial, Helvetica, sans-serif; - font-weight: normal -} - -h3 -{ - color: #000080; - font-size: 133%; - font-family: Arial, Helvetica, sans-serif; - font-weight: normal -} - -h4 -{ - color: #000080; - font-size: 116%; - font-family: Arial, Helvetica, sans-serif; - font-weight: normal -} - -h5 -{ - color: #000080; - font-size: 100%; - font-family: Arial, Helvetica, sans-serif; - font-weight: normal -} - -h6 -{ - color: #000080; - font-size: 83%; - font-family: Arial, Helvetica, sans-serif; - font-weight: normal -} - -code -{ - font-family: "Courier New", Courier, monospace; - font-size: 90%; - color: #000000 -} - -dd -{ - margin-top: 0.8em; - margin-bottom: 0.8em; - text-align: justify - -} - -dt -{ - margin-top: 0.8em; - font-family: Arial, Helvetica, sans-serif; - color: #000080 -} - -ol -{ - margin-top: 0.5em; - margin-bottom: 0.5em -} - -ol.alpha -{ - list-style-type: lower-alpha -} - -li -{ - margin-top: 0.25em; - margin-bottom: 0.25em; - text-align: justify -} - -a:hover -{ - color: #990000 -} - - -.title -{ - text-align: left; - font-size: 167%; - color: #000080; - font-family: Arial, Helvetica, sans-serif; - margin-top: 0.4em; - margin-bottom: 0.4em -} - -.subtitle -{ - text-align: left; - font-size: 133%; - color: #000080; - font-family: Arial, Helvetica, sans-serif; - margin-top: 0.4em; - margin-bottom: 0.4em -} - -.glossaryTerm -{ - font-style: italic; - color: #006699 -} - -.example -{ - font-family: "Courier New", monospace; - background-color: #CCFFFF; - color: #000000; - margin: 0pt 0pt; - border: #008000 none -} - -.schema -{ - font-family: "Courier New", monospace; - background-color: #FFFFCC; - color: #000000; - margin: 0pt 0pt; - border: #008000 none -} - -.documentinfo -{ - font-family: Arial, Helvetica, sans-serif; - font-size: 100%; -} - -.ol-contents -{ - font-size: 100%; - margin-top: 0.0em; - margin-bottom: 0.0em; -} - -.li-contents -{ - font-size: 100%; - margin-top: 0.0em; - margin-bottom: 0.0em; -} - -.logoTitle -{ - text-align: center; - font-size: 133%; - color: #000080; - font-family: Arial, Helvetica, sans-serif; -} - -.logoTable -{ - margin-bottom: 0px; - margin-left: 0px -} - -.superscript -{ - vertical-align: super; - font-size: 66%; -} - -.term -{ - font-style: italic; -} - -.comment -{ - color: #000000; - background: #ffff00; - font-style: italic -} - -.addedErrata12 -{ - color: #FF0000; - background-color: #FFEEEE; - text-decoration: underline -} - -.deletedErrata12 -{ - color: #999999; - background-color: #EEEEEE; - text-decoration: line-through -} - -.added12 -{ - color: #FF0000; - text-decoration: underline -; background-color: #F8F0FF -} - -.deleted12 -{ - color: #999999; - text-decoration: line-through -; background-color: #f8f0ff -} - -.rfc2119Keyword -{ - font-variant: small-caps; - font-style: normal; -} - -.remark { font-style: italic} - -li.faq -{ - margin-top: 1.5em; - margin-bottom: 1.5em; -} - -.faq-question -{ - color: #000080; - font-size: 100%; - font-family: Arial, Helvetica, sans-serif; - font-weight: normal; - margin-bottom: 0.4em; -} diff --git a/erecht.client.ss/handbook/constraints.txt b/erecht.client.ss/handbook/constraints.txt deleted file mode 100644 index d6ace776e..000000000 --- a/erecht.client.ss/handbook/constraints.txt +++ /dev/null @@ -1,8 +0,0 @@ -- Der E-Recht Signaturclient für MOA SS unterstützt derzeit die Anbindung - von MOA SS nur über die ungesicherte HTTP Webservice-Schnittstelle. - -- Der E-Recht Signaturclient bietet derzeit keine eigenständige - Benutzerauthentisierung. - -- Die Behandlung von fehlerhaften Benutzereingaben ist nur sehr rudimentär - ausgeführt.
\ No newline at end of file diff --git a/erecht.client.ss/handbook/index.html b/erecht.client.ss/handbook/index.html deleted file mode 100644 index 3975e8372..000000000 --- a/erecht.client.ss/handbook/index.html +++ /dev/null @@ -1,34 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head> - - <title>MOA SL - Übersicht</title><meta content="Evrsoft First Page" name="GENERATOR"> - <meta http-equiv="content-type" content="text/html; charset=us-ascii"> - <link href="./common/handbook.css" type="text/css" rel="stylesheet"></head> -<body alink="#cc9966" bgcolor="white" link="#990000" text="#000000" vlink="#666666"> - <table class="logoTable" border="0" cellpadding="10" cellspacing="0" width="100%"> - <tbody> - <tr> - <td class="logoTitle" align="center" width="267"><img alt="Logo BKA" src="common/LogoBKA.png" align="left" height="37" width="267"></td> - - <td class="logoTitle" align="center">E-Recht</td> - - - </tr> - </tbody> - </table> - <hr> - - <p class="title">E-Recht: Signaturclient für MOA SS </p> - - <p class="subtitle">Übersicht zur Dokumentation der Version 0.9</p> - <hr> - - <dl> - <dt><a href="./operation/operation.html">Betriebshandbuch </a></dt> - - <dd>Anleitung für die Installation sowie Erläuterung aller Konfigurationsoptionen.</dd> - - <dt><a href="./system/system.html">Systemhandbuch</a></dt> - - <dd>Beschreibung der einzelnen Komponenten des Signaturclients und ihrem Zusammenspiel.</dd></dl> -</body></html>
\ No newline at end of file diff --git a/erecht.client.ss/handbook/operation/operation.html b/erecht.client.ss/handbook/operation/operation.html deleted file mode 100644 index 5c70ec453..000000000 --- a/erecht.client.ss/handbook/operation/operation.html +++ /dev/null @@ -1,464 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head> -<meta content="text/html; charset=iso-8859-1" http-equiv="content-type"><title>MOA SL - Betriebshandbuch</title> <link type="text/css" href="../common/handbook.css" rel="stylesheet"></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">Betriebshandbuch</p> -<hr><h1>Inhalt</h1> -<ol> <li> <p><a href="#%FCbersicht">Übersicht</a></p> -</li> <li><a href="#installation">Installation</a> -<ol> <li><a href="#installation_einf%FChrung">Einführung</a></li> -<li><a href="#installation_vorbereitung">Vorbereitung</a></li> -<li><a href="#installation_tomcatconfig">Konfiguration -von Apache Tomcat</a> <ol> <li><a href="#installation_tomcatconfig_httpconn">Konfiguration -des HTTP Connectors</a></li> </ol> </li> <li><a href="#installation_deploy">Einsatz des E-Recht -Signaturclients für MOA SS in Tomcat</a></li> <li><a href="#installation_tomcatstartstop">Starten -und Stoppen von Tomcat</a> <ol> <li><a href="#installation_tomcatstartstop_windows">Unter -Windows</a></li> <li><a href="#installation_tomcatstartstop_unix">Unter -Unix</a></li> <li><a href="#installation_tomcatstartstop_logging">Logging</a> -<ol> <li><a href="#webservice_basisinstallation_logging_format">Format -der Log-Meldungen</a> </li> </ol> </li> <li><a href="#installation_tomcatstartstop_verify">Prüfen -des erfolgreichen Starts</a></li> </ol> </li> -</ol> </li> <li><a href="#konfiguration">Konfiguration</a> -<ol> <li><a href="#konfiguration_konfigurationsdatei">Zentrale -Konfigurationsdatei</a> <ol> <li><a href="#konfiguration_konfigurationsdatei_request">Parameter -für den MOA SS Signaturerstellungsrequest</a></li> <li><a href="operation.html#konfiguration_konfigurationsdatei_moass">Parameter -der verwendeten MOA SS Installation</a></li><li><a href="operation.html#konfiguration_konfigurationsdatei_adressierung">Adressierung -des Servlet Containers des E-Recht Signaturclients</a></li><li><a href="#konfiguration_konfigurationsdatei_arbeitsverzeichnis">Arbeitsverzeichnis</a></li></ol> -</li> <li><a href="#konfiguration_layout">Layout -der Benutzeroberfläche</a> </li> </ol> </li> -</ol><hr><h1><a name="übersicht" id="übersicht"></a>1 -Übersicht</h1> -<p>Der E-Recht Signaturclient für MOA SS ist als -plattformunabhängiges Modul ausgelegt, das als Webanwendung -über HTTP angesprochen werden kann. </p> -<p>Dieses Handbuch beschreibt einerseits die Installation des -Clients, andererseits werden die Konfigurationsmöglichkeiten -dargestellt. Für eine funktionale Beschreibung des Moduls -siehe <a href="../system/system.html">Systemhandbuch</a>. -</p><h1><a name="installation" id="installation"></a>2 -Installation</h1> -<h2><a name="installation_einführung" id="installation_einführung"></a>2.1 -Einführung </h2> -<p>Der E-Recht Signaturclient für MOA SS wurde -plattformunabhänig -konzipiert und in Java entwickelt. Er benötigt als -Ablaufumgebung eine Java 2 Standard Edition (J2SE SDK, Version <a href="http://java.sun.com/j2se/1.4.2/">1.4.2</a> oder <a href="http://java.sun.com/j2se/1.5.0/">5.0</a>) sowie -einen Java Servlet Container, der die <a href="http://java.sun.com/products/servlet/reference/api/index.html">Java -Servlet Specification</a> in der Version 2.3 erfüllt. Als -grafische Benutzerschnittstelle für den Anwender dient ein -herkömmlicher Webbrowser.</p> -<p>In diesem Betriebshandbuch wird davon ausgegangen, dass -der E-Recht Signaturclient für MOA SS -<a href="http://jakarta.apache.org/tomcat/index.html">Apache -Tomcat</a> (Version 4.1 oder höher) als Servlet -Container verwendet. Die Verwendung eines anderen Servlet Containers -ist grundsätzlich möglich, wurde aber nicht getestet -und ist auch nicht Gegenstand dieses Betriebshandbuchs. </p> -<p>Weiters wird davon ausgegangen, dass Apache Tomcat -gleichzeitig als HTTP-Server dient, d.h. die Kommunikation zwischen dem -Webbrowser als grafische Benutzerschnittstelle des Signaturclients und -der Kernanwendung des Signaturclients wird über Tomcat abgewickelt. Die -Verwendung eines vor Apache Tomcat geschalteten -Webservers ist grundsätzlich möglich. So werden etwa -als Teil des Apache Tomcat Projekts <a href="http://tomcat.apache.org/connectors-doc/">Module</a> -zur Verbindung mit einem vorgeschalteten Microsoft Internet Information -Server oder mit einem vorgeschalteten Apache Webserver angeboten. Die -Beschreibung der möglichen Vorschaltungen ist jedoch nicht -Teil dieses Betriebshandbuchs.</p><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 zählen die XML-Präsentation des Rechtsdokuments, der -Stylesheet für die Umwandlung der XML-Repräsentation in die -HTML-Repräsentation, -sowie 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. Die erstellte Signatur kann wird dem -Benutzer abschließend zur lokalen Speicherung zur Verfügung gestellt. -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> -<p>Als Logging Toolkit verwendet das MOA SL Webservice <a href="http://logging.apache.org/log4j/">Apache Log4j</a>. -</p> -<h2><a name="installation_vorbereitung" id="installation_vorbereitung"></a>2.2 Vorbereitung</h2> -<p>Die folgenden Schritte dienen der Vorbereitung der -Installation.</p> -<dl> <dt>Installation von J2SE SDK</dt> <dd>Installieren -Sie <a href="http://java.sun.com/j2se/1.4.2/">J2SE 1.4.2 -SDK</a> -oder <a href="http://java.sun.com/j2se/1.5.0/">J2SE 5.0 -SDK</a> in ein beliebiges Verzeichnis. Das Wurzelverzeichnis der -J2SE SDK Installation wird im weiteren Verlauf als <code>$JAVA_HOME</code> -bezeichnet. </dd> <dt>Installation von Apache Tomcat</dt> -<dd> Installieren Sie <a href="http://jakarta.apache.org/tomcat/index.html">Apache -Tomcat</a> 4.1.31 oder höher in ein Verzeichnis, das -keine Leerzeichen im Pfadnamen enthält. Verwenden Sie bitte -die zu Ihrem J2SE SDK passende Distribution von Tomcat. Das -Wurzelverzeichnis der Tomcat-Installation wird im weiteren Verlauf als <code>$CATALINA_HOME</code> -bezeichnet.</dd> <dt>Installation von MOA SP </dt> <dd>Installieren -Sie das <a href="http://www.cio.gv.at/onlineservices/basicmodules/moa-spss/">Kombinationsmodul -MOA SPSS</a> Version 1.3 oder höher entsprechend seiner -Installationsanleitung. Sie benötigen die -Webservice-Schnittstelle von MOA SS. Es ist ausreichend, mittels -entsprechender Konfigurationseinstellungen ausschließlich MOA -SS zu aktivieren; MOA SP kann deaktiviert bleiben. Wenn Sie sowohl -für MOA SPSS als auch für den E-Recht Signaturclient für MOA SS Apache -Tomcat als -Servlet Container verwenden möchten, empfehlen wir, MOA SPSS -und en E-Recht Signaturclient für MOA SS in jeweils -eigenständigen Instanzen von Apache -Tomcat zu betreiben. </dd> <dt>Entpacken -der Distribution des E-Recht Signaturclients für MOA SS</dt> -<dd> Entpacken Sie die Datei <code>moa-ss-erecht-client-x.y.zip</code> -in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren -Verlauf als <code>$MOA_SS_CLIENT_INST</code> bezeichnet. </dd> -</dl><h2><a name="installation_tomcatconfig" id="installation_tomcatconfig"></a>2.3 Konfiguration -von Apache Tomcat</h2> -<p> Die zentrale Konfigurations-Datei von Tomcat ist <code>$CATALINA_HOME/conf/server.xml</code>. -Tomcat wird grundsätzlich mit einer funktionierenden -Default-Konfiguration ausgeliefert, die jedoch einiges an Ballast -enthält und viele Ports offen lässt. </p> -<h3><a name="installation_tomcatconfig_httpconn" id="installation_tomcatconfig_httpconn"></a>2.3.1 -Konfiguration des HTTP Connectors</h3> -<p> Die Datei <code>$MOA_SS_CLIENT_INST</code><code>/conf/tomcat/server.xml</code> -enthält eine minimale Tomcat-Konfiguration, die -ausschließlich den Connector für HTTP auf Port 8080 -freischaltet. Durch kopieren dieser Datei nach <code>$CATALINA_HOME/conf/server.xml</code> -kann Tomcat mit dieser Konfiguration gestartet werden. </p><p class="remark">Sicherheitshinweis: Es wird in diesem -Betriebshandbuch davon ausgegangen, dass der E-Recht Signaturclient für -MOA SS sowie das Modul MOA SS selbst miteinander in einer abschlossenen -Umgebung betrieben werden. Der E-Recht Signaturclient für MOA -SS unterstützt derzeit die Anbindung von MOA SS nur über die -ungesicherte HTTP Webservice-Schnittstelle. Weiters bietet der E-Recht -Signaturclient für MOA SS derzeit keine eigenständige -Benutzerauthentisierung. </p><h3><a name="installation_tomcatconfig_httpsconn" id="installation_tomcatconfig_httpsconn"></a></h3><h2><a name="installation_deploy" id="installation_deploy"></a>2.4 -Einsatz des E-Recht Signaturclient für MOA SS in -Tomcat</h2> -<p> Um den E-Recht Signaturclient für MOA SS in -Tomcat für den Einsatz -vorzubereiten, sind folgende Schritte notwendig:</p> -<ul> <li>Die Datei <code>$MOA_SS_CLIENT_INST</code><code>/moa-ss-erecht-client.war</code> -enthält das einsatzfertige Webarchiv für den E-Recht Signaturclient für -MOA SS und muss ins -Verzeichnis <code>$CATALINA_HOME/webapps</code> kopiert -werden. Dort wird sie beim ersten Start von Tomcat automatisch ins -Verzeichnis <code>$CATALINA_HOME/webapps/</code><code>moa-ss-erecht-client</code> -entpackt. </li> <li>Die zentrale Konfigurationsdatei -für den E-Recht Signaturclient für MOA SS -muss -in ein beliebiges Verzeichnis im Dateisystem kopiert werden (z.B. <code>$CATALINA_HOME/conf/moa-ss-erecht-client/</code>). -Eine funktionsfähige Konfiguration, die als Ausgangspunkt -für die Konfiguration des E-Recht Signaturclients für MOA SS -dienen kann, -finden Sie unter <code>$MOA_SS_CLIENT_INST</code><code></code><code>/conf/</code><code>moa-ss-erecht-client.config.properties</code>. -</li> <li>Die Dateien <code>xalan.jar</code>, -<code>xercesImpl.jar</code> -und <code>xml-apis.jar</code> aus dem Verzeichnis <code>$MOA_SS_CLIENT_INST</code><code>/endorsed14</code> -müssen in das Tomcat-Verzeichnis <code>$CATALINA_HOME/common/endorsed</code> -kopiert werden. Sind gleichnamige Dateien dort bereits vorhanden, -müssen sie überschrieben werden. </li> <li>Folgende -<span class="term">System Properties</span> -für die <span class="term">Java Virtual Machine</span> -müssen bzw. können gesetzt werden. Am einfachsten -können diese <span class="term">System Properties</span> -beim Starten von Tomcat in der Umgebungsvariablen <code>CATALINA_OPTS</code> -in der Form <code>-D<name>=<wert></code> -übergeben werden. <ul> <li id="klein"><code>at.gv.egovernment.moa.ss.erechtclient.PropertiesLocation</code>: -Pfad und Name der zentralen Konfigurationsdatei -für den E-Recht -Signaturclient für MOA SS. -Eine beispielhafte Konfigurationsdatei finden Sie unter <code>$MOA_SS_CLIENT_INST</code><code></code><code>/conf/</code><code>moa-ss-erecht-client.config.properties</code>.<code></code>. -Wird ein relativer Pfad angegeben, wird zuerst versucht, diesen relativ -zum Wurzelverzeichnis der Webapplikation (also <code>$CATALINA_HOME/webapps/</code><code></code><code>moa-ss-erecht-client</code>) -zu interpretieren. Klappt das nicht, wird dann versucht, den relativen -Pfad relativ zum Startverzeichnis der <span class="term">Java -Virtual Machine</span> zu interpretieren. Diese <span class="term">System Property</span> muss jedenfalls -gesetzt werden.</li> <li id="klein"><code>log4j.configuration</code>: -URL der Log4j Konfigurationsdatei. Eine beispielhafte -Log4j-Konfiguration finden Sie unter <code>$MOA_SS_CLIENT_INST</code><code></code><code>/conf/</code><code>log4j.properties</code>. -Wird eine -relative URL angegeben, wird diese als File-URL relativ zum -Startverzeichnis der <span class="term">Java Virtual -Machine</span> interpretiert. Ist diese System Property nicht -gesetzt, wird automatisch eine im Webarchiv unter <code>WEB-INF/classes</code> -enthaltene Default-Konfiguration herangezogen.</li></ul> </li> -</ul><h2><a name="installation_tomcatstartstop" id="installation_tomcatstartstop"></a>2.5 Starten und -Stoppen von Tomcat</h2> -<h3><a name="installation_tomcatstartstop_windows" id="installation_tomcatstartstop_windows"></a>2.5.1 -Unter Windows</h3> -<p>Das Verzeichnis <code>$MOA_SL_INST/conf/tomcat/win32</code> -enthält Script-Dateien zum Starten und Stoppen von Tomcat. Vor -der erstmaligen Verwendung der Scripts müssen in den ersten -Zeilen die Umgebungsvariablen <code>JAVA_HOME</code> -(Basisverzeichnis des eingesetzten J2SE SDK) und <code>CATALINA_HOME</code> -(Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst -werden. Evtl. müssen Sie auch noch die in den Script-Dateien -gesetzten, in <a href="#installation_deploy">Abschnitt 2.4</a> -besprochenen <span class="term">System Properties</span> -anpassen. </p> -<h3><a name="installation_tomcatstartstop_unix" id="installation_tomcatstartstop_unix"></a>2.5.2 Unter -Unix</h3> -<p>Zunächst müssen die in <a href="#installation_deploy">Abschnitt -2.4</a> -besprochenen <span class="term">System Properties</span> -mit Hilfe der Umgebungsvariablen <code>CATALINA_OPTS</code> -gesetzt werden. Die Datei <code>$MOA_SL_INST/tomcat/unix/moa-env.sh</code> -enthält ein Beispiel dafür. Weiters müssen -noch die Umgebungsvariablen <code>JAVA_HOME</code> -(Basisverzeichnis des eingesetzten J2SE SDK) und <code>CATALINA_HOME</code> -(Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst -werden.</p> -<p>Nun kann Tomcat aus seinem Basisverzeichnis mit </p> -<pre>bin/catalina.sh start</pre>gestartet werden. Das -Stoppen von Tomcat erfolgt analog mit -<pre>bin/catalina.sh stop</pre><h3><a name="installation_tomcatstartstop_logging" id="installation_tomcatstartstop_logging"></a>2.5.3 -Logging </h3> -<p>Das MOA SL Webservice verwendet <a href="http://logging.apache.org/log4j/">Apache Log4j</a> -für die -Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j -bietet zahlreiche Konfigurationsmöglichkeiten, die -ausführlich im <a href="http://logging.apache.org/log4j/">Apache -Log4j</a> -Handbuch beschrieben sind. Unter anderem gibt es die -Möglichkeit, folgende Einstellungen vorzunehmen: -</p><ul> <li id="klein"> <p>Das -verwendete Log-Level (<code>DEBUG</code>, <code>INFO</code>, -<code>WARN</code>, <code>ERROR</code>, <code>FATAL</code>);</p> -</li> <li id="klein"> <p>Name und maximale -Größe der -Log-Datei(en);</p> </li> <li id="klein"> <p>Das -Aussehen der Log-Einträge.</p> </li> -</ul><p>Der E-Recht Signaturclient für -MOA SS verwendet für alle -Logeinträge die Log-Hierarchie <code>erechtclient</code>. -Für die einzelnen Pakete des E-Recht Signaturclients für MOA -SS -werden davon -abgeleitete Sub-Hierarchien eingesetzt, z.B. <code>erechtclient</code><code>.xmlparser</code>, <code>erechtclient</code><code>.init, -erechtclient.servlets</code> oder <code>erechtclient</code><code>.moainvoker</code>.</p> -<p>Eine für den E-Recht Signaturclient für MOA -SS passende Konfigurationsdatei -für Log4j finden Sie unter <code>$MOA_SS_CLIENT_INST</code><code></code><code>/conf/</code><code>log4j.properties</code>. -Wird diese -Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen -sowohl in die Konsole, als auch in die Datei <code>$CATALINA_HOME/logs/moa-ss-erecht-client.log</code> -geschrieben. </p> -<h4><a name="webservice_basisinstallation_logging_format" id="webservice_basisinstallation_logging_format"></a>2.5.3.1 -Format der Log-Meldungen</h4> -<p> Anhand einer konkreten Log-Meldung wird das Format -der -Log-Meldungen erläutert: </p> -<pre>INFO | 28 12:14:48,567 | erechtclient.init | main | <br> Web application initialization succeeded.</pre><p>Der -Wert <code>INFO</code> besagt, dass die -Log-Meldung im Log-Level <code>INFO</code> entstanden ist. -Folgende Log-Levels existieren:</p> -<ul> <li> <p><code>DEBUG</code>: -Log-Meldungen im Log-Level <code>DEBUG</code> geben -Auskunft über die -innere Arbeitsweise des Systems. Sie sind hauptsächlich -für Entwickler interessant.</p> </li> <li> <p><code>INFO</code>: -Diese Log-Meldungen geben -Status-Informationen über den Ablauf des Webservices, wie z.B. -über das Einlangen einer neuen Anfrage.</p> </li> <li> -<p><code>WARN</code>: Bei der Ausführung -einer Anfrage sind leichte Fehler aufgetreten. Der Ablauf des -Webservices ist nicht weiter beeinträchtigt.</p> </li> <li> -<p><code>ERROR</code>: Die Ausführung -einer Anfrage musste abgebrochen werden. Das Webservice ist davon nicht -beeinträchtigt. </p> </li> <li> <p><code>FATAL</code>: -Es ist ein Fehler -aufgetreten, der den weiteren Betrieb des Webservices nicht mehr -erlaubt.</p> </li> -</ul><p>Der nächste Wert <code>28 12:14:48,567</code> -gibt den Zeitpunkt an, zu dem die Log-Meldung generiert wurde (in -diesem Fall den 28. Tag im aktuellen Monat, sowie die genaue Uhrzeit). </p> -<p>Der Wert <code>erechtclient.init</code> gibt -die Log-Hierarchie an, aus der die Log-Meldung stammt. </p> -<p>Der Wert <code>main</code> bezeichnet den Thread, -aus der die Log-Meldung stammt. </p> -<p>Der Rest der Zeile einer Log-Meldung ist der eigentliche Text, -mit dem das System bestimmte Informationen anzeigt. Im Fehlerfall ist -häufig ein Java Stack-Trace angefügt, der eine -genauere Ursachen-Forschung ermöglicht.</p> -<h3><a name="installation_tomcatstartstop_verify" id="installation_tomcatstartstop_verify"></a>2.5.4 -Prüfen des erfolgreichen Starts </h3> -<p>Ein erfolgreicher Start des E-Recht Signaturclients -für MOA SS ist an -folgender Log-Meldung ersichtlich: </p> -<pre>INFO | 28 12:14:48,567 | erechtclient.init | main | <br> Web application initialization succeeded.</pre><p>Konnte -der E-Recht Signaturclient für MOA SS nicht -ordnungsgemäß gestartet werden, führt das -zu folgender Log-Meldung:</p> -<pre>FATAL | 28 10:17:03,475 | main | TID=startup NID=<null> <br> Web application initialization failed.<br></pre><p>In -diesem Fall geben die<code> </code>Log-Meldungen -unmittelbar davor Aufschluss über den genaueren Grund. </p><h1><a name="konfiguration" id="konfiguration"></a>3 -Konfiguration</h1> -<h2><a name="konfiguration_konfigurationsdatei" id="konfiguration_konfigurationsdatei"></a>3.1 -Zentrale Konfigurationsdatei</h2> -<p>Alle Konfigurationsparameter des E-Recht -Signaturclients für MOA SS sind in einer -zentralen Konfigurationsdatei zusammengefasst. Eine beispielhafte -Konfigurationsdatei finden Sie unter <code>$MOA_SS_CLIENT_INST</code><code></code><code>/conf/</code><code>moa-ss-erecht-client.config.properties</code>. -Für Hinweise, wie Sie dem E-Recht Signaturclient für MOA SS -mitteilen, welche -Konfigurationsdatei er verwenden soll, siehe Abschnitt <a href="#installation_deploy">2.4</a>. </p> -<p>In den folgenden Abschnitten werden die einzelnen -Konfigurationsparameter der zentralen Konfigurationsdatei im Detail -besprochen. Die meisten Konfigurationsparameter werden leichter -verständlich, wenn Sie zunächst<span style="font-style: italic;"> -</span>das <a href="../system/system.html">Systemhandbuch<span class="comment"></span></a> lesen. Dort werden -der gesamte Ablauf eines Signaturerstellungsvorgangs sowie -die daran beteiligten Komponenten erklärt. </p> -<p>Die Konfigurationsdatei ist als <span class="term">Java -Properties</span> Datei aufgebaut, d. h. jede Zeile -enthält den Namen sowie den Wert des jeweiligen -Konfigurationsparameters in der Form <code>name=wert</code>. -Details zum Aufbau einer <span class="term">Java -Properties</span> Datei finden Sie in der API-Dokumentation zu -Ihrem Java JDK, beispielsweise <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/Properties.html">hier</a>. -</p> -<h3><a name="konfiguration_konfigurationsdatei_request" id="konfiguration_konfigurationsdatei_schemata"></a>3.1.1 -Parameter für den MOA SS Signaturerstellungsrequest </h3><table class="fixedWidth" border="1" cellpadding="2"> -<tbody> <tr> <td>Name</td> -<td><code>location.schema.moa</code></td> </tr> -<tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht Signaturclient -für MOA SS -mitgeteilt, wo er das XML-Schema für die Validierung eines von -MOA SS empfangenen Signaturerstellungsresponses nach MOA SPSS -V1.3 findet. </p> <p>Der Konfigurationsparameter muss als -Wert einen Pfad -enthalten, der mit <code>/</code> beginnt, und der vom -E-Recht Signaturclient für MOA SS als relativ zum <span class="term">Context -Root</span> -der Webapplikation interpretiert wird.</p> </td> </tr> -<tr> <td>Beispiel</td> <td> <p><code>/WEB-INF/classes/resources/schemas/MOA-SPSS-1.3.xsd</code></p> -</td> </tr> </tbody></table><table class="fixedWidth" border="1" cellpadding="2"><tbody> -<tr> <td>Name</td> -<td><code>location.ss.stylesheet</code></td> </tr> -<tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht Signaturclient -für MOA SS -mitgeteilt, wo er den Default-Stylesheet findet, der im MOA SS -Signaturerstellungsrequest angegeben und von MOA SS dazu verwendet -wird, um die XML-Repräsentation des Rechtsdokuments in die dann -tatsächlich elektronisch sigierte HTML-Repräsenation überzuführen. </p> -<p>Der Konfigurationsparameter muss als -Wert einen Pfad -enthalten, der mit <code>/</code> beginnt, und der vom -E-Recht Signaturclient für MOA SS als relativ zum <span class="term">Context -Root</span> -der Webapplikation interpretiert wird.</p> </td> </tr> -<tr> <td>Beispiel</td> <td> <p><code>/static/erecht.stylesheet.1-9-0.xsl</code></p> -</td> </tr> </tbody></table><table class="fixedWidth" border="1" cellpadding="2"><tbody> -<tr> <td>Name</td> -<td><code>location.ss.requestTemplate</code></td> -</tr><tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht Signaturclient -für MOA SS -mitgeteilt, wo er das XML-Template für den Signaturerstellungsrequest -an MOA SS findet. </p> <p>Der -Konfigurationsparameter muss als -Wert einen Pfad -enthalten, der mit <code>/</code> beginnt, und der vom -E-Recht Signaturclient für MOA SS als relativ zum <span class="term">Context -Root</span> -der Webapplikation interpretiert wird.</p> </td> </tr> -<tr> <td>Beispiel</td> <td> <p><code>/WEB-INF/classes/resources/templates/CreateRequest.xml</code></p> -</td> </tr> </tbody></table><h3><a name="konfiguration_konfigurationsdatei_moass" id="konfiguration_konfigurationsdatei_moasp"></a>3.1.2 -Parameter der verwendeten MOA SS Installation</h3> -<table class="fixedWidth" border="1" cellpadding="2"><tbody><tr><td>Name</td> -<td><code>service.ss.endpoint</code></td> -</tr> <tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht -Signaturclient für MOA SS der -Zugangspunkt zum Webservice von MOA SS mitgeteilt. </p> <p>Der -Konfigurationsparameter muss eine URL enthalten, die vom -E-Recht Signaturclient für MOA SS aus erreichbar ist und den -Zugangspunkt zu MOA SS -adressiert. </p> </td> </tr> <tr> <td>Beispiel</td> -<td> <p><code>http://localhost:8081/moa-spss/services/SignatureCreation</code></p> -</td> </tr> </tbody></table><table class="fixedWidth" border="1" cellpadding="2"><tbody><tr><td>Name</td> -<td><code>service.ss.keyIdentifier</code></td> -</tr> <tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht -Signaturclient für MOA SS -mitgeteilt, welchen Schlüsselbezeichner er im -Signaturerstellungsrequest -an MOA SS verwenden soll. </p> <p>Der -Konfigurationsparameter muss den Bezeichner eines in -MOA SS hinterlegten Schlüsselbezeichner enthalten.</p> </td> -</tr> <tr> <td>Beispiel</td> <td> <p><code>KG_allgemein</code></p> -</td> </tr> </tbody></table><h3><a name="konfiguration_konfigurationsdatei_adressierung" id="konfiguration_konfigurationsdatei_umfang"></a>3.1.3 -Adressierung des Servlet Containers des E-Recht Signaturclients</h3> -<table class="fixedWidth" border="1" cellpadding="2"><tbody><tr><td>Name</td> -<td><code>location.webAppHostPort</code></td> -</tr> <tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht -Signaturclient für MOA SS -mitgeteilt, unter welchem Hostnamen bzw. Port der Servlet Container, in -dem der E-Recht -Signaturclient für MOA SS läuft, <strong>vom Benutzer</strong> erreicht werden kann. </p> -<p>Der -Konfigurationsparameter muss eine URL sein, die ausschließlich die -Komponenten Protokoll (also in der Regel <code>http</code>), -Hostname (z.B. <code>localhost</code>) und Portnummer -(z.B. <code>8084</code>) enthält.</p> </td> -</tr> <tr> <td>Beispiel</td> <td> <p><code>http://localhost:8084</code></p> -</td> </tr> </tbody></table> -<table class="fixedWidth" border="1" cellpadding="2"><tbody><tr><td>Name</td> -<td><code>location.webAppHostPortFromMOASS</code></td> -</tr> <tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht -Signaturclient für MOA SS -mitgeteilt, unter welchem Hostnamen bzw. Port der Servlet Container, in -dem der E-Recht -Signaturclient für MOA SS läuft, <strong>von MOA SS</strong> erreicht werden kann. </p> -<p>Der -Konfigurationsparameter muss eine URL sein, die ausschließlich die -Komponenten Protokoll (also in der Regel <code>http</code>), -Hostname (z.B. <code>localhost</code>) und Portnummer -(z.B. <code>8084</code>) enthält.</p> </td> -</tr> <tr> <td>Beispiel</td> <td> <p><code>http://localhost:8084</code></p> -</td> </tr> </tbody></table> -<h3><a name="konfiguration_konfigurationsdatei_arbeitsverzeichnis" id="konfiguration_konfigurationsdatei_arbeitsverzeichnis"></a>3.1.4 -Arbeitsverzeichnis</h3> -<table class="fixedWidth" border="1" cellpadding="2"><tbody><tr><td>Name</td> -<td><code>location.tempdir</code></td> -</tr> <tr> <td>Erläuterung</td> <td> <p>Mit -diesem Konfigurationsparameter wird dem E-Recht -Signaturclient für MOA SS -mitgeteilt, wo es das Arbeitsverzeichnis zum temporären Ablegen der vom -Benutzer hochgeladenen Dokumente findet. </p> <p>Der -Konfigurationsparameter muss als Wert -einen Pfad -enthalten, der vom E-Recht Signaturclient für MOA SS als relativ zum <span class="term">Context -Root</span> der Webapplikation interpretiert wird. Der angegebene -Pfad muss einen abschließenden <code>/</code> -aufweisen und im Dateisystem tatsächlich existieren. </p> </td> -</tr> <tr> <td>Beispiel</td> <td> <p><code>/workdir/temp/</code></p> -</td> </tr> </tbody></table><h2><a name="konfiguration_layout" id="konfiguration_layout"></a>3.2 -Layout der Benutzeroberfläche </h2> -<p>Die Benutzeroberfläche des E-Recht Signaturclient für MOA SS ist in -Form von Webseiten realisiert, die dem Benutzer in seinem Webbrowser -angezeigt werden.</p><p>Das Layout dieser Webseiten kann völlig frei -gestaltet werden. Die Vorlagen für die Webseiten liegen in Form von -JSP-Seiten (Java Server Pages) im Verzeichnis <code>$MOA_SL_WEBAPP/pages</code> (<code>UploadXML.jsp</code>, <code>UploadImages.jsp</code>, <code>DownloadSignature.jsp</code> sowie <code>Error.jsp</code>). </p> - -<p>Wenn Sie das Layout gegenüber der Vorgabe -verändern möchten, editieren Sie einfach die -HTML-Teile dieser JSP-Seiten. Beachten Sie bitte, dass Sie dabei die -JSP-Scriptelemente unverändert lassen. JSP-Scriptelemente sind -entweder Tags, die mit dem Präfix <code>jsp</code> -gekennzeichnet sind (z.B. <code><jsp:useBean></code> -oder <code><jsp:getProperty></code>, oder -Bereiche die mit der Kennzeichnung <code><%</code> -eingeleitet bzw. mit der Kennzeichnung <code>%></code> -ausgeleitet werden. </p> -<h1><a name="testapp" id="testapp"></a></h1></body></html>
\ No newline at end of file diff --git a/erecht.client.ss/handbook/system/images/Zusammenspiel.VSD b/erecht.client.ss/handbook/system/images/Zusammenspiel.VSD Binary files differdeleted file mode 100644 index 6ead1bd1c..000000000 --- a/erecht.client.ss/handbook/system/images/Zusammenspiel.VSD +++ /dev/null diff --git a/erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png b/erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png Binary files differdeleted file mode 100644 index 4e7fcda67..000000000 --- a/erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png +++ /dev/null diff --git a/erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png b/erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png Binary files differdeleted file mode 100644 index 0dc944cb9..000000000 --- a/erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png +++ /dev/null diff --git a/erecht.client.ss/handbook/system/images/Zusammenspiel.png b/erecht.client.ss/handbook/system/images/Zusammenspiel.png Binary files differdeleted file mode 100644 index 16199e4a5..000000000 --- a/erecht.client.ss/handbook/system/images/Zusammenspiel.png +++ /dev/null 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 |
