===============================================================
==  Informationen zu den Beispielen                          ==
===============================================================

Hier finden Sie einen berblick ber den Inhalt der Verzeich-
nisse mit entsprechenden Beispielen fr das OSCI2-StarterKit.

===============================================================
Vorbedingungen
===============================================================

Zur Ausfhrung der Beispiele mssen folgende Vorbedingungen er-
fllt sein:
 - Installation der Entwicklungsumgebung Eclipse(TM) -
   Download von http://www.eclipse.org
 - Installation von Apache Ant (optional fr den Start aus der
   Konsole)
 - Entpacktes OSCI2-StarterKit.zip in einem Verzeichnis
   (z.B."OSCI2-StarterKit")
 - Installation des Metro Frameworks - Download von
   https://metro.dev.java.net/2.0/ - zu entpacken in Verzeich-
   nis "OSCI2-StarterKit/lib" und entsprechend der Anleitung
   von SUN einzurichten.
 - Anlegen eines Verzeichnisses "OSCI2-StarterKit/samples", in
   welches das OSCI2-Samples.zip entpackt werden muss.
 - Des Weiteren wird die Java API fr XML WS in der Version 2.2
   bentigt. Dafr muss ein Verzeichnis "endorsed" im benutzten
   Java JDK unter "jre/lib/" angelegt werden; in dieses Ver-
   zeichnis ist die Datei webservices-api.jar aus
   "OSCI2-StarterKit/lib/metro/lib/" zu kopieren.

===============================================================
Hinweise zur Entwicklungsumgebung
===============================================================

Sie knnen jede Entwicklungsumgebung nutzen. Die mitgelieferten
Beispiele und Apache Ant-Skripte wurden mit der Eclipse(TM) IDE
in der Version 3.4 getestet. Die mitgelieferten Apache Ant-
Skripte (build.xml) sollten mit Apache Ant 1.7.X ausgefhrt
werden.

===============================================================
Ausfhren der Beispiele
===============================================================

Je nach Anwendungsfall existieren im Verzeichnis
"OSCI2-StarterKit/samples" verschiedene Beispiele, die thema-
tisch sortiert jeweils ein Ant build.xml enthalten, welches
mittels Eclipse(TM) eingebunden werden kann. Die build.xml-Da-
teien knnen auch direkt von der Konsole aus gestartet werden.

Zum Ausfhren der Beispiele starten Sie Eclipse(TM) und fhren
folgende Schritte durch:
 1. Menpunkt File -> New -> Project... whlen
 2. Im Dialog "New Project/Select a wizard" Eintrag "Java
    Project from Existing Ant Buildfile" auswhlen; Button
    "Next >" bettigen
 3. Im Dialog "New Project/Create a Java Project from an Ant
    Buildfile" Button "Browse" bettigen
 4. build.xml der gewnschten Beispiele auswhlen und be-
    sttigen (z.B. OSCI2-StarterKit/samples/ClientScenarios)
 5. Checkbox "Link to the buildfile in the system" auswhlen;
    Button "Finish" bettigen
 6. Properties des projects auswhlen, Eintrag "Java Build
    Path" - Reiter "Libraries" auswhlen - mittels Button
    "Add Library" "JRE System Library" einbinden; Button
    "Next >" bettigen, JRE auswhlen und Button "Finish"
    bettigen. Properties-Dialog schlieen
 7. Ausfhren des "all" target (default) im build.xml
    (mittels des ant view)
 8. Refresh des projects ausfhren
 9. Ausfhren der "run" targets
Die Schritte 7. und 8. sind optional und nicht unbedingt
erforderlich.

Die zu verwendende MessageBox ist in den Beispielen ent-
sprechend eingetragen, kann aber auch ber die Webseite
www.osci.de ermittelt werden.

===============================================================
Anmerkungen:
===============================================================

Die Funktionen des OSCI2-StarterKit sind in der Funktionsbe-
schreibung:
OSCI2-StarterKit/Funktionsbeschreibung_OSCI2_StarterKit.pdf
und in der API-Doc (OSCI2-StarterKit/api-doc) beschrieben.

Falls Sie die API-Doc in Eclipse(TM) einbinden wollen, gehen
Sie wie folgt vor:
 1. Klicken Sie mit der rechten Maustaste auf das Projekt und
    whlen im Kontext-Men den Punkt "Properties" aus.
 2. Whlen Sie im Dialog "Properties for ..." auf der linken
    Seite "Java Build Path" aus.
 3. Auf der rechten Seite des Dialogs "Properties for ..."
    den Reiter "Libraries" auswhlen.
 4. Klicken Sie auf das "+" des OSCI2-StarterKit.jar, whlen
    Sie "Javadoc location..." und klicken Sie auf "Edit".
 5. Im folgenden Dialog geben Sie im oberen Feld (Javadoc
    URL/Javadoc location path) den Pfad der API-Doc an (z.B.
    file:/C:/OSCI2-StarterKit/api-doc/).
 6. Besttigen Sie die Dialoge.

===============================================================
Verzeichnis-bersicht
===============================================================

Im Verzeichnis "OSCI2-StarterKit/samples" befinden sich folgen-
de weitere Unterverzeichnisse und Dateien:

 - "Overview.txt" - diese Datei
 - "ClientScenarios", "ServerScenarios" - thematisch zusammen-
   gefasste Beispiele
 - "environment" - bergeordnete Dateien, die von allen Bei-
   spielen benutzt werden (Konfigurationsdateien, Zertifikate)

===============================================================
Beschreibung der Beispiele
===============================================================

Im Folgenden werden kurz die thematisch sortierten Beispiele
erlutert.

- ClientScenarios
  Mit diesen Szenarien knnen einfache Beispiele zum Senden und
  Empfangen von OSCI 2-Nachrichten nachvollzogen werden. Es
  werden Inhaltsdaten im "LetterStyle" zusammengestellt,
  signiert und verschlsselt. Diese Nachrichten knnen dann so-
  wohl synchron als auch asynchron gesendet werden.
- ServerScenarios
  Dieses Szenario ist fr Entwickler eines synchronen Backends
  von Bedeutung. Es wird gezeigt, wie das Web-Service-Framework
  benutzt wird, um OSCI 2-Nachrichten synchron anzunehmen, zu
  prfen und Antworten zu generieren.

===============================================================
Beschreibung der Konfiguration
===============================================================

Zur Konfiguration der Beispiele und des Metro Frameworks muss
die Datei wsit-client.xml benutzt werden (zu finden im Ver-
zeichnis OSCI2-StarterKit/environment/conf/client/META-INF).
In dieser Datei sind weitere Kommentierungen enthalten, welche
die Konfigurationsmglichkeiten beschreiben.

===============================================================
==  Informationen zu den Beispielen                          ==
===============================================================