# savire/voxloud-provisioning-hw architecture

> Architecture diagram of the GitHub repository savire/voxloud-provisioning-hw, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/savire/voxloud-provisioning-hw
- Repository: https://github.com/savire/voxloud-provisioning-hw

## Overview

##### Project type and purpose
- This is a Spring-Boot microservice (backend) that implements a RESTful provisioning server for VoIP devices.
- Its sole purpose is to accept HTTP GET calls from devices (by MAC address), look up the inventory in a relational store, generate a device-specific configuration file (properties or JSON), merge in any user-override fragments, and return it or an HTTP error.

##### File structure
- Top-level:
- pom.xml – Maven build/dependencies
- src/main/java/com/voxloud/provisioning – Java code following a layered pattern
- src/main/resources – application.properties, bootstrap.yml, SQL data-seed, logging config
- src/test/java – unit tests for controller
- Package breakdown:
- controller – REST API entrypoint (ProvisioningController)
- service – business logic interface and implementation (ProvisioningService, ProvisioningServiceImpl)
- repository – Spring Data JPA (DeviceRepository)
- entity – JPA domain (Device)
- application main – SpringBootApplication class
- Configuration: uses H2 in-memory DB with data.sql for seed, backed by application.properties/bootstrap.yml.

##### README for additional insights
- Two device types (Desk, Conference) with different output formats (Properties vs JSON).
- Requirement for override fragments stored in the database and merged at runtime.
- Extensible design is expected (support for adding new device types with minimal changes).

##### Final recommendations
- Be as detailed as possible: capture every Java package/module, every external dependency, and each data flow.
- Keep it versioned: store it alongside the README so new contributors immediately see the architecture.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Clients
    subgraph "External Clients"  
        direction TB
        DevicesCloud(("Desk & Conference Devices")):::external
    end

    %% Application Entry
    subgraph "Application Startup"
        direction TB
        App["ProvisioningApplication"]:::application
    end

    %% Configuration Resources
    subgraph "Configuration"  
        direction TB
        AppProps["application.properties"]:::config
        BootstrapYml["bootstrap.yml"]:::config
        DataSQL["data.sql"]:::config
        Logback["logback-spring.xml"]:::config
    end

    %% H2 Database and Console
    subgraph "Database Infrastructure"
        direction TB
        H2Console(("H2 Console")):::external
        H2DB[(H2 In-Memory DB)]:::db
    end

    %% Core Layers
    subgraph "Microservice Layers"
        direction TB
        Controller["ProvisioningController"]:::controller
        ServiceImpl["ProvisioningServiceImpl"]:::service
        ServiceIntf["ProvisioningService (interface)"]:::service
        Repository["DeviceRepository"]:::repository
        Entity["Device"]:::entity
        subgraph "Formatter Strategies" 
            direction TB
            PropFormatter["PropertiesFormatter"]:::plugin
            JsonFormatter["JsonFormatter"]:::plugin
        end
    end

    %% Build and Tests
    subgraph "Build & Test"
        direction TB
        Maven["pom.xml"]:::build
        ControllerTest["ProvisioningControllerTest"]:::test
    end

    %% Legend omitted

    %% Relationships
    DevicesCloud -->|"/api/v1/provisioning/{mac}"| Controller
    App -->|starts| Controller
    Controller -->|"getConfiguration(mac)"| ServiceIntf
    ServiceIntf -->|impl by| ServiceImpl
    ServiceImpl -->|"queryDeviceByMac(mac)"| Repository
    Repository -->|"JPA CRUD"| H2DB
    ServiceImpl -->|"loadProperties()"| AppProps
    ServiceImpl -->|"loadProperties()"| BootstrapYml
    ServiceImpl -->|"mergeOverrides()"| DataSQL
    ServiceImpl -->|"format by type"| PropFormatter
    ServiceImpl -->|"format by type"| JsonFormatter
    ServiceImpl -->|uses entity| Entity
    H2Console -->|"JDBC"| H2DB
    Controller -->|unit tests| ControllerTest
    App -->|built by| Maven

    %% Click Events
    click Controller "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/java/com/voxloud/provisioning/controller/ProvisioningController.java"
    click ServiceIntf "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/java/com/voxloud/provisioning/service/ProvisioningService.java"
    click ServiceImpl "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/java/com/voxloud/provisioning/service/ProvisioningServiceImpl.java"
    click Repository "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/java/com/voxloud/provisioning/repository/DeviceRepository.java"
    click Entity "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/java/com/voxloud/provisioning/entity/Device.java"
    click App "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/java/com/voxloud/provisioning/ProvisioningApplication.java"
    click AppProps "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/resources/application.properties"
    click BootstrapYml "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/resources/bootstrap.yml"
    click DataSQL "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/resources/data.sql"
    click Logback "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/main/resources/logback-spring.xml"
    click Maven "https://github.com/savire/voxloud-provisioning-hw/blob/main/pom.xml"
    click ControllerTest "https://github.com/savire/voxloud-provisioning-hw/blob/main/src/test/java/com/voxloud/provisioning/ProvisioningControllerTest.java"

    %% Styles
    classDef external fill:#E3F2FD,stroke:#2196F3,color:#0D47A1;
    classDef application fill:#FFF3E0,stroke:#FB8C00,color:#E65100;
    classDef config fill:#E8F5E9,stroke:#43A047,color:#1B5E20;
    classDef db fill:#F3E5F5,stroke:#8E24AA,color:#4A148C;
    classDef controller fill:#E1F5FE,stroke:#039BE5,color:#01579B;
    classDef service fill:#FCE4EC,stroke:#EC407A,color:#880E4F;
    classDef repository fill:#FFF8E1,stroke:#FFB300,color:#FF6F00;
    classDef entity fill:#E0F2F1,stroke:#009688,color:#004D40;
    classDef plugin fill:#ECEFF1,stroke:#90A4AE,color:#37474F,stroke-dasharray: 5 5;
    classDef build fill:#EDE7F6,stroke:#5E35B1,color:#311B92;
    classDef test fill:#FFEBEE,stroke:#E53935,color:#B71C1C;
```
