# miledrousset/siamois architecture

> Architecture diagram of the GitHub repository miledrousset/siamois, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/miledrousset/siamois
- Repository: https://github.com/miledrousset/siamois

## Overview

##### Project Type and Purpose
- This is a monolithic, full-stack Java web application (Spring Boot + JSF/PrimeFaces) augmented by a sibling SCSS/CSS “primefaces-themes” module.
- It serves as a rich-client browser UI backed by REST/JSF controllers, domain services, JPA repositories, PostgreSQL persistence, Liquibase migrations, and external Thesaurus/ARK resolution APIs.

##### High-Level Architectural Components
a. Frontend (Presentation)
- JSF + PrimeFaces pages & dialogs (under src/main/resources/META-INF/resources).
- Managed Beans & ViewModels (fr.siamois.ui.bean, ui.lazydatamodel, ui.viewmodel).
- Controllers & Redirectors (fr.siamois.ui.api, ui.redirection)
- Converters & Validators (ui.bean.converter, person/verifier).
- SCSS/CSS Theme Module (“primefaces-themes” separate Maven module).

b. Backend (Application Core)
- Spring Boot Launcher (SiamoisApplication).
- Web Config & Security (WebConfig, WebSecurityConfig, JsfConfig, OpenApiConfig).
- REST APIs (infrastructure.api).
- Event System (domain.events publisher and listeners).
- Service Layer (domain.services) implementing business use-cases.
- Domain Model (domain.models) — Entities, Value Objects, Exceptions.
- Data Access (infrastructure.database.repositories via Spring Data JPA).
- Database Initialization & Migrations (infrastructure.database.initializer + Liquibase changelogs).
- File Storage (infrastructure.files.DocumentStorage).
- Utilities & Builders (fr.siamois.utils).

c. External Systems
- PostgreSQL database.
- External Thesaurus API & Concept API (infrastructure.api/ThesaurusApi, ConceptApi).
- ARK/PURL resolution service (through ArkService, ArkRedirectionService).

##### Interactions and Data Flows
1. Browser → JSF pages → Managed Beans → Service Layer
2. Service Layer → Repositories → PostgreSQL
3. Service Layer → Event Publishers → Domain Listeners (e.g., ApplicationReadyListener)
4. Service Layer → External API Clients → Remote Thesaurus/ARK services
5. File upload/download through DocumentStorage → Filesystem or blob store
6. Liquibase runs on application start (DatabaseInitializer)

##### Architectural Patterns & Principles
- Layered Architecture (Presentation → Controller → Service → Repository → Database)
- Domain-Driven Design (rich domain.models, domain.services)
- Event-Driven (domain.events publisher/listener)
- Dependency Injection (Spring)
- Configuration via YAML (application.yaml) and Java @Configuration classes
- Build & CI via Maven and GitHub Actions (maven.yml)

## Diagram (Mermaid)

```mermaid
graph TB
  %% Client Tier
  subgraph "Client Tier"
    direction TB
    Browser["Browser UI\n(JSF/PrimeFaces Pages)"]:::frontend
    Themes["primefaces-themes Module"]:::frontend
  end

  %% Presentation Tier
  subgraph "Presentation Tier"
    direction TB
    Beans["Managed Beans"]:::frontend
    LazyDM["LazyDataModels"]:::frontend
    VM["ViewModels"]:::frontend
    Controllers["REST/JSF Controllers"]:::frontend
    Redirectors["Redirect Controllers"]:::frontend
    Converters["Converters"]:::frontend
    Validators["Validators"]:::frontend
    WebConfig["WebConfig"]:::config
    JsfConfig["JsfConfig"]:::config
    SecConfig["WebSecurityConfig"]:::config
    OpenApi["OpenApiConfig"]:::config
  end

  %% Business Tier
  subgraph "Business Tier"
    direction TB
    App["SiamoisApplication"]:::config
    Services["Service Layer"]:::business
    EventsPub["Event Publishers"]:::business
    EventsListener["ApplicationReadyListener"]:::business
    DomainModel["Domain Model"]:::business
    APIClients["REST API Clients"]:::infrastructure
    ArkService["Ark Services"]:::business
  end

  %% Data Tier
  subgraph "Data Tier"
    direction TB
    Repos["JPA Repositories"]:::data
    Liquibase["Database Init & Migrations"]:::data
    PostgreSQL["PostgreSQL"]:::storage
    FileStorage["DocumentStorage"]:::storage
  end

  %% External Systems
  ThesaurusExt["Thesaurus API"]:::external
  ConceptExt["Concept API"]:::external
  ArkRemote["ARK/PURL Service"]:::external

  %% Connections
  Browser -->|"renders pages"| Beans
  Beans -->|binds data| Controllers
  Controllers -->|"calls"| Services
  Services -->|"reads/writes"| Repos
  Repos -->|"SQL"| PostgreSQL
  Services -->|"publishes event"| EventsPub
  EventsPub -->|"on ready"| EventsListener
  Services -->|"uses"| DomainModel
  Services -->|"invokes"| APIClients
  APIClients -->|"HTTP"| ThesaurusExt
  APIClients -->|"HTTP"| ConceptExt
  Services -->|"calls"| ArkService
  ArkService -->|"resolves ARK"| ArkRemote
  Controllers -->|"uploads/downloads"| FileStorage
  Liquibase -->|"migrates"| PostgreSQL

  %% Click Events
  click Browser "https://github.com/miledrousset/siamois/tree/main/src/main/resources/META-INF/resources"
  click Themes "https://github.com/miledrousset/siamois/tree/main/primefaces-themes"
  click Beans "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/ui/bean"
  click LazyDM "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/ui/lazydatamodel"
  click VM "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/ui/viewmodel"
  click Controllers "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/ui/api"
  click Redirectors "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/ui/redirection"
  click Converters "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/ui/bean/converter"
  click Validators "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/domain/services/person/verifier"
  click App "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/SiamoisApplication.java"
  click WebConfig "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/ui/config/WebConfig.java"
  click JsfConfig "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/ui/config/JsfConfig.java"
  click SecConfig "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/ui/config/WebSecurityConfig.java"
  click OpenApi "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/ui/config/api/OpenApiConfig.java"
  click APIClients "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/infrastructure/api"
  click EventsListener "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/domain/events/ApplicationReadyListener.java"
  click EventsPub "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/domain/events/publisher"
  click Services "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/domain/services"
  click DomainModel "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/domain/models"
  click Repos "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/infrastructure/database/repositories"
  click Liquibase "https://github.com/miledrousset/siamois/tree/main/src/main/java/fr/siamois/infrastructure/database/initializer"
  click FileStorage "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/infrastructure/files/DocumentStorage.java"
  click ArkService "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/domain/services/ark/ArkService.java"
  click ArkService "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/domain/services/ark/ArkRedirectionService.java"
  click ThesaurusExt "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/infrastructure/api/ThesaurusApi.java"
  click ConceptExt "https://github.com/miledrousset/siamois/blob/main/src/main/java/fr/siamois/infrastructure/api/ConceptApi.java"

  %% Styles
  classDef frontend fill:#D0E8FF,stroke:#0366d6,color:#0366d6;
  classDef config fill:#E8F4D0,stroke:#6A732A,color:#6A732A;
  classDef business fill:#FFF3D0,stroke:#D69E2E,color:#D69E2E;
  classDef infrastructure fill:#F0D0FF,stroke:#9B59B6,color:#9B59B6;
  classDef data fill:#D0FFF0,stroke:#17A2B8,color:#17A2B8;
  classDef storage fill:#D0FFD8,stroke:#28A745,color:#28A745;
  classDef external fill:#F0F0F0,stroke:#6C757D,color:#6C757D;
  classDef tier1 fill-opacity:0,stroke-opacity:0;
  classDef tier2 fill-opacity:0,stroke-opacity:0;
  classDef tier3 fill-opacity:0,stroke-opacity:0;
  classDef tier4 fill-opacity:0,stroke-opacity:0;
```
