Skip to content

Commit

Permalink
feature: #1190 update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ds-lcapellino committed Jul 18, 2024
1 parent 00eeead commit 7f2cc59
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 1 deletion.
13 changes: 13 additions & 0 deletions docs/src/docs/arc42/runtime-view/policies.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,16 @@ This sequence diagram describes the process of how the policy with the defined c
....
include::../../../uml-diagrams/arc42/runtime-view/policies/policy-assets.puml[]
....

=== Scenario 5: Updating notification offers when creating/deleting/updating policies

The Trace-X instance uses policies for creating the EDC catalog offers of notifications.
These offers will be created on the following actions:
- on Trace-X application startup - creating a policy for the own BPN - updating a policy for the own BPN - deleting a policy for the own BPN

This sequence diagram describes the process of how the catalog offers are updated after policy update/create/delete

[plantuml,target=policy-crud-notification-contract,format=svg]
....
include::../../../uml-diagrams/arc42/runtime-view/policies/policy-crud-notification-contract.puml[]
....
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
@startuml
skinparam monochrome true
skinparam shadowing false
skinparam defaultFontName "Architects daughter"

title Sequence diagram: Trace-X interaction with EDC on startup
participant "TraceX" as TraceX
participant "IRS" as IRS
participant "EDC " as EDC

activate TraceX
TraceX -> IRS: delete/create/update policy
activate IRS
IRS --> TraceX : ok
deactivate IRS
TraceX -> IRS: Get policies
activate IRS
IRS --> TraceX : Return policies
deactivate IRS

TraceX -> EDC: delete existing notification offers
activate EDC
EDC --> TraceX : ok
deactivate EDC


TraceX -> TraceX: Find newest policy of own BPN or default policy
activate TraceX
TraceX -> EDC : Create notification based on policy
deactivate TraceX
@enduml

@startuml
skinparam monochrome true
skinparam shadowing false
skinparam defaultFontName "Architects daughter"

title Sequence diagram: Sending notifications
participant "Trace-X" as TraceX
participant "Trace-X IRS Lib" as TraceXIRSLib
participant "IRS " as IRS
participant "EDC " as EDC

activate TraceX
TraceX -> TraceX: ...
TraceX -> EDC: Get catalog
activate EDC
EDC --> TraceX: Return catalog
deactivate EDC
TraceX -> TraceX: Filter for notification type (alert/investigation) & method (update/receive)
activate TraceX
deactivate TraceX
TraceX -> TraceXIRSLib: Validate if catalog policy matches the configured policies in IRS Lib (3 default policies)
activate TraceXIRSLib
TraceXIRSLib --> TraceX: Valid
deactivate TraceXIRSLib
TraceX -> EDC: Send notification
@enduml



Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ TraceX -> IRS: Get policies
activate IRS
IRS --> TraceX : Return policies
deactivate IRS
TraceX -> TraceX: Find any policy which matches own constraint
TraceX -> TraceX: Find newest policy of own BPN or default policy
activate TraceX
deactivate TraceX

Expand Down

0 comments on commit 7f2cc59

Please sign in to comment.