# skltp/ei architecture

> Architecture diagram of the GitHub repository skltp/ei, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/skltp/ei
- Repository: https://github.com/skltp/ei

## Overview

EI (SKLTP Engagemangs Index) is a Spring Boot/Apache Camel SOAP service for maintaining and querying engagements and notifying subscribers. The main documented flow accepts Update or ProcessNotification requests, validates and queues them, then applies changes to persistent engagement storage; the backend also discovers subscribers for dynamic notifications. FindContent, status, and write-lock management are separate capabilities. The README documents the H2/embedded ActiveMQ defaults and write-lock behavior. Some backend route wiring is unsampled, so those links are omitted or marked unverified.

Main entry points: [`skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java`](https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java) (SOAP routes), [`skltp-ei-backend/src/main/java/se/skltp/ei/updateprocess/UpdatePersistentStorageProcessor.java`](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/updateprocess/UpdatePersistentStorageProcessor.java) (Storage processor), [`skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendUpdateRoute.java`](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendUpdateRoute.java) (Update route), [`skltp-ei-backend/src/main/java/se/skltp/ei/service/UpdatePersistentStorageServiceImpl.java`](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/service/UpdatePersistentStorageServiceImpl.java) (Storage service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Application and SOAP entry"]
  node_app["EI bootstrap<br/>[EiApplication.java]"]
  node_frontend["SOAP routes"]
  node_validator["Request validation"]
  node_updateprocessor["Update queue mapping"]
  node_notifprocessor["Notification queue mapping"]
end

subgraph group_backend["Backend services"]
  node_collect["Collect route"]
  node_update["Update route"]
  node_storageprocessor["Storage processor"]
  node_storage["Storage service"]
  node_notifyroute["Dynamic notifications"]
  node_subscriber["Subscriber cache"]
  node_logical["Address lookup client"]
  node_subscriberfiles["Subscriber file cache"]
  node_findroute["FindContent route"]
  node_findservice["FindContent service"]
  node_writelock["Write lock"]
end

subgraph group_data["Engagement data"]
  node_engagement["Engagement entity<br/>[Engagement.java]"]
  node_repository[("Engagement repository")]
end

subgraph group_shared["Shared services"]
  node_transformer["Entity transformer"]
  node_jaxb["XML binding<br/>[JaxbUtil.java]"]
end

node_caller(("SOAP clients"))
node_broker["ActiveMQ"]

node_caller -->|"sends SOAP"| node_frontend
node_frontend -->|"validates"| node_validator
node_frontend -->|"maps updates"| node_updateprocessor
node_frontend -->|"maps notifications"| node_notifprocessor
node_frontend -->|"queues messages"| node_broker
node_broker -.->|"delivers queued work"| node_update
node_broker -.->|"buffers work"| node_collect
node_update -.->|"processes updates"| node_storageprocessor
node_collect -.->|"aggregates work"| node_storageprocessor
node_storageprocessor -->|"calls update"| node_storage
node_storage -->|"reads and writes"| node_repository
node_storage -->|"converts entities"| node_transformer
node_storageprocessor -->|"unmarshals XML"| node_jaxb
node_repository -->|"stores entities"| node_engagement
node_notifyroute -.->|"gets subscribers"| node_subscriber
node_subscriber -->|"looks up addresses"| node_logical
node_subscriber -->|"saves or restores"| node_subscriberfiles
node_findroute -.->|"dispatches queries"| node_findservice
node_findservice -.->|"queries engagements"| node_repository
node_writelock -.->|"suspends route"| node_update
node_writelock -.->|"suspends route"| node_collect
node_app -.->|"starts frontend"| node_frontend
node_app -.->|"starts backend"| node_update

click node_app "https://github.com/skltp/ei/blob/main/skltp-ei-application/src/main/java/se/skltp/ei/EiApplication.java"
click node_frontend "https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java"
click node_validator "https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/util/EngagementValidator.java"
click node_updateprocessor "https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/update/UpdateRequestToJmsMessageProcessor.java"
click node_notifprocessor "https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/notification/ProcessNotificationRequestToJmsMsgProcessor.java"
click node_collect "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendCollectRoute.java"
click node_update "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendUpdateRoute.java"
click node_storageprocessor "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/updateprocess/UpdatePersistentStorageProcessor.java"
click node_storage "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/service/UpdatePersistentStorageServiceImpl.java"
click node_notifyroute "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendDynamicNotificationRoute.java"
click node_subscriber "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/SubscriberCachableService.java"
click node_logical "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/service/GetLogicalAddresseesServiceClient.java"
click node_subscriberfiles "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/util/SubscriberFileTool.java"
click node_findroute "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendFindContentRoute.java"
click node_findservice "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/service/FindContentServiceImpl.java"
click node_writelock "https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/writelock/WriteLockService.java"
click node_engagement "https://github.com/skltp/ei/blob/main/skltp-ei-data-model/src/main/java/se/skltp/ei/entity/model/Engagement.java"
click node_repository "https://github.com/skltp/ei/blob/main/skltp-ei-data-model/src/main/java/se/skltp/ei/entity/repository/EngagementRepository.java"
click node_transformer "https://github.com/skltp/ei/blob/main/skltp-ei-common/src/main/java/se/skltp/ei/service/util/EntityTransformer.java"
click node_jaxb "https://github.com/skltp/ei/blob/main/skltp-ei-common/src/main/java/se/skltp/ei/service/util/JaxbUtil.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_frontend,node_validator,node_updateprocessor,node_notifprocessor,node_caller toneBlue
class node_collect,node_update,node_storageprocessor,node_storage,node_notifyroute,node_subscriber,node_logical,node_subscriberfiles,node_findroute,node_findservice,node_writelock toneAmber
class node_engagement,node_repository toneMint
class node_transformer,node_jaxb toneRose
class node_broker toneIndigo
```

## Components

### Application and SOAP entry

- [EI bootstrap](https://github.com/skltp/ei/blob/main/skltp-ei-application/src/main/java/se/skltp/ei/EiApplication.java): `skltp-ei-application/src/main/java/se/skltp/ei/EiApplication.java`
- [SOAP routes](https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java): `skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java`
- [Request validation](https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/util/EngagementValidator.java): `skltp-ei-frontend/src/main/java/se/skltp/ei/util/EngagementValidator.java`
- [Update queue mapping](https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/update/UpdateRequestToJmsMessageProcessor.java): `skltp-ei-frontend/src/main/java/se/skltp/ei/update/UpdateRequestToJmsMessageProcessor.java`
- [Notification queue mapping](https://github.com/skltp/ei/blob/main/skltp-ei-frontend/src/main/java/se/skltp/ei/notification/ProcessNotificationRequestToJmsMsgProcessor.java): `skltp-ei-frontend/src/main/java/se/skltp/ei/notification/ProcessNotificationRequestToJmsMsgProcessor.java`

### Backend services

- [Collect route](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendCollectRoute.java): `skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendCollectRoute.java`
- [Update route](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendUpdateRoute.java): `skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendUpdateRoute.java`
- [Storage processor](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/updateprocess/UpdatePersistentStorageProcessor.java): `skltp-ei-backend/src/main/java/se/skltp/ei/updateprocess/UpdatePersistentStorageProcessor.java`
- [Storage service](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/service/UpdatePersistentStorageServiceImpl.java): `skltp-ei-backend/src/main/java/se/skltp/ei/service/UpdatePersistentStorageServiceImpl.java`
- [Dynamic notifications](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendDynamicNotificationRoute.java): `skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendDynamicNotificationRoute.java`
- [Subscriber cache](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/SubscriberCachableService.java): `skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/SubscriberCachableService.java`
- [Address lookup client](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/service/GetLogicalAddresseesServiceClient.java): `skltp-ei-backend/src/main/java/se/skltp/ei/service/GetLogicalAddresseesServiceClient.java`
- [Subscriber file cache](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/util/SubscriberFileTool.java): `skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/util/SubscriberFileTool.java`
- [FindContent route](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendFindContentRoute.java): `skltp-ei-backend/src/main/java/se/skltp/ei/route/EiBackendFindContentRoute.java`
- [FindContent service](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/service/FindContentServiceImpl.java): `skltp-ei-backend/src/main/java/se/skltp/ei/service/FindContentServiceImpl.java`
- [Write lock](https://github.com/skltp/ei/blob/main/skltp-ei-backend/src/main/java/se/skltp/ei/writelock/WriteLockService.java): `skltp-ei-backend/src/main/java/se/skltp/ei/writelock/WriteLockService.java`

### Engagement data

- [Engagement entity](https://github.com/skltp/ei/blob/main/skltp-ei-data-model/src/main/java/se/skltp/ei/entity/model/Engagement.java): `skltp-ei-data-model/src/main/java/se/skltp/ei/entity/model/Engagement.java`
- [Engagement repository](https://github.com/skltp/ei/blob/main/skltp-ei-data-model/src/main/java/se/skltp/ei/entity/repository/EngagementRepository.java): `skltp-ei-data-model/src/main/java/se/skltp/ei/entity/repository/EngagementRepository.java`

### Shared services

- [Entity transformer](https://github.com/skltp/ei/blob/main/skltp-ei-common/src/main/java/se/skltp/ei/service/util/EntityTransformer.java): `skltp-ei-common/src/main/java/se/skltp/ei/service/util/EntityTransformer.java`
- [XML binding](https://github.com/skltp/ei/blob/main/skltp-ei-common/src/main/java/se/skltp/ei/service/util/JaxbUtil.java): `skltp-ei-common/src/main/java/se/skltp/ei/service/util/JaxbUtil.java`

### Other components

- **SOAP clients**
- **ActiveMQ**

## Connections

- SOAP clients → SOAP routes: sends SOAP (evidence: `skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java`)
- SOAP routes → Request validation: validates (evidence: `skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java`)
- SOAP routes → Update queue mapping: maps updates (evidence: `skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java`)
- SOAP routes → Notification queue mapping: maps notifications (evidence: `skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java`)
- SOAP routes → ActiveMQ: queues messages (evidence: `skltp-ei-frontend/src/main/java/se/skltp/ei/EiFrontendRoute.java`)
- ActiveMQ → Update route: delivers queued work
- ActiveMQ → Collect route: buffers work
- Update route → Storage processor: processes updates
- Collect route → Storage processor: aggregates work
- Storage processor → Storage service: calls update (evidence: `skltp-ei-backend/src/main/java/se/skltp/ei/updateprocess/UpdatePersistentStorageProcessor.java`)
- Storage service → Engagement repository: reads and writes (evidence: `skltp-ei-backend/src/main/java/se/skltp/ei/service/UpdatePersistentStorageServiceImpl.java`)
- Storage service → Entity transformer: converts entities (evidence: `skltp-ei-backend/src/main/java/se/skltp/ei/service/UpdatePersistentStorageServiceImpl.java`)
- Storage processor → XML binding: unmarshals XML (evidence: `skltp-ei-backend/src/main/java/se/skltp/ei/updateprocess/UpdatePersistentStorageProcessor.java`)
- Engagement repository → Engagement entity: stores entities (evidence: `skltp-ei-data-model/src/main/java/se/skltp/ei/entity/repository/EngagementRepository.java`)
- Dynamic notifications → Subscriber cache: gets subscribers
- Subscriber cache → Address lookup client: looks up addresses (evidence: `skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/SubscriberCachableService.java`)
- Subscriber cache → Subscriber file cache: saves or restores (evidence: `skltp-ei-backend/src/main/java/se/skltp/ei/subscriber/SubscriberCachableService.java`)
- FindContent route → FindContent service: dispatches queries
- FindContent service → Engagement repository: queries engagements
- Write lock → Update route: suspends route
- Write lock → Collect route: suspends route
- EI bootstrap → SOAP routes: starts frontend
- EI bootstrap → Update route: starts backend
