Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

4.4 Namensräume für Capability-IDs

4.4 Namensräume für Capability-IDs

Zweck

Capability-IDs MÜSSEN global eindeutig sein, um Kollisionen zwischen Capabilities verschiedener Anbieter zu verhindern. Ein Namensraum-Mechanismus auf Basis von Präfixen stellt diese Eindeutigkeit sicher.

Jede Capability-ID besteht aus einem Präfix und einem lokalen Namen, getrennt durch ein definiertes Trennzeichen.

Präfix-Tabelle

PräfixTrennzeichenEigentümerNormativitätBeschreibung
ruml::RUML-SpezifikationsgremiumNormativOffizielle Capabilities der RUML-Spezifikation — reserviert
ruml:draft/: + /RUML-SpezifikationsgremiumExperimentellExperimentelle Capabilities; DÜRFEN sich ohne Vorankündigung ändern
<reverse-domain>/. + /DrittanbieterAnbieterspezifischBeliebige Drittanbieter nach Reverse-Domain-Konvention

Ein Parser MUSS prüfen, ob jede Capability-ID einem dieser Präfixe entspricht. Eine ID ohne erkennbares Präfix-Muster MUSS er als Fehler behandeln (Regel CAP-21CAP-21 Eine Capability-ID MUSS eine von dieser Spezifikationsversion definierte ruml:-ID, eine ruml:draft/<name>-ID oder eine <reverse-domain>/<name>-ID sein; sie MUSS aus Kleinbuchstaben, Ziffern, _, - und den Trennzeichen bestehen und DARF 128 Zeichen NICHT überschreiten.).

Namensraum-Reservierung

Der Präfix ruml: ist reserviert. Drittanbieter DÜRFEN diesen Präfix NICHT für eigene Capabilities verwenden. Ein Parser MUSS eine Datei ablehnen, die eine ruml:-ID enthält, die weder in dieser Spezifikationsversion definiert noch eine ruml:draft/-ID ist, unabhängig vom Wert von required.

Offizielle Capabilities (ruml:)

Capabilities unter dem Präfix ruml: (ohne draft/) sind Teil der RUML-Spezifikation. Sie MÜSSEN in einem offiziellen Capability-Register dokumentiert sein und folgen den Versionsregeln der Spezifikation (siehe Kapitel 2.3).

Offizielles Capability-Register

Die folgenden ruml:-Capabilities sind in der aktuellen Spezifikation definiert:

Capability-IDScopeBeschreibungSpezifikation
ruml:datapointsRoot (data)DataPoints-Schema (Datendefinitionen) und Binding-HintsKapitel 4.7
ruml:queryNodeDatenbasierte Query-Expression (Leaf-Nodes)Kapitel 4.8
ruml:ai-queryNodeKI-gestützte Entscheidungen (LLM-basiert)Kapitel 4.9
ruml:actionsNodeActions-Objekte auf beliebigen Knoten (Reaktionen auf Status)Kapitel 4.10
ruml:contextRoot (data) + NodeContext-Map (Kontextmaterialien) und Node-ReferenzenKapitel 4.11
ruml:text-referenceRoot (data) + NodeTexts-Map (Rechtstexte/Normen) und Node-ReferenzenKapitel 4.12
ruml:protocolRoot (Deklaration)Auswertungsprotokoll (Audit-Trail) in der Result-DateiKapitel 4.13
ruml:expressionRoot (Deklaration) + NodeVerknüpfungsausdruck für den Operator DELEGATED (Parent-Nodes)Kapitel 4.14
ruml:tree-referenceRoot (Deklaration) + NodeVerweise auf Knoten anderer RUML-Dateien und deren TeilbäumeKapitel 4.15
ruml:tree-includeRoot (Deklaration) + NodeWertet einen Knoten einer anderen RUML-Datei an Stelle eines Leaf-Nodes ausKapitel 4.16

Experimentelle Capabilities (ruml:draft/)

Capabilities unter dem Präfix ruml:draft/ befinden sich im Entwurfsstadium:

  • DÜRFEN sich in Name, Struktur oder Semantik ohne Vorankündigung ändern.
  • SOLLTEN in produktiven Dateien NICHT mit required: true verwendet werden.
  • DÜRFEN in zukünftigen Versionen in offizielle ruml:-Capabilities überführt oder verworfen werden.

Upgrade-Pfad

Wenn eine ruml:draft/-Capability stabil wird, erhält sie eine neue ID ohne draft/. Dateien, die die Draft-Capability verwenden, müssen manuell migriert werden.

Drittanbieter-Capabilities (Reverse-Domain)

Alle Capabilities außerhalb des ruml:-Namensraums folgen der Reverse-Domain-Konvention:

com.example/review-notes
io.acme.legaltools/citation-style
org.myproject/custom-operator

Das Format ist: <reverse-domain>/<lokaler-name>

  • Der Reverse-Domain-Teil MUSS eine gültige Domain-Hierarchie widerspiegeln, deren Eigentümerschaft beim Anbieter liegt.
  • Der lokale Name MUSS mindestens ein Zeichen lang sein.
  • Der Eintrag auf Root-Level MUSS die Rolle deklarieren, die die Rulemap von der Capability erwartet (siehe Kapitel 4.1; Regel CAP-03CAP-03 Der Root-Eintrag einer ruml:draft/- oder Reverse-Domain-Capability MUSS role deklarieren.). Ein Parser, der die Capability implementiert, weist die Datei zurück, wenn die deklarierte Rolle von seiner Implementierung abweicht (Regel CAP-04CAP-04 Ein Parser, der eine ruml:draft/- oder Reverse-Domain-Capability implementiert, MUSS die Datei ablehnen, wenn die deklarierte role von der Rolle abweicht, die er implementiert.).

Syntaxregeln

RegelBeschreibung
ZeichensatzErlaubt: [a-z0-9_-], dazu die Trennzeichen aus der Präfix-Tabelle und / (als Hierarchietrenner)
MindestlängeMindestens 1 Zeichen
MaximallängeDARF 128 Zeichen NICHT überschreiten
Groß-/KleinschreibungNur Kleinbuchstaben; Großbuchstaben sind NICHT erlaubt
LeerzeichenNICHT erlaubt

Erlaubte und verbotene Beispiele

// GÜLTIG
"ruml:query"
"ruml:draft/ai-annotations"
"com.example/review-notes"
"com.example/priority"
"io.acme/v2/legal-refs"
"de.justiz.nrw/aktenzeichen"
// UNGÜLTIG — Leerzeichen
"com.example/my capability"
// UNGÜLTIG — Großbuchstaben
"com.example/Review-Notes"
// UNGÜLTIG — reservierter Präfix für Drittanbieter
"ruml:my-vendor-extension"
// UNGÜLTIG — keine Domain, kein Trennzeichen
"layout"
"myextension"
// UNGÜLTIG — leerer lokaler Name
"com.example/"