Ir para o conteúdo

System Components

This folder describes each software component of the federated framework. Each file follows the same structure: responsibility, inputs, outputs, dependencies, implemented state, and mandatory rules.

For the current Maven/Gradle/npm build inventory and repository layout, see the project module inventory.

Index

File Component
01-admin-api-monitor-web.md Admin API and Web Monitor
02-package-experiment-service.md Package Experiment Service
03-hyperledger-fabric.md Hyperledger Fabric and chaincodes
04-orchestrator.md Federated Orchestrator
05-mqtt.md MQTT Broker and topic contracts
06-federated-client.md Federated Client (JVM/Docker and Android/MDPL)
07-data-component.md Data Component
08-local-cdm.md Standardized Local Database
09-experiment-sdk.md Experiment SDK
10-training-local-model.md Training Job
11-aggregator.md Federated Aggregator
12-local-digital-twin.md Local Digital Twin
13-research-experiments.md Research Experiments
14-iot-replay-simulator.md IoT Replay Simulator and Simulation Session
15-experiment-packaging.md Packaging and Dynamic Deployment of Experiments (ADR-005)
16-generic-dataset-simulation.md Generic Dataset Simulation Engine (BL-087/BL-088)
17-local-digital-twin-broker.md Local Digital Twin Broker — Embedded MQTT Microbroker (ADR-002, BL-238)
18-rest-sse-gateway.md federated-digital-twin-broker (REST+SSE) — historical round-protocol design (BL-241, reverted BL-259); now used only for the BL-243 internal microbroker hop, see 17
19-mqtt-message-archive.md Persistência MongoDB de mensagens MQTT recebidas pelo monitor
20-model-inference.md Trained model packages and HTTP inference API

Common Conventions

  • Root Java package: br.ufma.lsdi.
  • Institutional domain: lsdi.ufma.br.
  • Federated communication is MQTT 5 with TLS/mTLS end to end for both training-data ingestion (iot//mhub/) and the round protocol (fl/ — RoundConfig/RoundFinalizationSignal/ClientUpdateMessage/ClientAnnouncePayload/ContractPublishedPayload). BL-241/BL-242/BL-240/BL-254 had migrated the round protocol to REST+SSE; that migration was fully reverted (BL-259) at the user's request, and every composition root (JVM/Docker and Android) is MQTT-only again — see 18-rest-sse-gateway.md for the historical record. The federated-digital-twin-broker module survives only for the BL-243 internal microbroker hop inside the Local Digital Twin Broker (see 17-local-digital-twin-broker.md), which is unrelated to the client↔server round protocol.
  • Contracts and auditing: Hyperledger Fabric.
  • Target architecture: Hyperledger Fabric is the only permanent store in the core. Off-chain artifact storage must be temporary staging deleted after successful ledger commit; raw client data remains local. Current artifact-service copies still need migration to satisfy this target.
  • Local data: data/{client_id}/{experiment_id} in MVP environments, or a standardized local database in production.