Schema: robos:MessageBroker

Formal W3C SHACL constraint shape and OSLC JSON-LD specification for robos:MessageBroker in the core-platform package store.

Table of contents

  1. Specification Metadata
  2. Upstream Schema Basis (Refers From) & Global Standards Provenance
  3. Entity Relationship & Schema Context
  4. Property Constraints & SHACL Rules
  5. Canonical OSLC JSON-LD Example
  6. Programmatic SHACL Validation

Specification Metadata


Upstream Schema Basis (Refers From) & Global Standards Provenance

This RobOS schema is modeled after and directly aligns with two levels of global standards:

  • Universal Schema.org Class: https://schema.org/BroadcastService (100% interoperability with search engines, web indexers, and general AI reasoning)
  • Specialized Domain Standard: https://kafka.apache.org/ (de facto standard for domain-specific ALM, BDD, or infrastructure operations)
  • Canonical Reference: https://schema.org/BroadcastService
  • Agent Guidelines: When autonomous agents generate, expand, or validate instances of robos:MessageBroker, they MUST adhere to and base their output on this referred schema object and universal Schema.org parent class, extending it with RobOS SDLC properties.

Entity Relationship & Schema Context

Message Broker robos:MessageBroker

Governed by W3C SHACL shape urn:robos:shape:MessageBrokerShape within the Core Platform (robos.core) (robos.platform) package store.

dcterms:title robos:brokerType robos:endpoint

Property Constraints & SHACL Rules

Property Path Name Multiplicity Data Type Constraint Rule / Validation Message
dcterms:title Title / Display Name 1..* xsd:string Message Broker must have a title or display name.
robos:brokerType brokerType 1..* xsd:string Message Broker must declare broker type (kafka, rabbitmq, sqs, nats, pulsar).
robos:endpoint endpoint 1..* xsd:string Message Broker must specify bootstrap endpoint URI.

Canonical OSLC JSON-LD Example

{
  "@id": "urn:robos:broker:acme-event-kafka",
  "@type": [
    "oslc_am:Resource",
    "robos:MessageBroker",
    "robos:EventBus",
    "schema:BroadcastService"
  ],
  "dcterms:title": "Acme Core Enterprise Event Stream (Kafka)",
  "dcterms:description": "High-throughput Kafka cluster mediating event-driven microservice workflows.",
  "robos:brokerType": "kafka",
  "robos:endpoint": "kafka.internal.acme.corp:9092",
  "robos:topics": [
    "orders.created",
    "payments.processed",
    "invoices.generated"
  ],
  "robos:package": "core-platform",
  "robos:namespace": "robos.platform",
  "robos:schemaOrgType": "https://schema.org/BroadcastService",
  "robos:domainStandard": "https://kafka.apache.org/"
}

Programmatic SHACL Validation

const { SHACLValidator } = require('/usr/local/share/robos/robos-graph/lib/shacl-validator');
const { OSLCGraphParser, OSLC_CONTEXT } = require('/usr/local/share/robos/robos-graph/lib/oslc-parser');

const validator = new SHACLValidator();
const result = validator.validateGraph(new OSLCGraphParser({
  "@context": OSLC_CONTEXT,
  "robos:nodes": [
    {
        "@id": "urn:robos:broker:acme-event-kafka",
        "@type": [
            "oslc_am:Resource",
            "robos:MessageBroker",
            "robos:EventBus",
            "schema:BroadcastService"
        ],
        "dcterms:title": "Acme Core Enterprise Event Stream (Kafka)",
        "dcterms:description": "High-throughput Kafka cluster mediating event-driven microservice workflows.",
        "robos:brokerType": "kafka",
        "robos:endpoint": "kafka.internal.acme.corp:9092",
        "robos:topics": [
            "orders.created",
            "payments.processed",
            "invoices.generated"
        ],
        "robos:package": "core-platform",
        "robos:namespace": "robos.platform",
        "robos:schemaOrgType": "https://schema.org/BroadcastService",
        "robos:domainStandard": "https://kafka.apache.org/"
    }
  ],
}));

console.log("Conforms:", result.conforms); // Expected: true