diff options
Diffstat (limited to 'erecht.client.ss/handbook/operation')
| -rw-r--r-- | erecht.client.ss/handbook/operation/images/testapp.screen1.png | bin | 0 -> 38150 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/operation/images/testapp.screen2.png | bin | 0 -> 44749 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/operation/images/testapp.screen3.png | bin | 0 -> 16625 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/operation/images/testapp.screen4.png | bin | 0 -> 40110 bytes | |||
| -rw-r--r-- | erecht.client.ss/handbook/operation/operation.html | 467 |
5 files changed, 467 insertions, 0 deletions
diff --git a/erecht.client.ss/handbook/operation/images/testapp.screen1.png b/erecht.client.ss/handbook/operation/images/testapp.screen1.png Binary files differnew file mode 100644 index 000000000..38a226d09 --- /dev/null +++ b/erecht.client.ss/handbook/operation/images/testapp.screen1.png diff --git a/erecht.client.ss/handbook/operation/images/testapp.screen2.png b/erecht.client.ss/handbook/operation/images/testapp.screen2.png Binary files differnew file mode 100644 index 000000000..45230d5c9 --- /dev/null +++ b/erecht.client.ss/handbook/operation/images/testapp.screen2.png diff --git a/erecht.client.ss/handbook/operation/images/testapp.screen3.png b/erecht.client.ss/handbook/operation/images/testapp.screen3.png Binary files differnew file mode 100644 index 000000000..7d5db9cad --- /dev/null +++ b/erecht.client.ss/handbook/operation/images/testapp.screen3.png diff --git a/erecht.client.ss/handbook/operation/images/testapp.screen4.png b/erecht.client.ss/handbook/operation/images/testapp.screen4.png Binary files differnew file mode 100644 index 000000000..9fe7ee264 --- /dev/null +++ b/erecht.client.ss/handbook/operation/images/testapp.screen4.png diff --git a/erecht.client.ss/handbook/operation/operation.html b/erecht.client.ss/handbook/operation/operation.html new file mode 100644 index 000000000..25b152803 --- /dev/null +++ b/erecht.client.ss/handbook/operation/operation.html @@ -0,0 +1,467 @@ +<!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>, +für die Beschreibung der Verwendung siehe <a href="../usage/usage.html">Anwenderhandbuch</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 XML-Dokuments, 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.2 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 |
