# arunsri7/book-my-room architecture

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

- Interactive diagram: https://gitdiagram.com/arunsri7/book-my-room
- Repository: https://github.com/arunsri7/book-my-room

## Overview

##### Project Type and Purpose
- This is a backend microservice (no bundled frontend) implementing a RESTful booking system (“Book My Room”) for multi-tenant resource management.
- Built with Spring Boot (Java 17), MongoDB, JWT-based auth, layered MVC architecture.
- Exposes REST endpoints (defined in controllers) for company, user, resource, and booking management.

##### File-Structure Analysis
- src/main/java/com/bookmyroom
- config: SecurityConfig.java (Spring Security + JWT filter)
- controller: REST controllers (Auth, Company, User, Resource, Booking)
- service + service/impl: business logic layer
- repository: MongoRepository interfaces
- model: domain entities (Company, User, Resource, Booking, etc.)
- security: CustomUserDetails, JwtService, JwtAuthenticationFilter
- exception: custom exceptions + global handler
- src/main/resources/application.yml: configuration (DB URI, JWT secrets, ports)
- Dockerfile & docker-compose.yml: containerization (app + MongoDB)
- Postman collection for API testing

##### Key Components
a. Clients
- API clients (e.g., Postman, future frontend or mobile apps)
b. API Layer
- Spring MVC Controllers
c. Security Layer
- JwtAuthenticationFilter → JwtService → CustomUserDetailsService
- SecurityConfig defines filter chain, endpoints’ access rules
d. Business Logic Layer
- Service interfaces and implementations (BookingServiceImpl, CompanyServiceImpl, etc.)
- Applies multi-tenant checks & role-based access
e. Data Access Layer
- Spring Data MongoDB Repositories
f. Database
- MongoDB (one database, multi-tenant via companyId)
g. Infrastructure
- Docker + Docker-Compose orchestrating the Spring Boot app and MongoDB

##### Component Interactions and Data Flow
1. Client → HTTP Request → Controller (e.g., /api/bookings)
2. Controller → SecurityConfig ensures JWT filter runs
3. JwtAuthenticationFilter validates token via JwtService → loads user via CustomUserDetailsService
4. Authenticated request enters controller method → calls appropriate Service
5. Service layer → applies business rules + multi-tenant isolation → calls Repository
6. Repository → executes MongoDB queries → returns domain objects
7. Service → transforms/validates results → Controller → serializes response to JSON → Client
8. For login: AuthController issues JWT token based on credentials

##### Architectural Patterns & Principles
- Layered (Controller → Service → Repository)
- MVC-style separation
- Stateless JWT authentication
- Multi-tenant isolation enforced at service/repository layer
- Exception handling via GlobalExceptionHandler (cross-cutting concern)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Client Layer"
        Client["API Clients<br/>(Postman, Frontend)"]:::external
        click Client "https://github.com/arunsri7/book-my-room/blob/main/BookMyRoom.postman_collection.json"
    end

    %% Docker Compose
    subgraph "Docker Compose"
        direction TB
        AppContainer["Spring Boot App"]:::docker
        MongoContainer((MongoDB)):::db
    end

    AppContainer --- MongoContainer

    %% Configuration
    subgraph "Configuration"
        Config["application.yml<br/>(DB URI, JWT Secrets)"]:::config
        click Config "https://github.com/arunsri7/book-my-room/blob/main/src/main/resources/application.yml"
    end

    %% Cross-cutting Exception Handling
    subgraph "Exception Handling"
        GlobalExceptionHandler["GlobalExceptionHandler"]:::exception
        click GlobalExceptionHandler "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/exception/GlobalExceptionHandler.java"
    end

    %% App Internal Layers
    AppContainer --> Config
    AppContainer --> GlobalExceptionHandler

    %% API Layer
    subgraph "API Layer (Controllers)" 
        direction TB
        AuthController["AuthController"]:::controller
        CompanyController["CompanyController"]:::controller
        ResourceController["ResourceController"]:::controller
        BookingController["BookingController"]:::controller
        click AuthController "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/controller/AuthController.java"
        click CompanyController "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/controller/CompanyController.java"
        click ResourceController "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/controller/ResourceController.java"
        click BookingController "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/controller/BookingController.java"
    end

    %% Security Layer
    subgraph "Security Layer"
        direction TB
        SecurityConfig["SecurityConfig"]:::security
        JwtAuthFilter["JwtAuthenticationFilter"]:::security
        JwtService["JwtService"]:::security
        CustomDetails["CustomUserDetails"]:::security
        CustomDetailsService["CustomUserDetailsService"]:::security
        click SecurityConfig "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/config/SecurityConfig.java"
        click JwtAuthFilter "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/security/JwtAuthenticationFilter.java"
        click JwtService "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/security/JwtService.java"
        click CustomDetails "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/security/CustomUserDetails.java"
        click CustomDetailsService "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/impl/CustomUserDetailsService.java"
    end

    %% Business Logic Layer
    subgraph "Business Logic Layer"
        direction TB
        BookingService["BookingService"]:::service
        BookingServiceImpl["BookingServiceImpl<br/>(companyId filter)"]:::service
        CompanyService["CompanyService"]:::service
        CompanyServiceImpl["CompanyServiceImpl<br/>(companyId filter)"]:::service
        ResourceService["ResourceService"]:::service
        ResourceServiceImpl["ResourceServiceImpl<br/>(companyId filter)"]:::service
        UserService["UserService"]:::service
        UserServiceImpl["UserServiceImpl<br/>(companyId filter)"]:::service
        click BookingService "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/BookingService.java"
        click BookingServiceImpl "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/impl/BookingServiceImpl.java"
        click CompanyService "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/CompanyService.java"
        click CompanyServiceImpl "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/impl/CompanyServiceImpl.java"
        click ResourceService "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/ResourceService.java"
        click ResourceServiceImpl "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/impl/ResourceServiceImpl.java"
        click UserService "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/UserService.java"
        click UserServiceImpl "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/service/impl/UserServiceImpl.java"
    end

    %% Data Access Layer
    subgraph "Data Access Layer"
        direction TB
        BookingRepo["BookingRepository"]:::repository
        CompanyRepo["CompanyRepository"]:::repository
        ResourceRepo["ResourceRepository"]:::repository
        UserRepo["UserRepository"]:::repository
        click BookingRepo "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/repository/BookingRepository.java"
        click CompanyRepo "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/repository/CompanyRepository.java"
        click ResourceRepo "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/repository/ResourceRepository.java"
        click UserRepo "https://github.com/arunsri7/book-my-room/blob/main/src/main/java/com/bookmyroom/repository/UserRepository.java"
    end

    %% Data Flow
    Client -->|"HTTP/JSON"| AuthController
    Client -->|"HTTP/JSON"| CompanyController
    Client -->|"HTTP/JSON"| ResourceController
    Client -->|"HTTP/JSON"| BookingController

    AuthController -->|"issues JWT"| JwtService
    AuthController -->|calls Service| BookingServiceImpl

    CompanyController -->|calls Service| CompanyServiceImpl
    ResourceController -->|calls Service| ResourceServiceImpl
    BookingController -->|calls Service| BookingServiceImpl

    %% Security Interception
    CompanyController --> SecurityConfig
    ResourceController --> SecurityConfig
    BookingController --> SecurityConfig
    SecurityConfig --> JwtAuthFilter
    JwtAuthFilter --> JwtService
    JwtService --> CustomDetailsService
    CustomDetailsService --> CustomDetails

    %% Exception Handling
    AuthController --> GlobalExceptionHandler
    CompanyController --> GlobalExceptionHandler
    ResourceController --> GlobalExceptionHandler
    BookingController --> GlobalExceptionHandler

    %% Service to Repo to DB
    BookingServiceImpl -->|queries| BookingRepo
    CompanyServiceImpl -->|queries| CompanyRepo
    ResourceServiceImpl -->|queries| ResourceRepo
    UserServiceImpl -->|queries| UserRepo

    BookingRepo -->|"MongoDB Queries"| MongoContainer
    CompanyRepo -->|"MongoDB Queries"| MongoContainer
    ResourceRepo -->|"MongoDB Queries"| MongoContainer
    UserRepo -->|"MongoDB Queries"| MongoContainer

    %% Infrastructure Files
    Dockerfile["Dockerfile"]:::infra
    DockerComposeYml["docker-compose.yml"]:::infra
    click Dockerfile "https://github.com/arunsri7/book-my-room/tree/main/Dockerfile"
    click DockerComposeYml "https://github.com/arunsri7/book-my-room/blob/main/docker-compose.yml"

    Dockerfile --> AppContainer
    DockerComposeYml --> Dockerfile
    DockerComposeYml --> MongoContainer

    %% Styling
    classDef controller fill:#D0E8FF,stroke:#000,stroke-width:1px;
    classDef service fill:#DFF2BF,stroke:#000,stroke-width:1px;
    classDef repository fill:#FFE9BF,stroke:#000,stroke-width:1px;
    classDef security fill:#E2D0FF,stroke:#000,stroke-width:1px;
    classDef db fill:#FFD0D0,stroke:#000,stroke-width:1px;
    classDef external fill:#F0F0F0,stroke:#000,stroke-width:1px;
    classDef docker fill:#D0FFD0,stroke:#000,stroke-width:1px;
    classDef exception fill:#FFCCCC,stroke:#000,stroke-width:1px;
    classDef config fill:#D0D0FF,stroke:#000,stroke-width:1px;
    classDef infra fill:#E8E8E8,stroke:#000,stroke-width:1px;
```
