Skip to content

Technical Frameworks Architecture

The Cadastral Information System (CIS) backend (cis-api-uam) is built upon modular, resilient, and enterprise-grade technical frameworks. These foundational frameworks govern cross-cutting concerns across all cadastral business domains (Reservation, Lodgement, Examination, Maintenance, and Archive).


Core Frameworks Summary

Framework Package Namespace Primary Responsibilities Key Capabilities
Dynamic Error Framework com.dw.ngms.cis.framework.error Business validation, infrastructure exception translation, dynamic error responses Zero hardcoded enums, \(O(1)\) concurrent in-memory caching, dual-channel resolution (ui vs api), dynamic template rendering, deep recursive PII redaction, RFC 9457 ProblemDetail.
Reporting Engine com.dw.ngms.cis.reporting Analytical report generation, background export scheduling, bounded CSV streaming, PDF layout Asynchronous export job queue, bounded chunked streaming, scope-based authorization, rate-limited download slots, multi-tenant province filtering.
Notification Engine com.dw.ngms.cis.service.notification Multi-channel messaging, durable outbox delivery, document attachments Multi-channel delivery (EMAIL, SMS, PDF), Redis-backed distributed idempotency, fail-fast strategy registries, audit ledger logging, transactional outbox queue.

Architectural Interaction Model

flowchart TD
    subgraph Client_Layer [Client Applications & Gateways]
        ANGULAR["Angular Frontend (cis-internal / cis-web)"]
        BFF["cis-bff (Backend-For-Frontend)"]
    end

    subgraph Business_Domains [Cadastral Business Modules]
        RES["Reservation Module"]
        LODGE["Lodgement Module"]
        EXAM["Examination Module"]
        MAINT["Maintenance Module"]
        ARCH["Archive Module"]
    end

    subgraph Technical_Frameworks [Enterprise Technical Frameworks]
        direction TB

        subgraph Error_Framework [1. Error Handling Framework]
            ERR_SVC["ErrorMessageService"]
            ERR_REG["ErrorCodeRegistry (In-Memory O(1))"]
            ERR_ADVICE["ExceptionHandlerAdvice"]
            ERR_REDACT["RedactionService"]
        end

        subgraph Report_Framework [2. Reporting Engine]
            REP_JOB["ReportJobService & Scheduler"]
            REP_BUILDER["DynamicQueryBuilder"]
            REP_STREAM["Bounded CsvArtifactWriter"]
            REP_PDF["PdfArtifactRenderer"]
        end

        subgraph Notif_Framework [3. Notification Engine]
            NOTIF_GW["NotificationFrameworkGateway"]
            NOTIF_QUEUE["Durable Outbox Queue Worker"]
            NOTIF_IDEMP["Redis Renewable Idempotency"]
            NOTIF_CHANNELS["Channels: EMAIL, SMS, PDF"]
        end
    end

    subgraph Infrastructure_Layer [Storage & Persistence]
        ORACLE[("Oracle 23 Database (SGUSER)")]
        REDIS[("Redis 7.4 Distributed Cache")]
        S3[("RustFS S3 Object Storage")]
        MAIL[("SMTP Mail Gateway")]
    end

    %% Client Ingress
    ANGULAR & BFF --> Business_Domains

    %% Error Flow
    Business_Domains -->|throws BusinessException| ERR_ADVICE
    ERR_ADVICE --> ERR_SVC
    ERR_SVC --> ERR_REG
    ERR_SVC --> ERR_REDACT
    ERR_REG -.->|startup / refresh| ORACLE
    ERR_ADVICE -->|HTTP 400, 422, 500 JSON| ANGULAR & BFF

    %% Reporting Flow
    Business_Domains & ANGULAR -->|request export / schedule job| REP_JOB
    REP_JOB --> REP_BUILDER
    REP_BUILDER --> ORACLE
    REP_JOB --> REP_STREAM & REP_PDF
    REP_STREAM & REP_PDF --> S3

    %% Notification Flow
    Business_Domains -->|trigger event / process step| NOTIF_GW
    NOTIF_GW --> NOTIF_IDEMP
    NOTIF_IDEMP --> REDIS
    NOTIF_GW --> NOTIF_QUEUE
    NOTIF_QUEUE --> NOTIF_CHANNELS
    NOTIF_CHANNELS --> MAIL & S3 & ORACLE

Detailed Framework References

Explore the detailed architecture, database schemas, sequence workflows, and developer guides: