How savire/voxloud-provisioning-hw works
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.