# kriolos/kriolos-obiz architecture

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

- Interactive diagram: https://gitdiagram.com/kriolos/kriolos-obiz
- Repository: https://github.com/kriolos/kriolos-obiz

## Overview

##### Main components
- Build & CI environment
– GitHub Actions workflow (build.yml)
– Maven Wrapper & root `pom.xml` (multi-module aggregator)
- Maven modules (subprojects)
– application: core business logic & tests
– branding: NetBeans branding layer (NBM)
– kriolos-obiz-libs: shared libraries (je, krpos)
– kriolos-opos-nbm: POS UI + embedded web server (NBM)
– kriolos-obiz-suite: NetBeans RCP application aggregator
– unicenta-pos: integration or extension (placeholder)
- Runtime platform
– NetBeans Rich-Client Platform (core modules: window system, lifecycle, lookup)
– Deployed NBM modules: branding, application logic, POS UI/server
- Embedded server & handlers
– WebServer (HTTP listener)
– SaleDocHandler, SaleDoc (REST endpoints)

##### Relationships & interactions
- Build-time dependencies
– The root `pom.xml` declares modules → each submodule has its own `pom.xml`
– kriolos-obiz-suite depends on all NBM modules + NetBeans platform dependencies
– application, branding, kriolos-opos-nbm depend on kriolos-obiz-libs
- Runtime composition
– NetBeans Platform loads NBM modules (branding first, then core, then POS UI)
– POS UI components (PosTopComponent, SettingsTopComponent) invoke business APIs in application module
– POS UI also communicates (via HTTP) with the embedded WebServer in the same JVM
– Handlers in the server module process incoming requests, call into application/core libs for data manipulation

##### Architectural patterns & design principles
- Plugin modularity (NetBeans Platform)
- Separation of concerns
– UI layer (NBM GUI)
– Business logic (application module + shared libs)
– Infrastructure (embedded HTTP server module)
– Branding/theme (branding NBM)
- Maven multi-module structure for clear build isolation
- Use of NetBeans Lookup for loose coupling between modules

- Clear component labels (module names + roles)
– Build → packaging dependencies
– Module loading sequence in RCP
– Data flow (UI → core logic, UI → server, server → handler → libs)

## Diagram (Mermaid)

```mermaid
graph TB
  subgraph "Build & CI Environment"
    CI["GitHub Actions Workflow"]:::build
    Wrapper["Maven Wrapper & .mvn"]:::build
    RootPOM["Root pom.xml"]:::build
  end
  CI --> Wrapper
  CI --> RootPOM

  subgraph "Maven Modules"
    Application["application Module"]:::app
    Branding["branding Module"]:::app
    Libs["kriolos-obiz-libs Module"]:::lib
    subgraph "Sub-libraries"
      JE["je Submodule"]:::lib
      KRPOS["krpos Submodule"]:::lib
    end
    OPNBM["kriolos-opos-nbm Module"]:::ui
    Suite["kriolos-obiz-suite Module"]:::build
    Unicenta["unicenta-pos Module"]:::build
  end

  RootPOM --> Application
  RootPOM --> Branding
  RootPOM --> Libs
  RootPOM --> OPNBM
  RootPOM --> Suite
  RootPOM --> Unicenta

  Libs --> Application
  Libs --> OPNBM
  JE --> Libs
  KRPOS --> Libs

  Application --> Suite
  Branding --> Suite
  OPNBM --> Suite

  subgraph "Runtime: NetBeans Platform"
    NB["NetBeans RCP Kernel"]:::platform
    NB --> Branding
    NB --> Application
    NB --> OPNBM
  end

  Branding --> Application
  Application --> OPNBM

  subgraph "POS NBM Internals"
    PTC["PosTopComponent"]:::ui
    STC["SettingsTopComponent"]:::ui
    WS["WebServer"]:::server
    SDH["SaleDocHandler"]:::server
    SD["SaleDoc"]:::server
  end

  OPNBM --> PTC
  OPNBM --> STC
  OPNBM --> WS

  PTC -->|"calls"| Application
  PTC -->|"HTTP request"| WS
  STC -->|"calls"| Application

  WS --> SDH
  SDH --> SD
  SDH -->|"invokes"| Application

  click CI "https://github.com/kriolos/kriolos-obiz/blob/main/.github/workflows/build.yml"
  click Wrapper "https://github.com/kriolos/kriolos-obiz/tree/main/mvnw"
  click Wrapper "https://github.com/kriolos/kriolos-obiz/blob/main/mvnw.cmd"
  click Wrapper "https://github.com/kriolos/kriolos-obiz/tree/main/.mvn/wrapper/"
  click RootPOM "https://github.com/kriolos/kriolos-obiz/blob/main/pom.xml"
  click Application "https://github.com/kriolos/kriolos-obiz/blob/main/application/pom.xml"
  click Application "https://github.com/kriolos/kriolos-obiz/blob/main/application/src/test/java/io/github/kriolos/obiz/ApplicationTest.java"
  click Branding "https://github.com/kriolos/kriolos-obiz/blob/main/branding/pom.xml"
  click JE "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-obiz-libs/kriolos-obiz-libs-je/pom.xml"
  click KRPOS "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-obiz-libs/kriolos-obiz-libs-krpos/pom.xml"
  click Libs "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-obiz-libs/pom.xml"
  click OPNBM "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-opos-nbm/pom.xml"
  click PTC "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-opos-nbm/src/main/java/io/github/kriolos/opos/gui/PosTopComponent.java"
  click STC "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-opos-nbm/src/main/java/io/github/kriolos/opos/gui/SettingsTopComponent.java"
  click WS "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-opos-nbm/src/main/java/io/github/kriolos/opos/server/WebServer.java"
  click SD "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-opos-nbm/src/main/java/io/github/kriolos/opos/server/handlers/SaleDoc.java"
  click SDH "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-opos-nbm/src/main/java/io/github/kriolos/opos/server/handlers/SaleDocHandler.java"
  click Suite "https://github.com/kriolos/kriolos-obiz/blob/main/kriolos-obiz-suite/pom.xml"
  click Unicenta "https://github.com/kriolos/kriolos-obiz/tree/main/unicenta-pos/"

  classDef build fill:#cce5ff,stroke:#000
  classDef app fill:#ffe5b4,stroke:#000
  classDef lib fill:#e6ccff,stroke:#000
  classDef ui fill:#fff3cd,stroke:#000
  classDef server fill:#f8d7da,stroke:#000
  classDef platform fill:#d4edda,stroke:#000
```
