# shatanshu3006/server-from-scratch architecture

> Architecture diagram of the GitHub repository shatanshu3006/server-from-scratch, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shatanshu3006/server-from-scratch
- Repository: https://github.com/shatanshu3006/server-from-scratch

## Overview

##### Project Type and Purpose
- **Type:** Standalone, full-fledged HTTP server (no external frameworks).
- **Purpose:**
- Listen for TCP connections on a configurable port
- Parse raw HTTP/1.x requests
- Serve static files from `WebRoot/`
- Handle basic MIME detection, errors, and JSON-based configuration
- Support multi-threaded request handling

##### Core Components (from File Tree & README)
- **Entry Point & Utilities (`com.util`):**
- `HttpServer.java` – main() method; bootstraps listener
- `Json.java` – JSON helper for config
- **Configuration (`com.httpserver.config`):**
- `ConfigurationManager` – loads/parses `http.json`
- `Configuration` – holds port, threadPoolSize, webRoot path…
- **Server Engine (`com.httpserver.core`):**
- `ServerListenerThread` – accepts new sockets, hands off to worker threads
- `HttpConnectionWorkerThread` – reads from socket, invokes parser & handler
- **I/O & Routing (`com.httpserver.core.io`):**
- `WebRootHandler` – locates static file in `WebRoot/`, streams bytes back
- Exceptions: `WebRootNotFoundException`, `ReadFileException`
- **HTTP Protocol (`com.http`):**
- `HttpParser` – scannerless parsing of request-line + headers
- Domain classes: `HttpRequest`, `HttpMessage`, enums for `HttpMethod`, `HttpVersion`, `HttpStatusCode`
- Exceptions: `HttpParsingException`, `BadHttpVersionException`

##### Additional Insights from README
- Multi-threaded design: one listener thread + multiple worker threads
- JSON config schema in `resource/http.json`
- JUnit 5 tests for parser, version, headers, WebRootHandler

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    Client["Client (Browser/Curl)"]:::external

    %% Util Module
    subgraph "Util Module"
        HttpServer["HttpServer"]:::util
        JsonUtil["Json"]:::util
    end

    %% Configuration Module
    subgraph "Configuration Module"
        ConfigurationManager["ConfigurationManager"]:::config
        Configuration["Configuration"]:::config
        HttpConfigEx["HttpConfigurationException"]:::config
    end

    %% Server Core
    subgraph "Server Core"
        ServerListener["ServerListenerThread"]:::server
        WorkerThread["HttpConnectionWorkerThread"]:::server
    end

    %% HTTP Core
    subgraph "HTTP Core"
        HttpParser["HttpParser"]:::http
        HttpRequest["HttpRequest"]:::http
        HttpMessage["HttpMessage"]:::http
        HttpMethod["HttpMethod"]:::http
        HttpVersion["HttpVersion"]:::http
        HttpStatusCode["HttpStatusCode"]:::http
        HttpParseEx["HttpParsingException"]:::http
        BadVersionEx["BadHttpVersionException"]:::http
    end

    %% I/O & Routing Module
    subgraph "I/O & Routing Module"
        WebRootHandler["WebRootHandler"]:::io
        NotFoundEx["WebRootNotFoundException"]:::io
        ReadFileEx["ReadFileException"]:::io
    end

    %% External Static File Store
    WebRoot["WebRoot (Static File Store)"]:::external

    %% Interactions
    Client -->|"TCP CONNECT"| ServerListener
    ServerListener -->|"spawns"| WorkerThread
    WorkerThread -->|"load config"| ConfigurationManager
    ConfigurationManager -->|returns| Configuration
    WorkerThread -->|"read raw data"| HttpParser
    HttpParser -->|"parses"| HttpRequest
    HttpParser --> HttpMessage
    HttpParser --> HttpMethod
    HttpParser --> HttpVersion
    HttpParser --> HttpStatusCode
    HttpParser --> HttpParseEx
    HttpParser --> BadVersionEx
    WorkerThread -->|"routes request"| WebRootHandler
    WebRootHandler -->|"reads file"| WebRoot
    WebRootHandler --> NotFoundEx
    WebRootHandler --> ReadFileEx
    WebRootHandler -->|"bytes"| WorkerThread
    WorkerThread -->|"response"| Client

    %% Config at startup
    HttpServer --> ConfigurationManager
    HttpServer --> JsonUtil

    %% Styles
    classDef util fill:#D8BFD8,stroke:#9370DB
    classDef config fill:#FFDAB9,stroke:#FF8C00
    classDef server fill:#98FB98,stroke:#2E8B57
    classDef http fill:#ADD8E6,stroke:#1E90FF
    classDef io fill:#90EE90,stroke:#228B22
    classDef external fill:#D3D3D3,stroke:#696969

    %% Click Events
    click HttpServer "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/util/HttpServer.java"
    click JsonUtil "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/util/Json.java"
    click ConfigurationManager "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/config/ConfigurationManager.java"
    click Configuration "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/config/Configuration.java"
    click HttpConfigEx "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/config/HttpConfigurationException.java"
    click ServerListener "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/core/ServerListenerThread.java"
    click WorkerThread "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/core/HttpConnectionWorkerThread.java"
    click WebRootHandler "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/core/io/WebRootHandler.java"
    click NotFoundEx "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/core/io/WebRootNotFoundException.java"
    click ReadFileEx "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/httpserver/core/io/ReadFileException.java"
    click HttpParser "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/HttpParser.java"
    click HttpRequest "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/HttpRequest.java"
    click HttpMessage "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/HttpMessage.java"
    click HttpMethod "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/HttpMethod.java"
    click HttpVersion "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/HttpVersion.java"
    click HttpStatusCode "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/HttpStatusCode.java"
    click HttpParseEx "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/HttpParsingException.java"
    click BadVersionEx "https://github.com/shatanshu3006/server-from-scratch/blob/main/src/main/java/com/coderfromscratch/http/BadHttpVersionException.java"
```
