FAQ
Warum sollte ich als Fachverfahrensentwickler eine Bibliothek einsetzen, wenn die Directory-Schnittstelle doch veröffentlicht ist und auch direkt angesprochen werden könnte?
Die DVDV-Bibliothek bietet einen einfachen Zugang auf das Deutschen Verwaltungsdiensteverzeichnis. Sie bietet insbesondere die folgenden Mehrwerte für Sie:
- Für den Zugriff auf die Schnittstelle ist eine Authentifizierung entweder am IAM/Keycloak oder direkt am DVDV-Server mittels eines JWT notwendig. Hier wird von der Authentifizierungsschnittstelle jeweils ein bestimmter Tokenaufbau erwartet. Die Bibliothek erstellt für Sie ein funktionierendes Token aus den übergebenen Parametern.
- In den Bibliotheken ist eine komplexe Failover-Logik implementiert. Je nach HTTP-Response kann ein fachlicher oder ein technischer Fehler vorliegen. Nur bei technischen Fehlern will man einen Failover zum Vertretungsserver auslösen. Hier unterscheidet eine dedizierte Logik zwischen diesen beiden Fehlerarten und setzt den Failover nur in begründeten Fällen um. Die Bibliothek erhält den Failover-Zustand einen für definierten Zeitraum und überprüft in regelmäßigen Abständen die Erreichbarkeit des primären Servers.
- Ein Aufruf der DVDV2-Directory-Schnittstelle und eine Aufbereitung der Service-Antwort in einem dedizierten Datenmodell ist umgesetzt.
Welche der im FITKO-GitLab veröffentlichten Projekte sind für mich als Fachverfahrensentwickler von Interesse?
Als Fachverfahrensentwickler sollten Sie sich die folgenden Projekte anschauen. Die Links zu diesen Artefakten bekommen Sie nach einer Registrierung am Newsletter.
- DVDV-.NET-Bibliothek bzw. DVDV-Java-Bibliothek, je nach Technologie zur Einbindung in ihr Fachverfahren.
- Beispiele dvdv-dotnet-controlfile, dvdv-java-controlfile dvdv-java-simple je nach Technologie zur Veranschaulichung der Bibliotheksnutzung und Koinfiguration
- Beispiel dvdv-python-simple zur Nutzung der DVDV-Directory-Schnittstelle ohne eine Bibliothek, Falls sie eine andere Technologie als Java oder .NET einsetzen.
Die anderen Projekte DVDV API, DVDV Microservice FIT-Connect API, Dokumentation sind für Sie nicht von Interesse und können ignoriert werden.
Warum liegen in der Paket-Registry für die DVDV-Bibliotheken in Java und .NET teilweise neuere Bibliotheksversionen mit den Suffixen "-RCx" oder "-SNAPSHOT", wo finde ich die Dokumentation und die Releasehinweise zu diesen Versionen?
Diese Versionen werden aus technischen Gründen (z.B. Test und Freigabe) bereits im Entwicklungsprozess der Bibliotheken erstellt. Nach der offiziellen Freigabe einer neuen Version durch den Auftraggeber wird auch die Dokumentation und die Änderungshistorie für diese Version veröffentlicht. Die Freigabe einer neuen Version wird immer im Newsletter angekündigt. Bis dahin gelten diese Versionen als "unsupported" und können von Ihnen gern für Tests und zur Anschauung genutzt werden. Einen produktiven Einsatz empfehlen wir ausdrücklich nicht.
Die Bibliotheken und Beispiele werden unter der EUPL-Lizenz (https://eupl.eu/) veröffentlicht. Hat diese nicht einen schwachen Copyleft-Effekt? Können wir den Code der Beispiele und die Bibliothek unbedenklich in unserer Software einsetzen?
Die DVDV-Bibliotheken und die Beispiele sind dazu bestimmt, die Anbindung einer Fachverfahrenssoftware an die DVDV-Infrastruktur zu ermöglichen. Hierfür soll die DVDV-Bibliothek in die Fachverfahrenssoftware integriert werden. Erfolgt die Integration der DVDV-Bibliothek in unveränderter Form, liegt keine Bearbeitung im Sinne der EUPL bzw. des deutschen Urheberrechts vor. Die Art und Weise der Verlinkung der DVDV-Bibliothek innerhalb einer Fachverfahrenssoftware führt insbesondere nicht zur Schaffung eines abgeleiteten Werkes. Die unveränderte Übernahme der DVDV-Bibliothek in eine Fachverfahrenssoftware führt damit nicht dazu, dass die Fachverfahrenssoftware unter den Bedingungen der EUPL zu lizenzieren ist. Für die Weitergabe von Bibliothek oder Beispielen selbst, in unveränderter oder bearbeiteter Form, als Quellcode oder ausführbares Programm, gelten die Lizenzbedingungen der EUPL in unveränderter Weise. Eine Übernahme von Codeabschnitten aus den Beispielen in die eigene Software ist dabei unbedenklich und führt ebenso nicht zur Schaffung eines abgeleiteten Werkes.