# rspace-os/rspace-web architecture

> Architecture diagram of the GitHub repository rspace-os/rspace-web, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rspace-os/rspace-web
- Repository: https://github.com/rspace-os/rspace-web

## Overview

RSpace is a research data management platform spanning electronic lab notebooks, inventory, research integrations, and FAIR-data workflows. A typical researcher workflow is to create and maintain experiment records and associated files, manage samples or equipment, and connect those resources to institutional or external services; the README describes these capabilities but not their specific runtime routing. The graph therefore shows the major product stages and API/model layer while leaving unsampled connections unverified. Source excerpts support the storage, audit, identifier-update, and Galaxy workflow links shown.

Main entry points: [`src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java`](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java) (Galaxy workflows), [`src/main/java/com/researchspace/service/inventory/InventoryIdentifierExternalUpdateService.java`](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/service/inventory/InventoryIdentifierExternalUpdateService.java) (Persistent identifiers), [`src/main/java/com/researchspace/api/v1`](https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/api/v1) (REST API), [`src/main/java/com/researchspace/api/v1/controller`](https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/api/v1/controller) (Inventory management)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_research["Research workspace"]
  node_eln["Lab notebook"]
end

subgraph group_inventory["Inventory and identifiers"]
  node_inventory["Inventory management"]
  node_doi["Persistent identifiers"]
end

subgraph group_platform["Platform services"]
  node_api["REST API"]
  node_search["Search"]
  node_storage_manager["Storage locations"]
  node_sidecars["Metadata sidecars"]
end

subgraph group_connectors["Research integrations"]
  node_galaxy["Galaxy workflows<br/>[GalaxyService.java]"]
  node_clustermarket["Clustermarket OAuth"]
end

subgraph group_data["Persistence and audit"]
  node_records["Record model"]
  node_media["Media files<br/>[EcatMediaFile.java]"]
  node_audit["Audit trail"]
  node_storage_dao["Storage DAO"]
  node_storage_location["Storage location entity"]
  node_user["User and permissions<br/>[User.java]"]
end

node_researcher(("Researcher"))
node_external_services{{"External research services"}}
node_s3[("S3 filestore")]

node_researcher -.->|"uses"| node_api
node_api -.->|"supports"| node_eln
node_eln -.->|"records experiments"| node_records
node_records -.->|"attaches files"| node_media
node_researcher -.->|"manages items"| node_inventory
node_api -.->|"exposes"| node_inventory
node_inventory -.->|"updates identifiers"| node_doi
node_doi -.->|"pushes metadata"| node_external_services
node_doi -->|"records outcomes"| node_audit
node_storage_manager -->|"persists locations"| node_storage_dao
node_storage_dao -->|"loads entities"| node_storage_location
node_sidecars -->|"writes sidecars"| node_s3
node_sidecars -->|"audits generation"| node_audit
node_galaxy -->|"uploads and queries"| node_external_services
node_galaxy -->|"reads documents"| node_records
node_galaxy -->|"retrieves attachments"| node_media
node_clustermarket -->|"requests tokens"| node_external_services
node_clustermarket -->|"stores connection"| node_user
node_researcher -.->|"finds research"| node_search

click node_records "https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/model/record"
click node_media "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/EcatMediaFile.java"
click node_api "https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/api/v1"
click node_inventory "https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/api/v1/controller"
click node_doi "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/service/inventory/InventoryIdentifierExternalUpdateService.java"
click node_search "https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/axiope/search"
click node_audit "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/audittrail/AuditTrailService.java"
click node_storage_manager "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/service/impl/ExternalStorageManagerImpl.java"
click node_storage_dao "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/dao/hibernate/ExternalStorageDaoHibernate.java"
click node_storage_location "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/netfiles/ExternalStorageLocation.java"
click node_sidecars "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/service/metadata/S3SidecarFileService.java"
click node_galaxy "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java"
click node_clustermarket "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/webapp/integrations/clustermarket/ClustermarketOAuthService.java"
click node_user "https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/User.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_eln toneBlue
class node_inventory,node_doi,node_s3 toneAmber
class node_api,node_search,node_storage_manager,node_sidecars toneMint
class node_galaxy,node_clustermarket toneRose
class node_records,node_media,node_audit,node_storage_dao,node_storage_location,node_user,node_researcher,node_external_services toneIndigo
```

## Components

### Research workspace

- **Lab notebook**

### Inventory and identifiers

- [Inventory management](https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/api/v1/controller): `src/main/java/com/researchspace/api/v1/controller`
- [Persistent identifiers](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/service/inventory/InventoryIdentifierExternalUpdateService.java): `src/main/java/com/researchspace/service/inventory/InventoryIdentifierExternalUpdateService.java`

### Platform services

- [REST API](https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/api/v1): `src/main/java/com/researchspace/api/v1`
- [Search](https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/axiope/search): `src/main/java/com/axiope/search`
- [Storage locations](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/service/impl/ExternalStorageManagerImpl.java): `src/main/java/com/researchspace/service/impl/ExternalStorageManagerImpl.java`
- [Metadata sidecars](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/service/metadata/S3SidecarFileService.java): `src/main/java/com/researchspace/service/metadata/S3SidecarFileService.java`

### Research integrations

- [Galaxy workflows](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java): `src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java`
- [Clustermarket OAuth](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/webapp/integrations/clustermarket/ClustermarketOAuthService.java): `src/main/java/com/researchspace/webapp/integrations/clustermarket/ClustermarketOAuthService.java`

### Persistence and audit

- [Record model](https://github.com/rspace-os/rspace-web/tree/main/src/main/java/com/researchspace/model/record): `src/main/java/com/researchspace/model/record`
- [Media files](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/EcatMediaFile.java): `src/main/java/com/researchspace/model/EcatMediaFile.java`
- [Audit trail](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/audittrail/AuditTrailService.java): `src/main/java/com/researchspace/model/audittrail/AuditTrailService.java`
- [Storage DAO](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/dao/hibernate/ExternalStorageDaoHibernate.java): `src/main/java/com/researchspace/dao/hibernate/ExternalStorageDaoHibernate.java`
- [Storage location entity](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/netfiles/ExternalStorageLocation.java): `src/main/java/com/researchspace/model/netfiles/ExternalStorageLocation.java`
- [User and permissions](https://github.com/rspace-os/rspace-web/blob/main/src/main/java/com/researchspace/model/User.java): `src/main/java/com/researchspace/model/User.java`

### Other components

- **Researcher**
- **External research services**
- **S3 filestore**

## Connections

- Researcher → REST API: uses
- REST API → Lab notebook: supports
- Lab notebook → Record model: records experiments
- Record model → Media files: attaches files (evidence: `src/main/java/com/researchspace/model/EcatMediaFile.java`)
- Researcher → Inventory management: manages items
- REST API → Inventory management: exposes
- Inventory management → Persistent identifiers: updates identifiers
- Persistent identifiers → External research services: pushes metadata (evidence: `src/main/java/com/researchspace/service/inventory/InventoryIdentifierExternalUpdateService.java`)
- Persistent identifiers → Audit trail: records outcomes (evidence: `src/main/java/com/researchspace/service/inventory/InventoryIdentifierExternalUpdateService.java`)
- Storage locations → Storage DAO: persists locations (evidence: `src/main/java/com/researchspace/service/impl/ExternalStorageManagerImpl.java`)
- Storage DAO → Storage location entity: loads entities (evidence: `src/main/java/com/researchspace/dao/hibernate/ExternalStorageDaoHibernate.java`)
- Metadata sidecars → S3 filestore: writes sidecars (evidence: `src/main/java/com/researchspace/service/metadata/S3SidecarFileService.java`)
- Metadata sidecars → Audit trail: audits generation (evidence: `src/main/java/com/researchspace/service/metadata/S3SidecarFileService.java`)
- Galaxy workflows → External research services: uploads and queries (evidence: `src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java`)
- Galaxy workflows → Record model: reads documents (evidence: `src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java`)
- Galaxy workflows → Media files: retrieves attachments (evidence: `src/main/java/com/researchspace/integrations/galaxy/service/GalaxyService.java`)
- Clustermarket OAuth → External research services: requests tokens (evidence: `src/main/java/com/researchspace/webapp/integrations/clustermarket/ClustermarketOAuthService.java`)
- Clustermarket OAuth → User and permissions: stores connection (evidence: `src/main/java/com/researchspace/webapp/integrations/clustermarket/ClustermarketOAuthService.java`)
- Researcher → Search: finds research
