Entwicklerhandbuch Kernprüfung

Transkript

1 Seite: 1 Entwicklerhandbuch en aufbauend auf -Basis-Version

2 Seite: 2 Inhaltsverzeichnis Inhaltsverzeichnis... 2 Einleitung... 3 Systemvoraussetzungen... 3 Module... 3 KernpruefungAufruf... 3 KernpruefungRoutingProgrammSv (KRIPS)... 3 KernpruefungBasisAPI... 4 KernpruefungBasis... 4 KernpruefungBasisFachlichePruefungen... 4 Datensatzaufbereitung... 4 KernpruefungXX Implementierung... 4 Fehlertexte... 5 Struktur... 5 Prüfungskonfiguration... 5 Allgemeine Informationen... 5 Inbetriebnahme... 5 Drittabhängigkeiten... 5 Aufruf... 6 Beispiel Aufruf ohne Krips... 6 Beispiel Aufruf mit Krips

3 Seite: 3 Einleitung Die ist eine Java SE Anwendung, mit der XML-Datensätze und Datensätze fixer Länge validiert werden können. Als Ergebnis kommt ggf. eine Liste fachlicher Fehler zurück. Die en wurden so umgestellt, dass alle en eine gemeinsame Basis haben. Dies ist die Voraussetzung für eine hohe Wiederverwendbarkeit sowie eine leichte und schnelle Implementierung und Konfiguration neuer en. Ziel dieses Dokumentes ist es einen groben Überblick über die Module der zu ermöglichen sowie Tipps für die korrekte Installation zu geben. Systemvoraussetzungen Die wurde mit Java SE in der Version 6 implementiert. Voraussetzung ist also eine JRE Version 6 oder höher. Module Die en bestehen aus mehreren Modulen, die in einzelne Jars paketiert wurden. KernpruefungAufruf In KernpruefungAufruf ist das von der zu implementierende Interface kernpruefung.kernpruefung sowie Hilfsklassen enthalten. KernpruefungRoutingProgrammSv (KRIPS) Mit dem KRIPS wird ein zentraler Aufruf aller einzelnen Datenstruktur-en zur Verfügung gestellt. Dabei routet er alle in Ihm registrierten Datenstrukturen an die entsprechende Datenstruktur- weiter. Unbekannte Datenstrukturen werden von Ihm mit einem RC 5 und einer qualifizierten Fehlermeldung abgewiesen. 3

4 Seite: 4 KernpruefungBasisAPI In KernpruefungBasisAPI sind das Modell der sowie die groben Strukturen abgelegt. Hier befinden sich auch die technischen Basisprüfungen, die für die einzelnen Feldprüfungen verwendet werden können. KernpruefungBasis In KernpruefungBasis ist die Ablauflogik implementiert. Hier wird die konkrete simplementierung mit den Basisprüfungen verknüpft und weitere Validierungsprüfungen ausgeführt. KernpruefungBasisFachlichePruefungen In KernpruefungBasisFachlichePruefungen sind fachliche Prüfungen definiert. Z.B. Prüfungen für den Vornamen oder dem Nachnamen. Dieses Modul ist dafür da, damit in Zukunft gleiche Felder exakt gleich geprüft werden und nicht mehrfach implementiert werden müssen. Datensatzaufbereitung Die Datensatzaufbereitung ist eine Bibliothek, die auch außerhalb der zum Einsatz kommt. Hierbei wird ein Datensatz mit fester Länger über eine XML-Konfiguration eingelesen und aufbereitet ausgegeben. Die macht sich dies zu Nutze und verwendet den Parse-Algorithmus aus diesem Modul. Es werden die Jars datensatzaufbereitung-api sowie datensatzaufbereitung-xml-parser verwendet. KernpruefungXX Das letzte Modul ist die konkrete. Diese baut auf den anderen Modulen auf. Idealerweise hält sich die Implementierung in Grenzen. Die Prüfungen werden durch XML- Dateien konfiguriert. Folgende Dateien sind notwendig: -Implementierung Es ist eine Java-Klasse notwendig, die entweder von AbstractKernpruefungXml oder von AbstractKernpruefungFixLength erbt. Hier sind die Pfade zu den Fehlertexten, der Prüfungskonfiguration sowie der Struktur zu setzen. 4

5 Seite: 5 Fehlertexte Die Fehlertexte werden in einer Properties-Datei abgelegt. Dabei ist die Fehlernummer der Key und der Fehlertext der Value, z.b.: DXAA001=DXAA001 Absendernummer fehlerhaft Struktur Bei der Struktur ist zu unterscheiden, ob es sich um eine XML- oder eine mit festen Längen handelt. Bei der XML- sind die Schema-Dateien (.xsd) mit anzugeben, damit eine Schemavalidierung durchgeführt werden kann. Bei der mit festen Längen ist der Aufbau des Datensatzes mit einer XML-Datei anzugeben. Prüfungskonfiguration Die Konfiguration ist bei beiden sarten identisch und ist in Form einer XML- Konfiguration anzugeben. Allgemeine Informationen Alle Konfigurationsdateien (Fehlertexte, Struktur und Prüfungskonfiguration) sind in den Klassenpfad zu legen. Es ist zu beachten, dass mehrere en zusammen in demselben Klassenpfad liegen können. Es ist also zu empfehlen die Konfigurationsdateien in einen Unterordner zu packen, der z.b. die eindeutige Kennung des Datensatzes sein kann. Inbetriebnahme Drittabhängigkeiten Die -Basis-Module haben folgende Bibliotheken als Abhängigkeiten, die mit in den Klassenpfad zu nehmen sind: annotations jar commons-io-2.4.jar commons-lang3-3.5.jar commons-pool jar guava-20.0.jar javassist ga.jar log4j jar 5

6 Seite: 6 reflections jar Saxon-HE jar slf4j-api jar slf4j-log4j jar Alle Bibliotheken werden zusammen mit der ausgeliefert. Aufruf Die implementiert das Interface kernpruefung.kernpruefung. Dieses hat genau eine Methode: Rueckgabe pruefe(string datensatz, String vorlaufsatz); Der werden der Datensatz und der Vorlaufsatz übergeben. Die Rueckgabe hat folgende Methoden: Der ReturnCode kann folgende Werte besitzen: 0 = keine Fehler, erfolgreiche Prüfung 1 = es gibt Hinweise 2 = es gibt Fehler 3 = es gibt Hinweise und Fehler 4 = technischer Fehler 5 = Fehler bei der Verarbeitung im KRIPS 6 = Fehler bei der Schemavalidierung (nur XML-en) Bei ReturnCode 1-3 und 5 können die Hinweise und/oder Fehler über getrueckgabemeldungen abgerufen werden. Beispiel Aufruf ohne Krips Die A1- AntragEntsendung kann z.b. folgendermaßen aufgerufen werden: String datensatz = ; String vorlaufsatz = ; Kernpruefung kp = new KernpruefungA1AntragEntsendung(); 6

7 Seite: 7 Rueckgabe rueckgabe = kp.pruefe(datensatz, vorlaufsatz); System.out.println(rueckgabe.getReturnCode()); for (String rm : rueckgabe.getrueckgabemeldungen()) { System.out.println(rm); } Beispiel Aufruf mit Krips Alle en können zentral über den KRIPS folgendermaßen aufgerufen werden: String datensatz = ; String vorlaufsatz = ; Kernpruefung kp = KripsImpl.getInstance(); Rueckgabe rueckgabe = kp.pruefe(datensatz, vorlaufsatz); System.out.println(rueckgabe.getReturnCode()); for (String rm : rueckgabe.getrueckgabemeldungen()) { System.out.println(rm); } 7