# code-with-zoro/pearl-clipboard-backend architecture

> Architecture diagram of the GitHub repository code-with-zoro/pearl-clipboard-backend, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/code-with-zoro/pearl-clipboard-backend
- Repository: https://github.com/code-with-zoro/pearl-clipboard-backend

## Overview

Online Clipboard is a Spring backend for saving and retrieving text and uploaded files by generated key. The principal workflow enters through REST endpoints, is rate-checked by the service, then stores text in Redis or files in S3; retrieval returns text or a signed file URL, with one-time entries intended to be destructive. DTO mapping and clipboard state are the main internal data layer. The README describes caching and rate limiting, while the sampled service uses Redis directly for clipboard state and counters; no separate relational database implementation is evidenced. S3 and Redis wiring beyond the shown calls is not inferred.

Main entry points: [`src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java`](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java) (Clipboard service), [`src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java`](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java) (Clipboard endpoints), [`src/main/java/com/Projects/Online_Clipboard/services/s3Services.java`](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/services/s3Services.java) (S3 file service), [`src/main/java/com/Projects/Online_Clipboard/mapper/DtoMappers.java`](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/mapper/DtoMappers.java) (DTO mapper)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API layer"]
  node_controller["Clipboard endpoints"]
  node_errors["Exception mapping"]
end

subgraph group_clipboard["Clipboard workflows"]
  node_service["Clipboard service"]
end

subgraph group_storage["Storage integrations"]
  node_redis[("Redis store")]
  node_s3service["S3 file service<br/>[s3Services.java]"]
  node_s3[("AWS S3")]
end

subgraph group_contracts["Data and errors"]
  node_mapper["DTO mapper<br/>[DtoMappers.java]"]
  node_state["Clipboard state"]
  node_policy["Destruction modes"]
  node_contracts["Request and response DTOs"]
end

node_client(("Client"))

node_client -->|"sends requests"| node_controller
node_controller -->|"dispatches requests"| node_service
node_controller -->|"accepts and returns"| node_contracts
node_controller -->|"checks rate limit"| node_service
node_service -->|"reads and writes"| node_redis
node_service -->|"maps clipboard data"| node_mapper
node_mapper -->|"creates state"| node_state
node_service -->|"uploads and retrieves files"| node_s3service
node_s3service -->|"stores and fetches objects"| node_s3
node_service -->|"raises handled errors"| node_errors
node_client -.->|"file storage integration"| node_s3

click node_controller "https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java"
click node_service "https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java"
click node_mapper "https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/mapper/DtoMappers.java"
click node_state "https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/entity/ClipboardEntity.java"
click node_policy "https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/enums/distructionType.java"
click node_contracts "https://github.com/code-with-zoro/pearl-clipboard-backend/tree/main/src/main/java/com/Projects/Online_Clipboard/dtos"
click node_s3service "https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/services/s3Services.java"
click node_errors "https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/Exceptions/GlobalExceptionHandler.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_controller,node_errors,node_client toneBlue
class node_service toneAmber
class node_redis,node_s3service,node_s3 toneMint
class node_mapper,node_state,node_policy,node_contracts toneRose
```

## Components

### API layer

- [Clipboard endpoints](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java): `src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java`
- [Exception mapping](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/Exceptions/GlobalExceptionHandler.java): `src/main/java/com/Projects/Online_Clipboard/Exceptions/GlobalExceptionHandler.java`

### Clipboard workflows

- [Clipboard service](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java): `src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java`

### Storage integrations

- **Redis store**
- [S3 file service](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/services/s3Services.java): `src/main/java/com/Projects/Online_Clipboard/services/s3Services.java`
- **AWS S3**

### Data and errors

- [DTO mapper](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/mapper/DtoMappers.java): `src/main/java/com/Projects/Online_Clipboard/mapper/DtoMappers.java`
- [Clipboard state](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/entity/ClipboardEntity.java): `src/main/java/com/Projects/Online_Clipboard/entity/ClipboardEntity.java`
- [Destruction modes](https://github.com/code-with-zoro/pearl-clipboard-backend/blob/main/src/main/java/com/Projects/Online_Clipboard/enums/distructionType.java): `src/main/java/com/Projects/Online_Clipboard/enums/distructionType.java`
- [Request and response DTOs](https://github.com/code-with-zoro/pearl-clipboard-backend/tree/main/src/main/java/com/Projects/Online_Clipboard/dtos): `src/main/java/com/Projects/Online_Clipboard/dtos`

### Other components

- **Client**

## Connections

- Client → Clipboard endpoints: sends requests (evidence: `README.md`)
- Clipboard endpoints → Clipboard service: dispatches requests (evidence: `src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java`)
- Clipboard endpoints → Request and response DTOs: accepts and returns (evidence: `src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java`)
- Clipboard endpoints → Clipboard service: checks rate limit (evidence: `src/main/java/com/Projects/Online_Clipboard/controllers/ClipboardControllers.java`)
- Clipboard service → Redis store: reads and writes (evidence: `src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java`)
- Clipboard service → DTO mapper: maps clipboard data (evidence: `src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java`)
- DTO mapper → Clipboard state: creates state (evidence: `src/main/java/com/Projects/Online_Clipboard/mapper/DtoMappers.java`)
- Clipboard service → S3 file service: uploads and retrieves files (evidence: `src/main/java/com/Projects/Online_Clipboard/services/ClipboardServices.java`)
- S3 file service → AWS S3: stores and fetches objects (evidence: `src/main/java/com/Projects/Online_Clipboard/services/s3Services.java`)
- Clipboard service → Exception mapping: raises handled errors (evidence: `src/main/java/com/Projects/Online_Clipboard/Exceptions/GlobalExceptionHandler.java`)
- Client → AWS S3: file storage integration (evidence: `README.md`)
