# bkizilkayaa/spring-boot-filetransfer architecture

> Architecture diagram of the GitHub repository bkizilkayaa/spring-boot-filetransfer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/bkizilkayaa/spring-boot-filetransfer
- Repository: https://github.com/bkizilkayaa/spring-boot-filetransfer

## Overview

##### Project type and purpose
- This is a lightweight two-service Spring Boot “file transfer” microservice demo.
- The root module (port 8080) exposes endpoints to upload/download files and uses RestTemplate to forward requests to a second service.
- The cross-service module (port 8081) exposes its own file upload/download endpoints—acting as the “client side” storage.

##### File structure
- Top level:
- root pom.xml and `/src` → FiletransferApplication (port 8080).
- `/cross-service/pom.xml` and `/cross-service/src` → TargetpathApplication (port 8081).
- Each service follows a standard layered layout:
- `controller/` → REST endpoints
- `service/` → business logic
- `utilities/` (or `response/`) → file I/O helpers
- `model/` or `response/` → DTOs
- `resources/files` → local storage
- RestTemplate is configured in the root service to call the client service.

##### README for additional insights
- Root service listens on 8080, client service listens on 8081.
- Three main flows:
a. GET from 8080 → reads file locally.
b. POST to 8080 → forwards file via RestTemplate to 8081.
c. GET directly on 8081 → reads file from client storage.

##### Main components & interactions
a. Components:
- External Client (e.g., Postman or front-end)
- FileTransferService (port 8080)
– FileTransferController
– FileUploadService & FileDownloadService
– FileUploadUtil & FileDownloadUtil
– Local filesystem (“server-side files”)
- TargetPathService (port 8081)
– FileController
– FileUploadService & FileDownloadService
– FileUploadUtil & FileDownloadUtil
– Local filesystem (“client-side files”)
- RestTemplate (embedded in FileUploadService of 8080)
b. Relationships & data flow:
1) External Client → (HTTP) → FileTransferController@8080
2) Controller → Service layer → if GET: reads from server FS → returns to client
3) if POST: Service → RestTemplate → 8081/FileController
4) 8081/FileController → writes to client FS → returns response → propagates back to original client
5) External Client can also directly call 8081 to verify download
c. Architectural patterns:
- Layered (Controller → Service → Utility)
- Two independent deployable Spring Boot “containers” (no API Gateway)
- Synchronous HTTP (RestTemplate) inter-service communication
d. Key technologies:
- Spring Boot (Web starter)
- Spring MVC controllers
- Spring’s RestTemplate
- Maven multi-module build
- Local file I/O

##### Elements
- Clear labels: service names, ports, layers (Controller, Service, Utility), storage location
- External Client → 8080 Controller
- 8080 Service → (RestTemplate) → 8081 Controller
- Controllers → Local FS
- Blue rectangles for services
- Orange stick figure or rectangle for External Client

##### Detailed yet concise capture
- Dual-flow: direct GET on 8080, forwarded POST to 8081, and optional direct GET on 8081.
- RestTemplate component explicitly in the inter-service flow.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% External Client
    ExternalClient["External Client"]:::client

    %% FileTransferService Container
    subgraph "FileTransferService (Port 8080)" 
        direction TB
        FTCApp["FiletransferApplication"]:::service
        FTCController["FileTransferController"]:::controller
        FTServiceLayer["Service Layer"]:::service
        FTUploadService["FileUploadService"]:::service
        FTDownloadService["FileDownloadService"]:::service
        FTUtils["Utilities"]:::utility
        FTUploadUtil["FileUploadUtil"]:::utility
        FTDownloadUtil["FileDownloadUtil"]:::utility
        FTLocalFS["Server-side FS"]:::storage
        FTCApp --> FTCController
        FTCController --> FTUploadService
        FTCController --> FTDownloadService
        FTUploadService --> FTUploadUtil
        FTDownloadService --> FTDownloadUtil
        FTDownloadService --> FTLocalFS
    end

    %% RestTemplate component
    RestTemplate["RestTemplate"]:::component

    %% TargetPathService Container
    subgraph "TargetPathService (Port 8081)"
        direction TB
        TPSApp["TargetpathApplication"]:::service
        TPController["FileController"]:::controller
        TPServiceLayer["Service Layer"]:::service
        TPUploadService["FileUploadService"]:::service
        TPDownloadService["FileDownloadService"]:::service
        TPUtils["Utilities"]:::utility
        TPUploadUtil["FileUploadUtil"]:::utility
        TPDownloadUtil["FileDownloadUtil"]:::utility
        TPLocalFS["Client-side FS"]:::storage
        TPSApp --> TPController
        TPController --> TPUploadService
        TPController --> TPDownloadService
        TPUploadService --> TPUploadUtil
        TPDownloadService --> TPDownloadUtil
        TPController --> TPLocalFS
    end

    %% Flows
    ExternalClient -->|"GET /files/download"| FTCController
    FTCController -->|"returns file"| ExternalClient

    ExternalClient -->|"POST /files/upload"| FTCController
    FTCController -->|"forward via RestTemplate"| RestTemplate
    RestTemplate -->|"POST /files/upload/client"| TPController
    TPController -->|"writes file"| TPLocalFS
    TPController -->|"response"| RestTemplate
    RestTemplate -->|"response"| FTCController
    FTCController -->|"response"| ExternalClient

    ExternalClient -->|"GET 8081 /files/download/client"| TPController
    TPController -->|"returns file"| ExternalClient

    %% Click Events for FileTransferService
    click FTCApp "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/FiletransferApplication.java"
    click FTCController "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/controller/FileTransferController.java"
    click FTUploadService "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/service/FileUploadService.java"
    click FTDownloadService "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/service/FileDownloadService.java"
    click FTUploadUtil "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/response/FileUploadUtil.java"
    click FTDownloadUtil "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/response/FileDownloadUtil.java"

    %% Click Events for FileResponse and Model
    click FileResponse "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/response/FileResponse.java"
    click FileInfo "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/model/FileInfo.java"
    click FileNotFoundException "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/java/com/burakkizilkaya/multipart/filetransfer/exception/FileNotFoundException.java"
    click ApplicationPropertiesFT "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/src/main/resources/application.properties"

    %% Click Events for Storage folder
    click FTLocalFS "https://github.com/bkizilkayaa/spring-boot-filetransfer/tree/master/Files-Upload/"

    %% Click Events for TargetPathService
    click TPSApp "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/java/com/burakkizilkaya/filetransfer/targetpath/TargetpathApplication.java"
    click TPController "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/java/com/burakkizilkaya/filetransfer/targetpath/controller/FileController.java"
    click TPUploadService "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/java/com/burakkizilkaya/filetransfer/targetpath/service/FileUploadService.java"
    click TPDownloadService "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/java/com/burakkizilkaya/filetransfer/targetpath/service/FileDownloadService.java"
    click TPUploadUtil "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/java/com/burakkizilkaya/filetransfer/targetpath/utilities/FileUploadUtil.java"
    click TPDownloadUtil "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/java/com/burakkizilkaya/filetransfer/targetpath/utilities/FileDownloadUtil.java"
    click FileResponseDto "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/java/com/burakkizilkaya/filetransfer/targetpath/model/FileResponseDto.java"
    click ApplicationPropertiesTP "https://github.com/bkizilkayaa/spring-boot-filetransfer/blob/master/cross-service/src/main/resources/application.properties"
    click TPLocalFS "https://github.com/bkizilkayaa/spring-boot-filetransfer/tree/master/cross-service/src/main/resources/files/"

    %% Styles
    classDef client fill:#FFA500,stroke:#333,stroke-width:2px
    classDef controller fill:#B0E0E6,stroke:#333,stroke-width:1px
    classDef service fill:#87CEFA,stroke:#333,stroke-width:1px
    classDef utility fill:#98FB98,stroke:#333,stroke-width:1px
    classDef storage fill:#ADFF2F,stroke:#333,stroke-width:1px
    classDef component fill:#FFD700,stroke:#333,stroke-width:1px
```
