# ironbats/bpm-order-mngmt-system architecture

> Architecture diagram of the GitHub repository ironbats/bpm-order-mngmt-system, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ironbats/bpm-order-mngmt-system
- Repository: https://github.com/ironbats/bpm-order-mngmt-system

## Overview

##### Project type and purpose
- This is a backend‐focused, BPM-driven Order Management microservice.
- It uses Spring Boot for the API and business logic, Camunda BPM for process orchestration (BPMN workflows), Kafka for event-driven communication, and Docker for containerization.

##### File structure
- Top level:
- docker/compose-ui (Camunda UI + tools)
- docker/compose (service + Kafka + DB)
- src/main/java/com/bpm – packages for controller, service, repository, events, Camunda delegates, configuration.
- src/main/resources – application.yaml (configs), BPMN files (order-service-v4.bpmn, process.bpmn).
- Key patterns:
- Layered architecture (controller → service → repository)
- Event-driven sub-package (KafkaEventProducer/Consumer)
- BPM delegates (OrderCreated, OrderCancelled, incident handlers).

##### README
- Confirms tech stack: Camunda, Java 21, Spring Boot, Kafka, Docker.

##### Detail without over-splitting
- Package group (controller, service, repository, events, Camunda tasks) as its own component.
- Both the process definitions (.bpmn files) and their runtime host (Camunda engine).
- Database once, but annotate that it serves both the repository and the Camunda engine tables.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client/API Layer
    subgraph "Client/API Layer"
        Client["External Client"]:::client
    end

    %% Order Management Service
    subgraph "Order Management Service"
        App["Application"]:::service
        Controller["OrderController"]:::service
        DTO["OrderDTO"]:::service
        Model["Order"]:::service
        Service["OrderService"]:::service
        Repo["OrderRepository"]:::persistence
        CamundaConfig["CamundaConfiguration"]:::service
        KafkaConfig["KafkaConfig"]:::service

        subgraph "Camunda Engine"
            BPMN["BPMN Definitions\n(order-service-v4.bpmn, process.bpmn)"]:::service
            StartDelegate["OrderStartService"]:::service
            VerifyDelegate["OrderVerificationService"]:::service
            CreatedDelegate["OrderCreated"]:::service
            CancelledDelegate["OrderCancelled"]:::service
            IncidentHandler["OrderIncident"]:::service
        end

        subgraph "Event Components"
            Publisher["OrderPublishService"]:::messaging
            Producer["KafkaEventProducer"]:::messaging
            Consumer["KafkaEventConsumer"]:::messaging
        end
    end

    %% Messaging Infrastructure
    subgraph "Kafka Cluster"
        OrderCreatedTopic["Topic: order.created"]:::messaging
        OrderCancelledTopic["Topic: order.cancelled"]:::messaging
    end

    %% Persistence
    subgraph "Database"
        DB["Relational DB\n(Order + Camunda Tables)"]:::persistence
    end

    %% Containerization
    subgraph "Docker Compose Stacks"
        ServiceStack["Service + Kafka + DB"]:::infra
        CamundaUIStack["Camunda UI & Tools"]:::infra
    end

    %% Data Flows
    Client -->|"HTTP POST/GET"| Controller
    Controller -->|"calls"| Service
    Service -->|"uses DTO"| DTO
    Service -->|"manages entity"| Model
    Service -->|"CRUD operations"| Repo
    Repo -->|"reads/writes"| DB

    Service -->|"start process"| CamundaConfig
    CamundaConfig -->|"deploy definitions"| BPMN
    CamundaConfig -->|"uses DB"| DB

    Service -->|"invoke task"| StartDelegate
    StartDelegate -->|"invoke"| VerifyDelegate
    VerifyDelegate -->|"on verification complete"| CreatedDelegate
    CreatedDelegate -->|"publish event"| Publisher
    CancelledDelegate -->|"handle cancel"| IncidentHandler

    Publisher -->|"calls"| Producer
    Producer -->|"send message"| OrderCreatedTopic
    OrderCreatedTopic -->|"consume"| Consumer
    Consumer -->|"trigger process"| StartDelegate
    Consumer -->|"update state"| Repo

    %% Container Relationships
    ServiceStack -.-> Service
    ServiceStack -.-> OrderCreatedTopic
    ServiceStack -.-> DB
    CamundaUIStack -.-> BPMN

    %% Click Events
    click App "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/Application.java"
    click Controller "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/controller/OrderController.java"
    click Service "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/service/OrderService.java"
    click DTO "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/dto/OrderDTO.java"
    click Model "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/model/Order.java"
    click Repo "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/repository/OrderRepository.java"
    click CamundaConfig "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/config/CamundaConfiguration.java"
    click KafkaConfig "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/config/KafkaConfig.java"
    click BPMN "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/resources/order-service-v4.bpmn"
    click StartDelegate "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/camunda/OrderStartService.java"
    click VerifyDelegate "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/camunda/OrderVerificationService.java"
    click CreatedDelegate "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/camunda/OrderCreated.java"
    click CancelledDelegate "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/camunda/OrderCancelled.java"
    click IncidentHandler "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/camunda/OrderIncident.java"
    click Publisher "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/events/OrderPublishService.java"
    click Producer "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/events/KafkaEventProducer.java"
    click Consumer "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/src/main/java/com/bpm/events/KafkaEventConsumer.java"
    click ServiceStack "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/docker/compose/docker-compose.yaml"
    click CamundaUIStack "https://github.com/ironbats/bpm-order-mngmt-system/blob/main/docker/compose-ui/docker-compose.yaml"

    %% Styles
    classDef client fill:#b3cde0,stroke:#333,stroke-width:1px
    classDef service fill:#ccebc5,stroke:#333,stroke-width:1px
    classDef messaging fill:#fdae61,stroke:#333,stroke-width:1px
    classDef persistence fill:#f2f2f2,stroke:#333,stroke-width:1px
    classDef infra fill:#d9d9d9,stroke:#333,stroke-width:1px
```
