Project module inventory¶
This inventory was checked against the root Maven reactor and the Gradle/npm manifests on
2026-10-28. The root pom.xml is authoritative for Maven membership; a directory under
modules/ is not an active Maven module unless it has a pom.xml and is listed by the root
reactor.
Maven modules¶
The root reactor targets Java 25 (maven.compiler.source and target) and currently declares
15 platform modules:
| Maven module | Responsibility |
|---|---|
federated-common |
Shared contracts and payloads, MQTT topics/envelopes, signatures, hashing, codecs, and ZIP support. |
federated-experiment-sdk |
Experiment extension API: TrainingLocalModel, ExperimentSession, factories, runtime paths, and ML/runtime descriptors. |
federated-experiment-packager |
Readers, writers, CLIs, descriptors, signatures, and validation for experiment, simulation-data, and Android client packages. |
federated-local-cdm |
DataComponent, authorized training views, preflight, MQTT ingestion, and per-client SQLite time-series storage. |
federated-chaincode |
Java chaincode-facing domain contracts for experiment lifecycle, consent, rounds, and audit records. Deployable Fabric chaincode sources are under deploy/fabric/chaincode/. |
federated-package-experiment-service |
Local artifact storage, content hashes, safe path resolution, and contract-based retention. |
federated-model-inference |
Versioned model packages, Fabric package ledger adapter, and HTTP inference service. |
federated-client |
Federated client lifecycle and reusable client-side training, consent, and Android/MDPL engine code. |
federated-orchestrator |
Round coordination, client selection and relay, update collection/resolution, result publication, and twin-decision ingestion. |
federated-aggregator |
Aggregation strategies and pure aggregation computation with quorum and update validation. |
federated-containers |
Production Eclipse Paho MQTT 5 gateway, TLS configuration, and container process entry points. |
federated-digital-twin-broker |
Local digital-twin boundary, embedded broker/runtime, HTTP+SSE internal hop, and model validation adapters. |
federated-rest-api |
Admin monitor and REST API, Fabric Gateway composition, deployment, simulation controls, Docker orchestration, and MQTT archive integration. |
federated-simulator |
MQTT replay adapters and generic simulation-data package playback. |
federated-system-tests |
Cross-module and end-to-end integration suite. |
The reactor also contains five experiment modules and two benchmark modules:
| Reactor module | Purpose |
|---|---|
research/experiments/exp-ecg5000-anomaly-001 |
ECG5000 anomaly-detection experiment. |
research/experiments/exp-ergonomic-risk-001 |
Ergonomic-risk classification experiment. |
research/experiments/exp-mimic-v31-icu-mortality-001 |
MIMIC v3.1 ICU-mortality experiment; data is not included. |
research/experiments/exp-mnist-digits-001 |
MNIST digit-classification experiment. |
research/experiments/exp-synthetic-smoke-001 |
Synthetic, known-ground-truth platform smoke experiment. |
research/experiments/exp-ecg5000-anomaly-001/benchmark |
ECG experiment benchmarks. |
research/experiments/exp-har-smartphones-001/benchmark |
HAR experiment benchmarks. |
HAR experiment sources are included by Maven build-helper configuration rather than by a
standalone experiment pom.xml. The monitor bootstrap currently registers DT, HAR, and ECG by
default. The packaging script supports ECG, MIMIC, MNIST, and ergonomic-risk packages; the
synthetic smoke experiment has its own run script and is not a package-script entry.
Other build projects¶
| Directory | Build system | Status |
|---|---|---|
modules/federated-android-client |
Gradle (:core, :app) |
Android application; shares portable code from federated-client. |
modules/federated-admin-web |
npm/Vite | Separate frontend workspace; it is not part of the root Maven reactor. The monitor's current served UI and its wiring are described in the monitor component document. |
modules/federated-docs |
MkDocs Material + Read the Docs | Official documentation portal (.readthedocs.yaml, mkdocs.yml, self-contained sync script and SVG-rendered PlantUML diagrams); not part of the root Maven reactor. |
modules/scripts |
Shell scripts / independent Git repository | Build, run, packaging, and script checks. scripts at the project root is a compatibility symlink to this directory. |
Directories that are not active Maven modules¶
federated-client-packager, federated-simulation-packager, and
hdt-federated-interface-rest-client are not listed in the root reactor and do not exist as
module directories in this checkout. The first two responsibilities were consolidated into
federated-experiment-packager; REST+SSE client classes were consolidated into
federated-digital-twin-broker. Treat those names as historical.
Repository layout caveat¶
The root .gitignore excludes modules/. Module directories are separate local Git repositories
in this checkout, not Git submodules recorded by the root repository. A root-only clone therefore
does not by itself reproduce the Maven reactor; the module checkouts must also be obtained. No
module checkout manifest is currently maintained.
READMEs dos repositórios em modules/¶
Os 19 checkouts Git presentes neste workspace têm README próprio, com escopo, interfaces, integração e comandos. Os antigos nomes federated-client-packager e federated-simulation-packager não correspondem a diretórios presentes neste checkout; suas funções foram consolidadas em federated-experiment-packager.
| Repositório | Guia |
|---|---|
federated-common |
README |
federated-experiment-sdk |
README |
federated-experiment-packager |
README |
federated-local-cdm |
README |
federated-chaincode |
README |
federated-package-experiment-service |
README |
federated-model-inference |
README |
federated-client |
README |
federated-orchestrator |
README |
federated-aggregator |
README |
federated-containers |
README |
federated-digital-twin-broker |
README |
federated-rest-api |
README |
federated-simulator |
README |
federated-system-tests |
README |
federated-android-client |
README |
federated-admin-web |
README |
federated-docs |
README |
scripts |
README |
Related component documentation¶
For responsibilities and behavior details, see the component index.