From 1da9cc31f03389234cd545433e0bde4c872046f6 Mon Sep 17 00:00:00 2001 From: ulrich@undisclosed Date: Sun, 03 May 2020 08:15:53 +0000 Subject: [PATCH] Links in Doku angepasst --- README.md | 66 ++++++++++++++++++++++++++++++++ 1 files changed, 65 insertions(+), 1 deletions(-) diff --git a/README.md b/README.md index e7a9e8f..3c2f619 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,68 @@ # Transit -Alle Informationen unter [](http://wb.uhilger.de/dok/ulrich/Software/Libs/Transit/Transit) \ No newline at end of file +Java-Code auf einem Server lässt sich mit Transit ohne statische Annotationen +via Ajax rufen. Ein einfacher Uniform Resource Locator (URL) wie der folgende genügt: + +`http://example.com/package.klasse/methode/format/param1/param2/../paramN` + +Weitere Informationen auf der [Produktseite](/data/pg/transit/) + +## Voraussetzungen + +Zur Herstellung und Nutzung von Transit werden ein Java Development Kit (JDK) und +der Quellcode von Transit benötigt. Das JDK ist z.B. von [Azul](http://azul.com) oder +dem [OpenJDK-Projekt](http://openjdk.java.net/) frei erhältlich. In der hier folgenden +weiteren Beschreibung wird der lokale Ablageort des Java Development Kits `$JDK` +genannt. Desweiteren werden die folgenden Klassenbibliotheken benötigt: + +``` +Bibliothek Datei(en) Ablageort lokal +---------- --------- --------------- +XStream ............. xstream-1.4.7.jar ............. $JLIB +Jettison ............ jettison-1.3.3.jar ............ $JLIB +``` + +Diese sind an folgenden Orten frei erhältlich: + +- [XStream](https://x-stream.github.io/) +- [Jettison](http://repo.maven.apache.org/maven2/org/codehaus/jettison/jettison/1.2/jettison-1.2.jar) +- [XStream auf Github](https://github.com/codehaus/xstream) +- [Jettison auf Github](https://github.com/codehaus/jettison) + +## Transit erhalten + +Der Quellcode von Transit wird von hier an einen frei wählbaren lokalen Ablageort +[heruntergeladen](/gitblit/zip/?r=Transit.git&format=zip) und entpackt. In der hier +folgenden weiteren Beschreibung wird das so entstandene Verzeichnis `Transit` einschließlich +des absoluten Pfades dorthin `$TRANSIT` genannt. Anstelle von `$TRANSIT` würde man also +beispielweise `/home/fred/Transit` notieren, wenn in das persönliche Verzeichnis des +Benutzers `fred` heruntergealden und entpackt wurde. Ferner wird angenommen, dass die +oben aufgeführten Klassenbibliotheken lokal an Orten abgelegt sind, deren Pfade mit dem +Platzhalter `$JLIB` gemeint ist. Anstelle des Platzhalters muss in den folgenden Kommandos +also der absolute Pfad des lokalen Ablageortes eingesetzt werden. + +## Klassenbibliothek herstellen + +Transit ist zur Nutzung im Zusammenspiel mit anderen Programmen vorgesehen und wird dazu am besten als +Klassenbibliothek genutzt. Zur Herstellung einer Klassenbibliothek werden mit Hilfe der wie zuvor beschrieben +geladenen Teile die folgenden Kommandos ausgeführt (Beispiel für Linux): + +``` +cd $TRANSIT +mkdir classes +mkdir dist + +$JDK/bin/javac -classpath $JLIB/jettison-1.3.3.jar:$JLIB/xstream-1.4.7.jar -d classes src/de/uhilger/transit/*.java src/de/uhilger/transit/test/*.java src/de/uhilger/transit/web/*.java + +$JDK/bin/jar -cf dist/Transit.jar -C classes . +rm -r classes +``` + +Die fertig verwendbare Klassenbibliothek liegt anschließend unter `$TRANSIT/dist/Transit.jar`. + +## Klassenbibliothek verwenden + +Zur Verwendung der Klassen von Transit wird die Klassenbibliothek in den Classpath des Programmes +aufgenommen, von dem aus Transit genutzt werden soll. Details zur Nutzung von Transit sind in +der [Anleitung](/data/pg/transit/anleitung.adoc) beschrieben. \ No newline at end of file -- Gitblit v1.9.3