# regardsoss/regards-backend architecture

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

- Interactive diagram: https://gitdiagram.com/regardsoss/regards-backend
- Repository: https://github.com/regardsoss/regards-backend

## Overview

REGARDS is a multi-microservice backend for data access and management. Its visible product surface includes access and user services, configurable UI and plugins, toponym lookup, data discovery/crawling, ingest, and file storage. A typical data path can be understood from datasource crawling through ingest requests and storage handling, while access APIs expose user-facing capabilities. The tree documents these distinct areas, but source excerpts are sparse; only a few internal relationships are confirmed by the source index, so other links are omitted rather than inferred.

Main entry points: [`rs-dam/crawler/crawler-service/src/main/java/fr/cnes/regards/modules/crawler/service/service/DatasourceIngestionService.java`](https://github.com/regardsoss/regards-backend/blob/master/rs-dam/crawler/crawler-service/src/main/java/fr/cnes/regards/modules/crawler/service/service/DatasourceIngestionService.java) (Datasource Crawler), [`rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/user/ProjectUsersController.java`](https://github.com/regardsoss/regards-backend/blob/master/rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/user/ProjectUsersController.java) (Access APIs), [`rs-access/uiconfiguration/uiconfiguration-rest/src/main/java/fr/cnes/regards/modules/configuration/rest/UIConfigurationController.java`](https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-rest/src/main/java/fr/cnes/regards/modules/configuration/rest/UIConfigurationController.java) (UI Configuration APIs), [`rs-access/uiconfiguration/uiconfiguration-service/src/main/java/fr/cnes/regards/modules/configuration/service/UIConfigurationService.java`](https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-service/src/main/java/fr/cnes/regards/modules/configuration/service/UIConfigurationService.java) (UI Configuration Services)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_access["Access APIs"]
  node_access_api["Access APIs"]
  node_user_services["User Services"]
  node_service_aggregator["Service Aggregator"]
  node_bff["Backend for Frontend"]
end

subgraph group_configuration["UI Configuration"]
  node_ui_api["UI Configuration APIs"]
  node_ui_services["UI Configuration Services"]
  node_ui_store[("UI Configuration Store")]
end

subgraph group_discovery["Discovery Services"]
  node_toponym_api["Toponym API"]
  node_toponym_service["Toponym Service"]
  node_toponym_store[("Toponym Store")]
  node_crawler["Datasource Crawler"]
  node_plugin_runtime["Plugin Runtime"]
end

subgraph group_data["Data Pipeline"]
  node_ingest_scheduler["Ingest Scheduler"]
  node_ingest_requests["Ingest Requests"]
  node_file_storage["File Storage Requests"]
  node_storage_listener["Order Storage Listener"]
end

node_client(("Client"))

node_client -.->|"requests"| node_access_api
node_client -.->|"requests"| node_bff
node_client -.->|"requests"| node_ui_api
node_client -.->|"requests"| node_toponym_api
node_ingest_scheduler -->|"schedules"| node_ingest_requests
node_crawler -->|"loads plugins"| node_plugin_runtime
node_crawler -->|"loads configuration"| node_plugin_runtime
node_storage_listener -->|"handles file events"| node_file_storage
node_access_api -.->|"delegates"| node_user_services
node_ui_api -.->|"delegates"| node_ui_services
node_ui_services -.->|"persists configuration"| node_ui_store
node_toponym_api -.->|"delegates"| node_toponym_service
node_toponym_service -.->|"queries"| node_toponym_store

click node_access_api "https://github.com/regardsoss/regards-backend/blob/master/rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/user/ProjectUsersController.java"
click node_user_services "https://github.com/regardsoss/regards-backend/tree/master/rs-access/access-services/access-services-service/src/main/java/fr/cnes/regards/modules/access/services/service"
click node_service_aggregator "https://github.com/regardsoss/regards-backend/blob/master/rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/aggregator/ServicesAggregatorController.java"
click node_bff "https://github.com/regardsoss/regards-backend/blob/master/rs-access/backend-for-frontend/backend-for-frontend-rest/src/main/java/fr/cnes/regards/modules/backendforfrontend/rest/AccessSearchController.java"
click node_ui_api "https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-rest/src/main/java/fr/cnes/regards/modules/configuration/rest/UIConfigurationController.java"
click node_ui_services "https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-service/src/main/java/fr/cnes/regards/modules/configuration/service/UIConfigurationService.java"
click node_ui_store "https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-dao/src/main/java/fr/cnes/regards/modules/configuration/dao/IUIConfigurationRepository.java"
click node_toponym_api "https://github.com/regardsoss/regards-backend/blob/master/rs-access/toponyms-instance/toponyms-instance-rest/src/main/java/fr/cnes/regards/modules/toponyms/ToponymsController.java"
click node_toponym_service "https://github.com/regardsoss/regards-backend/blob/master/rs-access/toponyms-instance/toponyms-instance-service/src/main/java/fr/cnes/regards/modules/toponyms/service/ToponymsService.java"
click node_toponym_store "https://github.com/regardsoss/regards-backend/blob/master/rs-access/toponyms-instance/toponyms-instance-dao/src/main/java/fr/cnes/regards/modules/toponyms/dao/ToponymsRepository.java"
click node_crawler "https://github.com/regardsoss/regards-backend/blob/master/rs-dam/crawler/crawler-service/src/main/java/fr/cnes/regards/modules/crawler/service/service/DatasourceIngestionService.java"
click node_plugin_runtime "https://github.com/regardsoss/regards-backend/blob/master/rs-microservice/regards-modules/plugins/plugins-service/src/main/java/fr/cnes/regards/framework/modules/plugins/service/IPluginService.java"
click node_ingest_scheduler "https://github.com/regardsoss/regards-backend/blob/master/rs-ingest/ingest/ingest-service/src/main/java/fr/cnes/regards/modules/ingest/service/aip/scheduler/IngestRequestSchedulerService.java"
click node_ingest_requests "https://github.com/regardsoss/regards-backend/blob/master/rs-ingest/ingest/ingest-service/src/main/java/fr/cnes/regards/modules/ingest/service/request/IngestRequestService.java"
click node_file_storage "https://github.com/regardsoss/regards-backend/blob/master/rs-file-catalog/file-catalog/file-catalog-service/src/main/java/fr/cnes/regards/modules/filecatalog/service/FileStorageRequestService.java"
click node_storage_listener "https://github.com/regardsoss/regards-backend/blob/master/rs-order/order/order-service/src/main/java/fr/cnes/regards/modules/order/service/job/StorageFileListenerService.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_access_api,node_user_services,node_service_aggregator,node_bff,node_client toneBlue
class node_ui_api,node_ui_services,node_ui_store toneAmber
class node_toponym_api,node_toponym_service,node_toponym_store,node_crawler,node_plugin_runtime toneMint
class node_ingest_scheduler,node_ingest_requests,node_file_storage,node_storage_listener toneRose
```

## Components

### Access APIs

- [Access APIs](https://github.com/regardsoss/regards-backend/blob/master/rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/user/ProjectUsersController.java): `rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/user/ProjectUsersController.java`
- [User Services](https://github.com/regardsoss/regards-backend/tree/master/rs-access/access-services/access-services-service/src/main/java/fr/cnes/regards/modules/access/services/service): `rs-access/access-services/access-services-service/src/main/java/fr/cnes/regards/modules/access/services/service`
- [Service Aggregator](https://github.com/regardsoss/regards-backend/blob/master/rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/aggregator/ServicesAggregatorController.java): `rs-access/access-services/access-services-rest/src/main/java/fr/cnes/regards/modules/access/services/rest/aggregator/ServicesAggregatorController.java`
- [Backend for Frontend](https://github.com/regardsoss/regards-backend/blob/master/rs-access/backend-for-frontend/backend-for-frontend-rest/src/main/java/fr/cnes/regards/modules/backendforfrontend/rest/AccessSearchController.java): `rs-access/backend-for-frontend/backend-for-frontend-rest/src/main/java/fr/cnes/regards/modules/backendforfrontend/rest/AccessSearchController.java`

### UI Configuration

- [UI Configuration APIs](https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-rest/src/main/java/fr/cnes/regards/modules/configuration/rest/UIConfigurationController.java): `rs-access/uiconfiguration/uiconfiguration-rest/src/main/java/fr/cnes/regards/modules/configuration/rest/UIConfigurationController.java`
- [UI Configuration Services](https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-service/src/main/java/fr/cnes/regards/modules/configuration/service/UIConfigurationService.java): `rs-access/uiconfiguration/uiconfiguration-service/src/main/java/fr/cnes/regards/modules/configuration/service/UIConfigurationService.java`
- [UI Configuration Store](https://github.com/regardsoss/regards-backend/blob/master/rs-access/uiconfiguration/uiconfiguration-dao/src/main/java/fr/cnes/regards/modules/configuration/dao/IUIConfigurationRepository.java): `rs-access/uiconfiguration/uiconfiguration-dao/src/main/java/fr/cnes/regards/modules/configuration/dao/IUIConfigurationRepository.java`

### Discovery Services

- [Toponym API](https://github.com/regardsoss/regards-backend/blob/master/rs-access/toponyms-instance/toponyms-instance-rest/src/main/java/fr/cnes/regards/modules/toponyms/ToponymsController.java): `rs-access/toponyms-instance/toponyms-instance-rest/src/main/java/fr/cnes/regards/modules/toponyms/ToponymsController.java`
- [Toponym Service](https://github.com/regardsoss/regards-backend/blob/master/rs-access/toponyms-instance/toponyms-instance-service/src/main/java/fr/cnes/regards/modules/toponyms/service/ToponymsService.java): `rs-access/toponyms-instance/toponyms-instance-service/src/main/java/fr/cnes/regards/modules/toponyms/service/ToponymsService.java`
- [Toponym Store](https://github.com/regardsoss/regards-backend/blob/master/rs-access/toponyms-instance/toponyms-instance-dao/src/main/java/fr/cnes/regards/modules/toponyms/dao/ToponymsRepository.java): `rs-access/toponyms-instance/toponyms-instance-dao/src/main/java/fr/cnes/regards/modules/toponyms/dao/ToponymsRepository.java`
- [Datasource Crawler](https://github.com/regardsoss/regards-backend/blob/master/rs-dam/crawler/crawler-service/src/main/java/fr/cnes/regards/modules/crawler/service/service/DatasourceIngestionService.java): `rs-dam/crawler/crawler-service/src/main/java/fr/cnes/regards/modules/crawler/service/service/DatasourceIngestionService.java`
- [Plugin Runtime](https://github.com/regardsoss/regards-backend/blob/master/rs-microservice/regards-modules/plugins/plugins-service/src/main/java/fr/cnes/regards/framework/modules/plugins/service/IPluginService.java): `rs-microservice/regards-modules/plugins/plugins-service/src/main/java/fr/cnes/regards/framework/modules/plugins/service/IPluginService.java`

### Data Pipeline

- [Ingest Scheduler](https://github.com/regardsoss/regards-backend/blob/master/rs-ingest/ingest/ingest-service/src/main/java/fr/cnes/regards/modules/ingest/service/aip/scheduler/IngestRequestSchedulerService.java): `rs-ingest/ingest/ingest-service/src/main/java/fr/cnes/regards/modules/ingest/service/aip/scheduler/IngestRequestSchedulerService.java`
- [Ingest Requests](https://github.com/regardsoss/regards-backend/blob/master/rs-ingest/ingest/ingest-service/src/main/java/fr/cnes/regards/modules/ingest/service/request/IngestRequestService.java): `rs-ingest/ingest/ingest-service/src/main/java/fr/cnes/regards/modules/ingest/service/request/IngestRequestService.java`
- [File Storage Requests](https://github.com/regardsoss/regards-backend/blob/master/rs-file-catalog/file-catalog/file-catalog-service/src/main/java/fr/cnes/regards/modules/filecatalog/service/FileStorageRequestService.java): `rs-file-catalog/file-catalog/file-catalog-service/src/main/java/fr/cnes/regards/modules/filecatalog/service/FileStorageRequestService.java`
- [Order Storage Listener](https://github.com/regardsoss/regards-backend/blob/master/rs-order/order/order-service/src/main/java/fr/cnes/regards/modules/order/service/job/StorageFileListenerService.java): `rs-order/order/order-service/src/main/java/fr/cnes/regards/modules/order/service/job/StorageFileListenerService.java`

### Other components

- **Client**

## Connections

- Client → Access APIs: requests
- Client → Backend for Frontend: requests
- Client → UI Configuration APIs: requests
- Client → Toponym API: requests
- Ingest Scheduler → Ingest Requests: schedules (evidence: `rs-ingest/ingest/ingest-service/src/main/java/fr/cnes/regards/modules/ingest/service/aip/scheduler/IngestRequestSchedulerService.java`)
- Datasource Crawler → Plugin Runtime: loads plugins (evidence: `rs-dam/crawler/crawler-service/src/main/java/fr/cnes/regards/modules/crawler/service/service/DatasourceIngestionService.java`)
- Datasource Crawler → Plugin Runtime: loads configuration (evidence: `rs-dam/crawler/crawler-service/src/main/java/fr/cnes/regards/modules/crawler/service/service/DatasourceIngestionService.java`)
- Order Storage Listener → File Storage Requests: handles file events (evidence: `rs-order/order/order-service/src/main/java/fr/cnes/regards/modules/order/service/job/StorageFileListenerService.java`)
- Access APIs → User Services: delegates
- UI Configuration APIs → UI Configuration Services: delegates
- UI Configuration Services → UI Configuration Store: persists configuration
- Toponym API → Toponym Service: delegates
- Toponym Service → Toponym Store: queries
