# sovity/edc-ce architecture

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

- Interactive diagram: https://gitdiagram.com/sovity/edc-ce
- Repository: https://github.com/sovity/edc-ce

## Overview

##### Project type and purpose
- This is a full‑stack, self‑hostable “Connector” application built on Eclipse Dataspace Components (EDC).
- The backend (under `connector/…`) is a modular EDC Connector (Control Plane + optional Data Plane) extended by Sovity for enterprise‑ready features (DAPS integration, vault, messaging, DB migrations, etc.).
- The frontend (under `frontend/…`) is a Next.js/React UI that talks to two HTTP API surfaces exposed by the Connector:
a. A “UI API” for driving the web‑based dashboards and CRUD operations.
b. The “Management API” for integration and automation.

##### High‑level file‑structure analysis
- Top‑level directories:
- `connector/…` – Kotlin/Java Gradle projects for CE Connector, Docker image definitions, multiple library modules (api, json‑ld, mappers, runtime, runtime‑os, runtime‑test).
- `frontend/…` – Next.js UI, API‐client generation, fake‐backend for local dev, static assets, environment configs.
- `docs/…` – Documentation of Management API, UI, deployment, backend use cases.
- Key backend sub‑areas:
- `connector-ce/src/main/kotlin/de/sovity/edc/ce` – entry point `CeMain`, DI modules for Control Plane and Data Plane.
- `api/…/control` + `api/…/ui` – REST controllers for Control‑plane operations and the UI.
- `modules/…` – plugin‑style modules: `db`, `vault` (HashiCorp or in‑memory), `messaging` (contract terminations, data‑plane registration), `auth` (API key, OAuth2), dataspace features.
- `utils/db‑schema‑ce` – Flyway migrations.
- Frontend sub‑areas:
- `src/app` – Next.js pages and API routes (`/api/health`).
- `src/lib/api` – generated TS client + fake‑backend implementation for local dev.
- `src/components` – shared UI components, forms, tables, dialogs, policy editor, etc.

##### Insights from README
- The Connector is packaged as Docker images (control plane, optionally integrated data plane).
- The UI runs independently (Node/Next.js) or can be served via static build.
- Standard requirements: Java 17, Node 20, Docker.
- CI/CD provided via GitHub Actions building connector images and UI images.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Browser["User Browser"]:::frontend
        UI["Frontend UI (Next.js)"]:::frontend
        SharedComponents["Shared UI Components"]:::frontend
        TSClient["Generated TS API Client"]:::frontend
        FakeBackend["Fake-backend (Dev)"]:::frontend
    end

    %% Connector Service
    subgraph "Connector Service (Sovity CE Connector)"
        direction TB
        CeMain["CeMain (Entry Point)"]:::backend
        ControlModules["Control Plane DI Modules"]:::backend
        DataModules["Data Plane DI Modules"]:::backend
        UiModule["UI API DI Module"]:::backend
        subgraph "Controllers"
            direction TB
            CtrlAPIs["Management API Controllers"]:::backend
            UiAPIs["UI API Controllers"]:::backend
        end
        subgraph "Modules"
            direction TB
            AuthMod["Auth Module"]:::backend
            DbMod["Database Module"]:::backend
            VaultMod["Vault Module"]:::backend
            MsgMod["Messaging Modules"]:::backend
            DSpaceMod["Dataspace Features"]:::backend
        end
        subgraph "Libraries"
            direction TB
            JavaClient["API-Clients (Java)"]:::backend
            TSClientLib["API-Clients (TypeScript)"]:::backend
            RuntimeLibCore["Runtime & DI libs (core)"]:::backend
            RuntimeLibOS["Runtime & DI libs (OS)"]:::backend
            TestLib["E2E Test Utilities"]:::backend
        end
    end

    %% Persistence & Secrets
    subgraph "Persistence & Secrets"
        direction TB
        Postgres["PostgreSQL Database"]:::datastore
        Flyway["Flyway Migrations"]:::datastore
        VaultService["Vault Service"]:::datastore
        MsgBroker["Message Broker"]:::datastore
    end

    %% External Systems
    subgraph "External Systems"
        direction TB
        DAPS["DAPS (OAuth2 Token Service)"]:::external
        RemotePeers["Remote Connectors / Dataspaces"]:::external
    end

    %% Relationships
    Browser --> UI
    UI --> TSClient
    UI --> SharedComponents
    UI --> FakeBackend
    FakeBackend --> CtrlAPIs
    UI --> CtrlAPIs
    UI --> UiAPIs

    CeMain --> ControlModules
    CeMain --> DataModules
    CeMain --> UiModule

    ControlModules --> CtrlAPIs
    UiModule --> UiAPIs

    ControlModules --> AuthMod
    ControlModules --> DbMod
    ControlModules --> VaultMod
    ControlModules --> MsgMod
    ControlModules --> DSpaceMod

    DbMod --> Postgres
    Flyway --> Postgres
    VaultMod --> VaultService
    MsgMod --> MsgBroker

    DataModules --> MsgMod
    DataModules --> Postgres
    DataModules --> VaultMod
    DataModules --> MsgBroker
    DataModules --> RemotePeers

    ControlModules --> DAPS
    MsgMod --> RemotePeers

    CeMain --> JavaClient
    CeMain --> TSClientLib
    CeMain --> RuntimeLibCore
    CeMain --> RuntimeLibOS
    CeMain --> TestLib

    %% Click Events
    click UI "https://github.com/sovity/edc-ce/tree/main/frontend/src/app"
    click SharedComponents "https://github.com/sovity/edc-ce/tree/main/frontend/src/components"
    click TSClient "https://github.com/sovity/edc-ce/tree/main/frontend/src/lib/api/client/generated"
    click FakeBackend "https://github.com/sovity/edc-ce/tree/main/frontend/src/lib/api/fake-backend"
    click CeMain "https://github.com/sovity/edc-ce/blob/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/CeMain.kt"
    click ControlModules "https://github.com/sovity/edc-ce/blob/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/CeControlPlaneModules.kt"
    click DataModules "https://github.com/sovity/edc-ce/blob/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/CeDataPlaneModules.kt"
    click UiModule "https://github.com/sovity/edc-ce/blob/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/EdcUiModule.kt"
    click CtrlAPIs "https://github.com/sovity/edc-ce/tree/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/api/control"
    click UiAPIs "https://github.com/sovity/edc-ce/tree/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/api/ui"
    click AuthMod "https://github.com/sovity/edc-ce/tree/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/modules/auth"
    click DbMod "https://github.com/sovity/edc-ce/tree/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/modules/db"
    click VaultMod "https://github.com/sovity/edc-ce/tree/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/modules/vault"
    click MsgMod "https://github.com/sovity/edc-ce/tree/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/modules/messaging"
    click DSpaceMod "https://github.com/sovity/edc-ce/tree/main/connector/ce/connector-ce/src/main/kotlin/de/sovity/edc/ce/modules/dataspaces"
    click JavaClient "https://github.com/sovity/edc-ce/tree/main/connector/ce/libs/api-clients/java-client"
    click TSClientLib "https://github.com/sovity/edc-ce/tree/main/connector/ce/libs/api-clients/typescript-client"
    click RuntimeLibCore "https://github.com/sovity/edc-ce/tree/main/connector/ce/libs/runtime-lib"
    click RuntimeLibOS "https://github.com/sovity/edc-ce/tree/main/connector/ce/libs/runtime-os-lib"
    click TestLib "https://github.com/sovity/edc-ce/tree/main/connector/ce/libs/runtime-test-lib"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#0366D6
    classDef backend fill:#DFF7D8,stroke:#078C00,color:#078C00
    classDef datastore fill:#FFE5B4,stroke:#FF8C00,color:#FF8C00
    classDef external fill:#F0F0F0,stroke:#A0A0A0,color:#606060
```
