From f25a072fd1c3b131d5f2f15689942ca7c55a62c0 Mon Sep 17 00:00:00 2001 From: "(no author)" <(no author)@d688527b-c9ab-4aba-bd8d-4036d912da1d> Date: Mon, 6 Aug 2007 14:26:08 +0000 Subject: This commit was manufactured by cvs2svn to create tag 'Build-ID-1_4_0'. git-svn-id: https://joinup.ec.europa.eu/svn/moa-idspss/tags/Build-ID-1_4_0@907 d688527b-c9ab-4aba-bd8d-4036d912da1d --- erecht.client.ss/handbook/common/LogoBKA.png | Bin 8062 -> 0 bytes erecht.client.ss/handbook/common/handbook.css | 300 ------------- erecht.client.ss/handbook/constraints.txt | 8 - erecht.client.ss/handbook/index.html | 34 -- erecht.client.ss/handbook/operation/operation.html | 464 --------------------- .../handbook/system/images/Zusammenspiel.VSD | Bin 113152 -> 0 bytes .../handbook/system/images/Zusammenspiel.mit.png | Bin 48649 -> 0 bytes .../handbook/system/images/Zusammenspiel.ohne.png | Bin 36106 -> 0 bytes .../handbook/system/images/Zusammenspiel.png | Bin 51511 -> 0 bytes erecht.client.ss/handbook/system/system.html | 170 -------- 10 files changed, 976 deletions(-) delete mode 100644 erecht.client.ss/handbook/common/LogoBKA.png delete mode 100644 erecht.client.ss/handbook/common/handbook.css delete mode 100644 erecht.client.ss/handbook/constraints.txt delete mode 100644 erecht.client.ss/handbook/index.html delete mode 100644 erecht.client.ss/handbook/operation/operation.html delete mode 100644 erecht.client.ss/handbook/system/images/Zusammenspiel.VSD delete mode 100644 erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png delete mode 100644 erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png delete mode 100644 erecht.client.ss/handbook/system/images/Zusammenspiel.png delete mode 100644 erecht.client.ss/handbook/system/system.html (limited to 'erecht.client.ss/handbook') diff --git a/erecht.client.ss/handbook/common/LogoBKA.png b/erecht.client.ss/handbook/common/LogoBKA.png deleted file mode 100644 index 6a92647fd..000000000 Binary files a/erecht.client.ss/handbook/common/LogoBKA.png and /dev/null differ 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 @@ - - - - MOA SL - Übersicht - - - - - - - - - - - - - -
Logo BKAE-Recht
-
- -

E-Recht: Signaturclient für MOA SS

- -

Übersicht zur Dokumentation der Version 0.9

-
- -
-
Betriebshandbuch
- -
Anleitung für die Installation sowie Erläuterung aller Konfigurationsoptionen.
- -
Systemhandbuch
- -
Beschreibung der einzelnen Komponenten des Signaturclients und ihrem Zusammenspiel.
- \ 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 @@ - - -MOA SL - Betriebshandbuch - -
Logo BKA E-Recht

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

-

Betriebshandbuch

-

Inhalt

-

  1. Übersicht

    -
  2. Installation -
    1. Einführung
      2. -
    2. Vorbereitung
      3. -
    3. Konfiguration -von Apache Tomcat
      1. Konfiguration -des HTTP Connectors
    4. Einsatz des E-Recht -Signaturclients für MOA SS in Tomcat
    5. Starten -und Stoppen von Tomcat
      1. Unter -Windows
      2. Unter -Unix
      3. Logging -
        1. Format -der Log-Meldungen
      4. Prüfen -des erfolgreichen Starts
      6. -
  3. Konfiguration -
    1. Zentrale -Konfigurationsdatei
      1. Parameter -für den MOA SS Signaturerstellungsrequest
      2. Parameter -der verwendeten MOA SS Installation
      3. Adressierung -des Servlet Containers des E-Recht Signaturclients
      4. Arbeitsverzeichnis
      -
    2. Layout -der Benutzeroberfläche
    4. -

1 -Übersicht

-

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

-

Dieses Handbuch beschreibt einerseits die Installation des -Clients, andererseits werden die Konfigurationsmöglichkeiten -dargestellt. Für eine funktionale Beschreibung des Moduls -siehe Systemhandbuch. -

2 -Installation

-

2.1 -Einführung

-

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 1.4.2 oder 5.0) sowie -einen Java Servlet Container, der die Java -Servlet Specification in der Version 2.3 erfüllt. Als -grafische Benutzerschnittstelle für den Anwender dient ein -herkömmlicher Webbrowser.

-

In diesem Betriebshandbuch wird davon ausgegangen, dass -der E-Recht Signaturclient für MOA SS -Apache -Tomcat (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.

-

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 Module -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.

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.

-

Als Logging Toolkit verwendet das MOA SL Webservice Apache Log4j. -

-

2.2 Vorbereitung

-

Die folgenden Schritte dienen der Vorbereitung der -Installation.

-
Installation von J2SE SDK
Installieren -Sie J2SE 1.4.2 -SDK -oder J2SE 5.0 -SDK in ein beliebiges Verzeichnis. Das Wurzelverzeichnis der -J2SE SDK Installation wird im weiteren Verlauf als $JAVA_HOME -bezeichnet.
Installation von Apache Tomcat
-
Installieren Sie Apache -Tomcat 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 $CATALINA_HOME -bezeichnet.
Installation von MOA SP
Installieren -Sie das Kombinationsmodul -MOA SPSS 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.
Entpacken -der Distribution des E-Recht Signaturclients für MOA SS
-
Entpacken Sie die Datei moa-ss-erecht-client-x.y.zip -in ein beliebiges Verzeichnis. Dieses Verzeichnis wird im weiteren -Verlauf als $MOA_SS_CLIENT_INST bezeichnet.
-

2.3 Konfiguration -von Apache Tomcat

-

Die zentrale Konfigurations-Datei von Tomcat ist $CATALINA_HOME/conf/server.xml. -Tomcat wird grundsätzlich mit einer funktionierenden -Default-Konfiguration ausgeliefert, die jedoch einiges an Ballast -enthält und viele Ports offen lässt.

-

2.3.1 -Konfiguration des HTTP Connectors

-

Die Datei $MOA_SS_CLIENT_INST/conf/tomcat/server.xml -enthält eine minimale Tomcat-Konfiguration, die -ausschließlich den Connector für HTTP auf Port 8080 -freischaltet. Durch kopieren dieser Datei nach $CATALINA_HOME/conf/server.xml -kann Tomcat mit dieser Konfiguration gestartet werden. 

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.

2.4 -Einsatz des E-Recht Signaturclient für MOA SS in -Tomcat

-

Um den E-Recht Signaturclient für MOA SS in -Tomcat für den Einsatz -vorzubereiten, sind folgende Schritte notwendig:

-

2.5 Starten und -Stoppen von Tomcat

-

2.5.1 -Unter Windows

-

Das Verzeichnis $MOA_SL_INST/conf/tomcat/win32 -enthält Script-Dateien zum Starten und Stoppen von Tomcat. Vor -der erstmaligen Verwendung der Scripts müssen in den ersten -Zeilen die Umgebungsvariablen JAVA_HOME -(Basisverzeichnis des eingesetzten J2SE SDK) und CATALINA_HOME -(Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst -werden. Evtl. müssen Sie auch noch die in den Script-Dateien -gesetzten, in Abschnitt 2.4 -besprochenen System Properties -anpassen.

-

2.5.2 Unter -Unix

-

Zunächst müssen die in Abschnitt -2.4 -besprochenen System Properties -mit Hilfe der Umgebungsvariablen CATALINA_OPTS -gesetzt werden. Die Datei $MOA_SL_INST/tomcat/unix/moa-env.sh -enthält ein Beispiel dafür. Weiters müssen -noch die Umgebungsvariablen JAVA_HOME -(Basisverzeichnis des eingesetzten J2SE SDK) und CATALINA_HOME -(Basisverzeichnis der eingesetzten Tomcat-Installation) angepasst -werden.

-

Nun kann Tomcat aus seinem Basisverzeichnis mit

-
bin/catalina.sh start
gestartet werden. Das -Stoppen von Tomcat erfolgt analog mit -
bin/catalina.sh stop

2.5.3 -Logging

-

Das MOA SL Webservice verwendet Apache Log4j -für die -Ausgabe von Log-Meldungen am Bildschirm bzw. in Log-Dateien. Log4j -bietet zahlreiche Konfigurationsmöglichkeiten, die -ausführlich im Apache -Log4j -Handbuch beschrieben sind. Unter anderem gibt es die -Möglichkeit, folgende Einstellungen vorzunehmen: -

Der E-Recht Signaturclient für -MOA SS verwendet für alle -Logeinträge die Log-Hierarchie erechtclient. -Für die einzelnen Pakete des E-Recht Signaturclients für MOA -SS -werden davon -abgeleitete Sub-Hierarchien eingesetzt, z.B. erechtclient.xmlparser, erechtclient.init, -erechtclient.servlets oder erechtclient.moainvoker.

-

Eine für den E-Recht Signaturclient für MOA -SS passende Konfigurationsdatei -für Log4j finden Sie unter $MOA_SS_CLIENT_INST/conf/log4j.properties. -Wird diese -Datei als Logging-Konfiguration verwendet, so werden alle Log-Meldungen -sowohl in die Konsole, als auch in die Datei $CATALINA_HOME/logs/moa-ss-erecht-client.log -geschrieben.

-

2.5.3.1 -Format der Log-Meldungen

-

Anhand einer konkreten Log-Meldung wird das Format -der  -Log-Meldungen erläutert:

-
INFO | 28 12:14:48,567 | erechtclient.init | main | 
 Web application initialization succeeded.

Der -Wert INFO besagt, dass die -Log-Meldung im Log-Level INFO entstanden ist. -Folgende Log-Levels existieren:

-

Der nächste Wert 28 12:14:48,567 -gibt den Zeitpunkt an, zu dem die Log-Meldung generiert wurde (in -diesem Fall den 28. Tag im aktuellen Monat, sowie die genaue Uhrzeit).

-

Der Wert erechtclient.init gibt -die Log-Hierarchie an, aus der die Log-Meldung stammt.

-

Der Wert main bezeichnet den Thread, -aus der die Log-Meldung stammt.

-

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.

-

2.5.4 -Prüfen des erfolgreichen Starts

-

Ein erfolgreicher Start des E-Recht Signaturclients -für MOA SS ist an -folgender Log-Meldung ersichtlich:

-
INFO | 28 12:14:48,567 | erechtclient.init | main | 
 Web application initialization succeeded.

Konnte -der E-Recht Signaturclient für MOA SS  nicht -ordnungsgemäß gestartet werden, führt das -zu folgender Log-Meldung:

-
FATAL | 28 10:17:03,475 | main | TID=startup NID=<null> 
 Web application initialization failed.

In -diesem Fall geben die Log-Meldungen -unmittelbar davor Aufschluss über den genaueren Grund.

3 -Konfiguration

-

3.1 -Zentrale Konfigurationsdatei

-

Alle Konfigurationsparameter des E-Recht -Signaturclients für MOA SS  sind in einer -zentralen Konfigurationsdatei zusammengefasst. Eine beispielhafte -Konfigurationsdatei finden Sie unter $MOA_SS_CLIENT_INST/conf/moa-ss-erecht-client.config.properties. -Für Hinweise, wie Sie dem E-Recht Signaturclient für MOA SS -mitteilen, welche -Konfigurationsdatei er verwenden soll, siehe Abschnitt 2.4.

-

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 -das Systemhandbuch lesen. Dort werden -der gesamte Ablauf eines Signaturerstellungsvorgangs sowie -die daran beteiligten Komponenten erklärt.

-

Die Konfigurationsdatei ist als Java -Properties Datei aufgebaut, d. h. jede Zeile -enthält den Namen sowie den Wert des jeweiligen -Konfigurationsparameters in der Form name=wert. -Details zum Aufbau einer Java -Properties Datei finden Sie in der API-Dokumentation zu -Ihrem Java JDK, beispielsweise hier. -

-

3.1.1 -Parameter für den MOA SS Signaturerstellungsrequest 

- - - -
Namelocation.schema.moa
Erläuterung

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.

Der Konfigurationsparameter muss als -Wert einen Pfad -enthalten, der mit / beginnt, und der vom -E-Recht Signaturclient für MOA SS als relativ zum Context -Root -der Webapplikation interpretiert wird.
Beispiel

/WEB-INF/classes/resources/schemas/MOA-SPSS-1.3.xsd

-
- - - -
Namelocation.ss.stylesheet
Erläuterung

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.

-

Der Konfigurationsparameter muss als -Wert einen Pfad -enthalten, der mit / beginnt, und der vom -E-Recht Signaturclient für MOA SS als relativ zum Context -Root -der Webapplikation interpretiert wird.
Beispiel

/static/erecht.stylesheet.1-9-0.xsl

-
- - - -
Namelocation.ss.requestTemplate
Erläuterung

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.

Der -Konfigurationsparameter muss als -Wert einen Pfad -enthalten, der mit / beginnt, und der vom -E-Recht Signaturclient für MOA SS als relativ zum Context -Root -der Webapplikation interpretiert wird.
Beispiel

/WEB-INF/classes/resources/templates/CreateRequest.xml

-

3.1.2 -Parameter der verwendeten MOA SS Installation

- - - -
Nameservice.ss.endpoint
Erläuterung

Mit -diesem Konfigurationsparameter wird dem E-Recht -Signaturclient für MOA SS der -Zugangspunkt zum Webservice von MOA SS mitgeteilt.

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.

Beispiel

http://localhost:8081/moa-spss/services/SignatureCreation

-
- - -
Nameservice.ss.keyIdentifier
Erläuterung

Mit -diesem Konfigurationsparameter wird dem E-Recht -Signaturclient für MOA SS -mitgeteilt, welchen Schlüsselbezeichner er im -Signaturerstellungsrequest -an MOA SS verwenden soll.

Der -Konfigurationsparameter muss den Bezeichner eines in -MOA SS hinterlegten Schlüsselbezeichner enthalten.

Beispiel

KG_allgemein

-

3.1.3 -Adressierung des Servlet Containers des E-Recht Signaturclients

- - - -
Namelocation.webAppHostPort
Erläuterung

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, vom Benutzer erreicht werden kann.

-

Der -Konfigurationsparameter muss eine URL sein, die ausschließlich die -Komponenten Protokoll (also in der Regel http), -Hostname (z.B. localhost) und Portnummer -(z.B. 8084) enthält.

Beispiel

http://localhost:8084

-
- - - -
Namelocation.webAppHostPortFromMOASS
Erläuterung

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, von MOA SS erreicht werden kann.

-

Der -Konfigurationsparameter muss eine URL sein, die ausschließlich die -Komponenten Protokoll (also in der Regel http), -Hostname (z.B. localhost) und Portnummer -(z.B. 8084) enthält.

Beispiel

http://localhost:8084

-
-

3.1.4 -Arbeitsverzeichnis

- - - -
Namelocation.tempdir
Erläuterung

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. 

Der -Konfigurationsparameter muss als Wert -einen Pfad -enthalten, der vom E-Recht Signaturclient für MOA SS als relativ zum Context -Root der Webapplikation interpretiert wird. Der angegebene -Pfad muss einen abschließenden / -aufweisen und im Dateisystem tatsächlich existieren.

Beispiel

/workdir/temp/

-

3.2 -Layout der Benutzeroberfläche

-

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.

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 $MOA_SL_WEBAPP/pages (UploadXML.jsp, UploadImages.jsp, DownloadSignature.jsp sowie Error.jsp). 

- -

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 jsp -gekennzeichnet sind (z.B. <jsp:useBean> -oder <jsp:getProperty>, oder -Bereiche die mit der Kennzeichnung <% -eingeleitet bzw. mit der Kennzeichnung %> -ausgeleitet werden.

-

\ 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 deleted file mode 100644 index 6ead1bd1c..000000000 Binary files a/erecht.client.ss/handbook/system/images/Zusammenspiel.VSD and /dev/null differ diff --git a/erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png b/erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png deleted file mode 100644 index 4e7fcda67..000000000 Binary files a/erecht.client.ss/handbook/system/images/Zusammenspiel.mit.png and /dev/null differ diff --git a/erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png b/erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png deleted file mode 100644 index 0dc944cb9..000000000 Binary files a/erecht.client.ss/handbook/system/images/Zusammenspiel.ohne.png and /dev/null differ diff --git a/erecht.client.ss/handbook/system/images/Zusammenspiel.png b/erecht.client.ss/handbook/system/images/Zusammenspiel.png deleted file mode 100644 index 16199e4a5..000000000 Binary files a/erecht.client.ss/handbook/system/images/Zusammenspiel.png and /dev/null differ 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 @@ - - - - - - - - MOA SL - Systemhandbuch - - -
Logo BKA E-Recht

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

Systemhandbuch

- -
-

Inhalt

- -
    - -
  1. -

    Einführung

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

    1 -Einführung

    - -

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

    - -

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

    - -

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

    - -

    2 -Überblick

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

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

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

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

    3 -Komponenten

    - -

    3.1 -Das Servlet Dispatcher

    - -

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

    3.2 -Die JSP-Seiten

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

    3.3 Die Klasse MOAInvoker

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

    3.4 Die Klasse RequestBuilder

    - -

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

     Im Wesentlichen umfasst die Klasse folgende Funktionen:

    3.5 -Der Deployment Descriptor web.xml

    -

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

    - - -

    4 -Zusammenspiel der Komponenten

    - - -

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

    -

    Zusammenspiel der Komponenten - Basisablauf

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