# farnam-hs/personal-blog architecture

> Architecture diagram of the GitHub repository farnam-hs/personal-blog, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/farnam-hs/personal-blog
- Repository: https://github.com/farnam-hs/personal-blog

## Overview

##### Main Components

a) Client Layer:
- Web Browser (User Interface)
- Two distinct user types: Regular users and Admin users

b) Web Layer:
- Apache Tomcat Server container
- Filters (Authentication, Exception Handling, Path filtering)
- Servlets (Controller layer)
- JSP Pages (View layer)

c) Application Layer:
- Service Layer (Business Logic)
- Repository Layer (Data Access)
- DTOs and Mappers
- Model Objects

d) Storage Layer:
- File System (JSON files)

##### Component Relationships

- Clear separation between layers

##### Detailed Component Breakdown

- JSP Pages:
- home.jsp
- article.jsp
- login.jsp
- dashboard.jsp
- add.jsp
- edit.jsp

- Filters:
- AdminFilter
- ExceptionHandlingFilter
- PathFilter
- Servlets:
- HomeServlet
- ArticleServlet
- LoginServlet
- AdminServlet
- AddArticleServlet
- EditArticleServlet
- DeleteArticleServlet

- ArticleService
- DTOs (ArticleRequestDto, ArticleResponseDto)
- Mappers (ArticleMapper)

- ArticleRepository
- FileHandler
- Model (Article)

##### Technical Details

- Technology labels:
- Java 17
- Jakarta Servlets 5.0
- JSP/JSTL 3.0
- Google Gson 2.11
- Apache Tomcat 10.1

##### Additional Elements

- Error handling paths
- Configuration components
- Where JSON serialization/deserialization occurs

##### Key Interactions to Highlight

- User request flow through filters
- Admin authentication process
- CRUD operations on articles
- File system interactions
- DTO-Entity conversion points

Remember to include a note about the stateless nature of the application and how session management is handled for admin authentication.

This design should reflect the MVC architecture pattern evident in the project structure, with clear separation between presentation, business logic, and data access layers.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Client Layer
    subgraph Client
        Browser["Web Browser"]
        AdminUser["Admin User"]
        RegularUser["Regular User"]
    end

    %% Web Container Layer
    subgraph WebContainer["Apache Tomcat Container"]
        %% Filters
        subgraph Filters
            AdminF["Admin Filter"]:::filter
            ExceptionF["Exception Filter"]:::filter
            PathF["Path Filter"]:::filter
        end

        %% JSP Views
        subgraph Views["JSP Views"]
            HomeJSP["home.jsp"]:::view
            ArticleJSP["article.jsp"]:::view
            LoginJSP["login.jsp"]:::view
            DashboardJSP["dashboard.jsp"]:::view
            AddJSP["add.jsp"]:::view
            EditJSP["edit.jsp"]:::view
        end

        %% Servlets
        subgraph Servlets
            HomeS["Home Servlet"]:::servlet
            ArticleS["Article Servlet"]:::servlet
            LoginS["Login Servlet"]:::servlet
            AdminS["Admin Servlet"]:::servlet
            AddArticleS["Add Article Servlet"]:::servlet
            EditArticleS["Edit Article Servlet"]:::servlet
            DeleteArticleS["Delete Article Servlet"]:::servlet
        end
    end

    %% Service Layer
    subgraph ServiceLayer["Service Layer"]
        ArticleService["Article Service"]:::service
        DTOs["DTOs"]:::service
        Mapper["Article Mapper"]:::service
    end

    %% Repository Layer
    subgraph RepositoryLayer["Repository Layer"]
        ArticleRepo["Article Repository"]:::repo
        FileHandler["File Handler"]:::repo
        Model["Article Model"]:::repo
    end

    %% Storage Layer
    Storage[(JSON Files)]:::storage

    %% Relationships
    Browser --> PathF
    AdminUser & RegularUser --> Browser
    PathF --> ExceptionF
    ExceptionF --> AdminF
    AdminF --> Servlets
    Servlets --> Views
    Servlets --> ServiceLayer
    ServiceLayer --> RepositoryLayer
    RepositoryLayer --> Storage

    %% Click Events
    click AdminF "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/filter/AdminFilter.java"
    click ExceptionF "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/filter/ExceptionHandlingFilter.java"
    click PathF "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/filter/PathFilter.java"
    click HomeJSP "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/webapp/pages/home.jsp"
    click ArticleJSP "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/webapp/pages/article.jsp"
    click LoginJSP "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/webapp/pages/login.jsp"
    click DashboardJSP "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/webapp/pages/dashboard.jsp"
    click AddJSP "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/webapp/pages/add.jsp"
    click EditJSP "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/webapp/pages/edit.jsp"
    click HomeS "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/servlet/HomeServlet.java"
    click ArticleS "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/servlet/ArticleServlet.java"
    click LoginS "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/servlet/LoginServlet.java"
    click AdminS "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/servlet/AdminServlet.java"
    click AddArticleS "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/servlet/AddArticleServlet.java"
    click EditArticleS "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/servlet/EditArticleServlet.java"
    click DeleteArticleS "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/controller/servlet/DeleteArticleServlet.java"
    click ArticleService "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/service/ArticleService.java"
    click ArticleRepo "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/repository/ArticleRepository.java"
    click FileHandler "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/util/FileHandler.java"
    click Model "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/model/Article.java"
    click Mapper "https://github.com/Farnam-Hs/Personal-Blog/blob/main/src/main/java/com/farnamhs/blog/mapper/ArticleMapper.java"

    %% Styling
    classDef default fill:#f9f9f9,stroke:#333,stroke-width:2px
    classDef filter fill:#90EE90,stroke:#333
    classDef view fill:#87CEEB,stroke:#333
    classDef servlet fill:#98FB98,stroke:#333
    classDef service fill:#FFD700,stroke:#333
    classDef repo fill:#FFA500,stroke:#333
    classDef storage fill:#DEB887,stroke:#333

    %% Legend
    subgraph Legend
        L1["Filter"]:::filter
        L2["View"]:::view
        L3["Servlet"]:::servlet
        L4["Service"]:::service
        L5["Repository"]:::repo
        L6["Storage"]:::storage
    end
```
