Skip to content

Enhancement [CAT-FR-CO-05] Docs: validation strategy cleanup + provenance cascade#39

Merged
noVaSon merged 1 commit into
eclipse-xfsc:mainfrom
federated-catalogue-enhancements-2026:merge-to-upstream/CAT-FR-CO-05-cleanup-work
May 18, 2026
Merged

Enhancement [CAT-FR-CO-05] Docs: validation strategy cleanup + provenance cascade#39
noVaSon merged 1 commit into
eclipse-xfsc:mainfrom
federated-catalogue-enhancements-2026:merge-to-upstream/CAT-FR-CO-05-cleanup-work

Conversation

@peleskek

Copy link
Copy Markdown
Contributor

📦 [CAT-FR-CO-05] Docs: validation strategy cleanup + provenance cascade

🚀 Summary

Architecture docs catch up with the federated-catalogue cleanup PR:

  1. SHACL executor removed from the diagrams and prose. ShaclValidationStrategy and SchemaValidationServiceImpl now evaluate SHACL directly via the TopBraid engine — no shared ShaclValidationExecutor indirection, no separate timeout/pool configuration paragraph.
  2. Provenance cascade listener documented. The asset-deletion cascade section and the delete-participant runtime sequence note now list both ValidationResultCleanupListener and ProvenanceCleanupListener as @TransactionalEventListener(BEFORE_COMMIT) consumers of AssetDeletedEvent.

Requirement: CAT-FR-CO-05 — On-demand Validation of Assets against Schemas

This change is part of the Enhancement of XFSC Federated Catalogue. Details can be found here (permalink): https://github.com/eclipse-xfsc/docs/blob/f3c6e6b6fbcc87732a1dfe83f060fa58a9a97873/federated-catalogue/src/docs/CAT%20Enhancement/CAT_Enhancement_Specifications%20v1.0.pdf

✅ What's in this PR

  • Documentation updated

Modified files:

  • 05_building_block_view.adoc

    • On-Demand Asset Validation Service section: replace the "delegates to ShaclValidationExecutor" line and the "TopBraid SHACL in an isolated fixed-size thread pool + hard timeout" paragraph with a single line stating that both the upload-verification and on-demand paths invoke the TopBraid SHACL engine directly, on the request thread.
    • Asset Store section: extend the deleteAsset description to mention that the cascade cleans up associated provenance credentials in addition to validation results.
    • Validation Result Storage section: rewrite the asset-deletion cascade paragraph to document both @TransactionalEventListener(BEFORE_COMMIT) consumers — ValidationResultCleanupListener (rows + best-effort graph triples) and ProvenanceCleanupListener (provenance credential rows) — and clarify that all three deletions share the asset's transaction.
  • 06_runtime_view.adoc

    • Delete-participant sequence Note over AssetStore now lists both listeners.
    • Verify-credential prose drops the trailing "both flows share the same ShaclValidationExecutor for SHACL evaluation" clause and replaces it with "both flows evaluate SHACL via the same TopBraid SHACL engine".

No ADR is needed — both changes adopt patterns already established by existing ADRs and by ValidationResultCleanupListener.

🔍 Related Issues

Related to PR federated-catalogue — CAT-FR-CO-05 cleanup work (feature/CAT-FR-CO-05-cleanup-work)
Documents the corresponding behaviour for CAT-FR-CO-05 (On-demand Validation of Assets against Schemas).

📋 Checklist

  • I've updated documentation if necessary
  • My changes follow the project's coding style

…e cascade listener (#28)

Aligns arc42 building block and runtime views with the cleanup PR:
SHACL evaluation now runs directly inside ShaclValidationStrategy and
SchemaValidationServiceImpl (no shared executor), and ProvenanceCleanupListener
joins ValidationResultCleanupListener as a second AssetDeletedEvent consumer.
@peleskek peleskek force-pushed the merge-to-upstream/CAT-FR-CO-05-cleanup-work branch from eef2cd0 to 5437a8a Compare May 18, 2026 11:49
@sonarqubecloud

Copy link
Copy Markdown

@noVaSon noVaSon merged commit 0c722e2 into eclipse-xfsc:main May 18, 2026
2 checks passed
Sw3eks pushed a commit that referenced this pull request Jun 3, 2026
…rization (#39)

Update Keycloak realm name from `gaia-x` to `federated-catalogue-realm` in runtime view sequence diagrams.

Add a new section to the building block view to clarify the dual authorization layers for user management. This distinguishes between the roles required for the catalogue's user/participant API and those for the embedded Keycloak Admin Console, addressing potential confusion regarding client roles versus direct `realm-management` roles.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants