Enhancement [CAT-FR-CO-05] Docs: validation strategy cleanup + provenance cascade#39
Merged
Conversation
…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.
eef2cd0 to
5437a8a
Compare
|
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



📦 [CAT-FR-CO-05] Docs: validation strategy cleanup + provenance cascade
🚀 Summary
Architecture docs catch up with the federated-catalogue cleanup PR:
ShaclValidationStrategyandSchemaValidationServiceImplnow evaluate SHACL directly via the TopBraid engine — no sharedShaclValidationExecutorindirection, no separate timeout/pool configuration paragraph.ValidationResultCleanupListenerandProvenanceCleanupListeneras@TransactionalEventListener(BEFORE_COMMIT)consumers ofAssetDeletedEvent.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
Modified files:
05_building_block_view.adocShaclValidationExecutor" 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.deleteAssetdescription to mention that the cascade cleans up associated provenance credentials in addition to validation results.@TransactionalEventListener(BEFORE_COMMIT)consumers —ValidationResultCleanupListener(rows + best-effort graph triples) andProvenanceCleanupListener(provenance credential rows) — and clarify that all three deletions share the asset's transaction.06_runtime_view.adocNote over AssetStorenow lists both listeners.ShaclValidationExecutorfor 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