trunk/pdf2xfa/README.TXT

PDF-XFA-Extraktion-Server:

Es wird eine aktuelle Version von iText benötigt!
Homepage: http://www.lowagie.com/iText/
Die Bibliothek ist im lib Verzeichnis zu hinterlegen.

$ wget -O lib/itext-2.0.6.jar http://prdownloads.sourceforge.net/itext/itext-2.0.6.jar

1 - Kompilieren des Servers:

    $ bin/compile.sh src/de/intevation/pdfimport/Server.java

2 - Bauen des Produktiv-Jars:

    Der Server muss mit 1 kompiliert werden.

    $ bin/build-jar.sh

    Danach sollte eine Datei pdf2xfa.jar entstanden sein.

3 - Ausführen des Servers (für Entwicklung):

    $ bin/run.sh de.intevation.pdfimport.Server

    startet den Server auf Port 1111. Der Zugriff
    ist auf localhost beschränkt.

4 - Ausführen des Servers (produktiv):

    Es werden pdf2xfa.jar und lib/itext-2.0.6.jar in folgender
    Verzeichnisstruktur benötigt:

    pdf2xfa.jar
    lib/itext-2.0.6.jar

    $ java -jar pdf2xfa.jar

    Unter ./startup finden sich zwei Skripte, die in einen
    GNU/Linux-Boot-Prozess integriert werden können. 
    TODO: Genauere Beschreibung

Folgende  System-Properties (-D) werden unterstützt:

* port=<Port-Nummer>: Port auf dem der Server
  laufen soll. Default: 1111
    
* allowed.ips=<Komma getrennte Liste mit Rechner>:
  Liste von Rechneradressen, die Zugriff auf den
  Dienst haben sollen. Default: 'localhost'

* extract.parts=<Komma getrennte Liste>: Liste von 
  Unterbäumen, die aus dem XFA-Teil des PDFs extrahiert 
  werden sollen. Default: 'xfa:data'

* root.element=<Knotenname des Wurzelelementes>: Die
  Teilbäume, die mittels 'extract.parts' gefunden werden,
  werden unter einem Wurzeknoten dieses Namens im Ergebnis-XML
  eingehängt. Default: 'root'

* log.dir=<Verzeichnis>: Name eines Verzeichnisses, in
  dem die Log-Dateien des Servers gespeichert werden sollen.
  Standmäßig werden die Log-Nachrichtern nach stderr 
  ausgegeben.


Test:

$ export PDF=ausgefuelltes.pdf

$ (stat --format="%s " $PDF; cat $PDF) | nc localhost 1111

1	teichmann	201	PDF-XFA-Extraktion-Server:
2
3			Es wird eine aktuelle Version von iText benötigt!
4			Homepage: http://www.lowagie.com/iText/
5			Die Bibliothek ist im lib Verzeichnis zu hinterlegen.
6
7			$ wget -O lib/itext-2.0.6.jar http://prdownloads.sourceforge.net/itext/itext-2.0.6.jar
8
9	teichmann	208	1 - Kompilieren des Servers:
10	teichmann	201
11	teichmann	208	$ bin/compile.sh src/de/intevation/pdfimport/Server.java
12	teichmann	201
13	teichmann	208	2 - Bauen des Produktiv-Jars:
14	teichmann	201
15	teichmann	208	Der Server muss mit 1 kompiliert werden.
16	teichmann	201
17	teichmann	208	$ bin/build-jar.sh
18	teichmann	201
19	teichmann	208	Danach sollte eine Datei pdf2xfa.jar entstanden sein.
20
21			3 - Ausführen des Servers (für Entwicklung):
22
23			$ bin/run.sh de.intevation.pdfimport.Server
24
25			startet den Server auf Port 1111. Der Zugriff
26			ist auf localhost beschränkt.
27
28			4 - Ausführen des Servers (produktiv):
29
30			Es werden pdf2xfa.jar und lib/itext-2.0.6.jar in folgender
31			Verzeichnisstruktur benötigt:
32
33			pdf2xfa.jar
34			lib/itext-2.0.6.jar
35
36			$ java -jar pdf2xfa.jar
37
38	teichmann	220	Unter ./startup finden sich zwei Skripte, die in einen
39			GNU/Linux-Boot-Prozess integriert werden können.
40			TODO: Genauere Beschreibung
41
42	teichmann	201	Folgende System-Properties (-D) werden unterstützt:
43
44			* port=<Port-Nummer>: Port auf dem der Server
45			laufen soll. Default: 1111
46
47			* allowed.ips=<Komma getrennte Liste mit Rechner>:
48			Liste von Rechneradressen, die Zugriff auf den
49			Dienst haben sollen. Default: 'localhost'
50
51			* extract.parts=<Komma getrennte Liste>: Liste von
52			Unterbäumen, die aus dem XFA-Teil des PDFs extrahiert
53			werden sollen. Default: 'xfa:data'
54
55	teichmann	221	* root.element=<Knotenname des Wurzelelementes>: Die
56			Teilbäume, die mittels 'extract.parts' gefunden werden,
57			werden unter einem Wurzeknoten dieses Namens im Ergebnis-XML
58			eingehängt. Default: 'root'
59
60	teichmann	219	* log.dir=<Verzeichnis>: Name eines Verzeichnisses, in
61			dem die Log-Dateien des Servers gespeichert werden sollen.
62			Standmäßig werden die Log-Nachrichtern nach stderr
63			ausgegeben.
64
65	teichmann	221
66	teichmann	201	Test:
67
68			$ export PDF=ausgefuelltes.pdf
69
70	teichmann	208	$ (stat --format="%s " $PDF; cat $PDF) \| nc localhost 1111
71	teichmann	201