EPICUR-Uniform Resource Name (URN)-Generator

Transkript

1 EPICUR-Uniform Resource Name (URN)-Generator Technische und Anwenderdokumentation der Dienstleistungen des EPICUR-URN-Generators Autoren: Kathrin Schroeder, Andreas Roth Version: Stand: Seite 1 von 7

2 Inhaltsverzeichnis 1. Ziel des Dokumentes Leistungsmerkmale des URN-Generators Algorithmus des URN-Generators Syntax Demonstration des URN-Generators Web-Interface 1: Formularbasierter Request mit Übernahme in ein Web- Formular Web-Interface 2: Konfigurierbarer Request mit spezifizierbaren Ausgabeformaten in HTML, XML XML-Ausgabeformat auf einen HTTP-Request Beschreibung des Ausgabeformates XML des URN-Generators Grundstruktur mit Header Ausgabe von 3 reservierten URNs Ausgabe mit Fehlercode Error_Codes Ziel des Dokumentes Das folgende Dokument beinhaltet eine technische und Anwenderdokumentation des EPICUR- Uniform-Resource-Name-(URN)-Generators, mit dem URNs (NBN:DE) generiert und reserviert werden können (Ausgabeformat konfigurierbar). 2. Leistungsmerkmale des URN-Generators Der URN-Generator generiert nach einem definierten Algorithmus über einen HTTP-GET oder HTTP- Post-Requests URNs und reserviert diese. Die URN-Reservierung erfolgt abhängig vom URN- Unternamensraum. Es existiert ein Standardverhalten. Zusätzlich sind die Requests durch folgende Serviceparameter konfigurierbar: URN-Unternamensraum Anzahl der zu generierenden / reservierenden URNs Ausgabeformat (HTML, XML) Die Request können in HTML oder XML ausgegeben werden und können über das Web-Interface manuell ausgeführt als auch automatisiert werden. Bei Syntax- oder logischen Fehlern wird eine Fehlermeldung erzeugt. Seite 2 von 7

3 3. Algorithmus des URN-Generators URNs werden nach dem folgenden Algorithmus generiert: urn:nbn:de:[snid]-jjjmmdd[fortlaufende Nummer][Prüfziffer] Beispiel urn:nbn:de: Syntax Im Folgenden wird die Syntax der Serviceparameter zur Konfigurierbarkeit des Antwortverhaltens des EPICUR-Resolvers dargestellt. Ein Request an den URN-Generator wird in folgender Form strukturiert. Beispiel id = Producer_ID pw = Password nid = Namespace oder Sub-namespace num = Anzahl format = Ausgabeformat (xml oder html) Seite 3 von 7

4 5. Demonstration des URN-Generators Im Folgenden wird durch Screenshots das Verhalten des URN-Generators demonstriert Web-Interface 1: Formularbasierter Request mit Übernahme in ein Web- Formular 5.2. Web-Interface 2: Konfigurierbarer Request mit spezifizierbaren Ausgabeformaten in HTML, XML Seite 4 von 7

5 5.3. XML-Ausgabeformat auf einen HTTP-Request Beispiel: at=xml 6. Beschreibung des Ausgabeformates XML des URN-Generators Das XML-Ausgabeformat des EPICUR-Resolvers basiert auf xepicur. Folgende Änderungen sind erfolgt: - Das Element <header> anstelle von <administrative_data> - Das Element <header> subsummiert 5 weitere Unterelemente - <responsedate> - <request_id> - <request_nid> - <request_num> - <request_format> - Dem Element <identifier> wurde das Attribut state mit dem Wert reserved hinzugefügt. Grundstruktur Seite 5 von 7

6 6.1. Grundstruktur mit Header <header> <responsedate> t10:30:21z</responsedate> <request_id>schroeder</request_id> <request_nid>urn:nbn:de:0002</request_nid> <request_num>3</request_num> <request_format>xml</request_format> </header> [...] In den Elementen <request_id>, <request_nid>, <request_num>, <request_format> werden die an den URN-Generator gesendeten Parameter zurückgeliefert. Mit <responsedate> wird die Serverantwortdatumszeit gesetzt. Das Datumszeitformat ist yyyy-mm-ddthh:mm:ssz yyyy : MM : dd : hh : mm : ss : = Jahr, vierstellig = Monat, zweistellig mit führender Null = Tag, zweistellig mit führender Null = Stunde, zweistellig mit führender Null = Minute, zweistellig mit führender Null = Sekunde, zweistellig mit führender Null 6.2. Ausgabe von 3 reservierten URNs <header> <responsedate> t10:30:21z</responsedate> <request_id>schroeder</request_id> <request_nid>urn:nbn:de:0002</request_nid> <request_num>3</request_num> <request_format>xml</request_format> </header> <record> <identifier scheme="urn:nbn:de:0002" state="reserved">urn:nbn:de: </identifier> <identifier scheme="urn:nbn:de:0002" state="reserved">urn:nbn:de: </identifier> <identifier scheme="urn:nbn:de:0002" state="reserved">urn:nbn:de: </identifier> </record> Das Element <request_num> beinhaltet die Anzahl der zu generierenden URNs, mit <request_nid> wird der URN-Unternamensraum angegeben, <request_id> dient der Authentisierung, das Ausgabeformat wird mit <request_format> bezeichnet. Das Element <record> bildet den Container für die zu reservierenden URNs. Diese werden mit <identifier scheme= [URN-Unternamensraum] state= reserved > deklariert. Seite 6 von 7

7 6.3. Ausgabe mit Fehlercode Fehlerausgaben werden als Content des Elements <error> mit dem Attribut code, das mit einem Zahlenwert belegt ist, ausgegeben. <header> <responsedate> t10:30:21z</responsedate> <request_id>schroeder</request_id> <request_nid>urn:nbn:de:0002</request_nid> <request_num>3</request_num> <request_format>xml</request_format> </header> <error code="707">fehlerbeschreibung in englischer Sprache</error> 6.4. Error_Codes Folgende Error_Codes sind implementiert: Error_Code Beschreibung 705 Error: Please, check the syntax. 706 Warning: Please, reduce the number of requested URNs to be reserved. 707 Error: Please, check the authorisation data. 708 Error: The namespace is not registered. 709 Error: The specified format is not correct. Seite 7 von 7