# ali-bouali/spring-boot-3-jwt-security architecture

> Architecture diagram of the GitHub repository ali-bouali/spring-boot-3-jwt-security, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ali-bouali/spring-boot-3-jwt-security
- Repository: https://github.com/ali-bouali/spring-boot-3-jwt-security

## Overview

##### Main Components
- Application Bootstrapping: At the center, include the main entry point (SecurityApplication.java) that initializes the Spring Boot context.
- Authentication & Authorization Module: Represent components for handling JWT authentication and registration. This includes the AuthenticationController with its supporting classes (AuthenticationRequest, AuthenticationResponse, AuthenticationService, RegisterRequest). Also include supporting services like JwtService and JwtAuthenticationFilter in the config package.
- User Management: Identify the user-centric module including components like UserController, UserService, UserRepository, and associated domain models (User, Role, Permission, ChangePasswordRequest).
- Token Management: Add a separate token module managing access and refresh tokens (Token, TokenRepository, TokenType).
- Auditing and Security Configurations: Include the auditing components (ApplicationAuditAware) and configuration classes (ApplicationConfig, SecurityConfiguration, OpenApiConfig, LogoutService) which govern security policies and auditing.
- Domain-Specific Feature(s): Spotlight the “book” management module (Book, BookController, BookService, BookRepository, BookRequest) as well as demo controllers (AdminController, DemoController, ManagementController) that illustrate role-based endpoints.
- External Interactions: Although the project is primarily backend, note the existence of Docker and Maven configurations (docker-compose.yml, pom.xml, Maven wrapper files) which hint at deployment and build considerations. Additionally, HTTP test files indicate integration testing scenarios (shown in the http folder).

##### Relationships and Data Flow
- Role-based Access Control: Illustrate how user roles and permissions defined in the user module impact API accessibility.
- Auditing and Logging Layers: Indicate how auditing is handled via the auditing package.
- External Database: Mark a connection with the PostgreSQL “jwt_security” database as mentioned in the README.

##### Architectural Patterns and Design Principles
- Layered Architecture (MVC): Show the controllers, services, and repositories as distinct layers ensuring separation of concerns.
- Security by Design: Emphasize how Spring Security, JWT, and BCrypt are leveraged to secure the application.
- Modularization: The distinct modules (Auth, User, Book, Token, Demo) should be visually modularized to illustrate the separation of functionalities.

##### Relevant Technologies
- Spring Boot 3.0 and Spring Security are the core frameworks.
- JWT for token-based authentication.
- BCrypt for password encryption.
- Maven for build and dependency management.
- PostgreSQL (via docker-compose setup) for the database.

##### Being Detailed
- Avoid overly generic “backend” blocks; instead, name the modules and their responsibilities to provide exact clarity.

## Diagram (Mermaid)

```mermaid
flowchart TD

  %% Bootstrapping
  subgraph "Bootstrapping"
    SA["SecurityApplication.java"]
  end

  %% Authentication & Authorization Module
  subgraph "Authentication Module"
    AC["AuthenticationController"]
    AR["AuthenticationRequest"]
    ARes["AuthenticationResponse"]
    AS["AuthenticationService"]
    RR["RegisterRequest"]
    JS["JwtService"]
    JF["JwtAuthenticationFilter"]
  end

  %% User Management
  subgraph "User Management"
    UC["UserController"]
    US["UserService"]
    U["User"]
    UR["UserRepository"]
    CPR["ChangePasswordRequest"]
    R["Role"]
    P["Permission"]
  end

  %% Token Management
  subgraph "Token Management"
    T["Token"]
    TR["TokenRepository"]
    TT["TokenType"]
  end

  %% Auditing and Security Configurations
  subgraph "Auditing & Security Configs"
    AAA["ApplicationAuditAware"]
    ACfg["ApplicationConfig"]
    SC["SecurityConfiguration"]
    OAC["OpenApiConfig"]
    LS["LogoutService"]
  end

  %% Book Management
  subgraph "Book Management"
    B["Book"]
    BC["BookController"]
    BS["BookService"]
    BR["BookRepository"]
    BReq["BookRequest"]
  end

  %% Demo Endpoints
  subgraph "Demo Endpoints"
    ADC["AdminController"]
    DC["DemoController"]
    MC["ManagementController"]
  end

  %% External Interactions & Build/Deployment
  subgraph "External & Build"
    DCOM["docker-compose.yml"]
    POM["pom.xml"]
    MVNW["mvnw"]
    MVNWC["mvnw.cmd"]
    MVNWDir[".mvn/wrapper"]
    HT1["change-password.http"]
    HT2["http-test.http"]
    HT3["jpa-auditing.http"]
    PG["PostgreSQL (jwt_security DB)"]
  end

  %% Connections from Bootstrapping to Controllers
  SA -->|"init"| AC
  SA -->|"init"| UC
  SA -->|"init"| BC
  SA -->|"init"| ADC
  SA -->|"init"| DC
  SA -->|"init"| MC

  %% Authentication flow
  AC -->|"calls"| AS
  AS -->|"uses"| JS
  JF -->|"intercepts"| AC

  %% User Management flow
  UC -->|"calls"| US
  US -->|"accesses"| UR

  %% Book Management flow
  BC -->|"calls"| BS
  BS -->|"accesses"| BR

  %% Token Management usage (by authentication service)
  AS -->|"manages"| TR

  %% Security Configuration connections
  SC -->|"configures"| JF
  SC -->|"integrates"| OAC
  SC -->|"manages"| LS
  ACfg --> SC
  AAA -->|"audits"| US

  %% Domain relationships (Controllers use DTOs and domain objects)
  AC --- AR
  AC --- ARes
  AC --- RR
  UC --- U
  UC --- CPR
  UC --- R
  UC --- P
  BC --- B
  BC --- BReq

  %% External DB connections from repositories
  UR ---|"persists"| PG
  TR ---|"persists"| PG
  BR ---|"persists"| PG

  %% External & Build interactions
  DCOM -->|"deploys"| SA
  POM -->|"builds"| SA
  MVNW -->|"builds"| SA
  MVNWC -->|"builds"| SA
  MVNWDir -->|"builds"| SA

  %% Integration Testing targeting the application
  HT1 -->|"tests"| SA
  HT2 -->|"tests"| SA
  HT3 -->|"tests"| SA

  %% Click Events
  click SA "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/SecurityApplication.java"
  click AC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/auth/AuthenticationController.java"
  click AR "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/auth/AuthenticationRequest.java"
  click ARes "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/auth/AuthenticationResponse.java"
  click AS "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/auth/AuthenticationService.java"
  click RR "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/auth/RegisterRequest.java"
  click JS "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/config/JwtService.java"
  click JF "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/config/JwtAuthenticationFilter.java"

  click UC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/user/UserController.java"
  click US "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/user/UserService.java"
  click U "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/user/User.java"
  click UR "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/user/UserRepository.java"
  click CPR "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/user/ChangePasswordRequest.java"
  click R "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/user/Role.java"
  click P "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/user/Permission.java"

  click T "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/token/Token.java"
  click TR "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/token/TokenRepository.java"
  click TT "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/token/TokenType.java"

  click AAA "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/auditing/ApplicationAuditAware.java"
  click ACfg "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/config/ApplicationConfig.java"
  click SC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/config/SecurityConfiguration.java"
  click OAC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/config/OpenApiConfig.java"
  click LS "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/config/LogoutService.java"

  click B "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/book/Book.java"
  click BC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/book/BookController.java"
  click BS "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/book/BookService.java"
  click BR "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/book/BookRepository.java"
  click BReq "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/book/BookRequest.java"

  click ADC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/demo/AdminController.java"
  click DC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/demo/DemoController.java"
  click MC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/src/main/java/com/alibou/security/demo/ManagementController.java"

  click DCOM "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/docker-compose.yml"
  click POM "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/pom.xml"
  click MVNW "https://github.com/ali-bouali/spring-boot-3-jwt-security/tree/main/mvnw"
  click MVNWC "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/mvnw.cmd"
  click MVNWDir "https://github.com/ali-bouali/spring-boot-3-jwt-security/tree/main/.mvn/wrapper"
  click HT1 "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/http/change-password.http"
  click HT2 "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/http/http-test.http"
  click HT3 "https://github.com/ali-bouali/spring-boot-3-jwt-security/blob/main/http/jpa-auditing.http"

  %% Styles
  class SA config;
  class AC,UC,BC,ADC,DC,MC controller;
  class AS,US,BS service;
  class UR,TR,BR repo;
  class U,T,B,R,P domain;
  class AR,ARes,RR,CPR,BReq dto;
  class JS,JF,AAA,ACfg,SC,OAC,LS config;
  class DCOM,POM,MVNW,MVNWC,MVNWDir,HT1,HT2,HT3,PG external;

  %% Additional style definitions
  classDef controller fill:#ffcccc,stroke:#cc0000,stroke-width:2px;
  classDef service fill:#cce5ff,stroke:#003366,stroke-width:2px;
  classDef repo fill:#ccffcc,stroke:#006600,stroke-width:2px;
  classDef domain fill:#fff2cc,stroke:#996600,stroke-width:2px;
  classDef config fill:#ffe6cc,stroke:#cc6600,stroke-width:2px;
  classDef dto fill:#e6e6fa,stroke:#6666ff,stroke-width:2px;
  classDef external fill:#e6ccff,stroke:#990099,stroke-dasharray: 5 5,stroke-width:2px;
```
