# a-h-software-house-inc/accesscontroladaptersample architecture

> Architecture diagram of the GitHub repository a-h-software-house-inc/accesscontroladaptersample, 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/a-h-software-house-inc/accesscontroladaptersample
- Repository: https://github.com/a-h-software-house-inc/accesscontroladaptersample

## Overview

##### Project Type & Purpose
- Type: A headless Windows‐service HTTP adapter (C#/.NET) that bridges a 3rd-party AccessControl system (emulated) with a Video Management System (VMS).
- Purpose: Polls the AccessControl system, caches data, implements the `IAccessControlAdapter` interface to expose REST endpoints, and pushes event notifications back into the VMS integration.

##### High-Level Components
a. External Access Control System (SimpleAccessControlEmulator)
b. Data Acquisition & Caching
- AccessControlDataUpdater (poller)
- AccessControlDataCache (in‐memory store)
c. Adapter Core
- IAccessControlAdapter interface + AccessControlAdapter implementation
- Domain models: AccessControlData/*, AdapterData/*
d. HTTP Server Layer
- HttpServer
- HttpRequestHandlers
e. Notifications Subsystem
- NotificationsManager (INotificationsManager)
f. Configuration & Logging
- appsettings.json / AccessControlAdapterSettings.json
- Logging.cs
g. Service Host & Deployment
- Program.cs (bootstraps HTTP server, DI, logging)
- Windows Service wrapper (sc.exe install)

##### Interactions & Data Flows
1. On startup (Program.cs):
– Read configuration → initialize Logging, Settings, DI container.
– Start HttpServer (listening on configured HTTP/HTTPS ports).
– Start DataUpdater polling loop.
– Initialize NotificationsManager.
2. DataUpdater polls External AccessControl Emulator via host/port → maps raw AccessControlData.* → updates AccessControlDataCache.
3. VMS (client) sends HTTP requests to the Adapter’s REST API endpoints (GetItems, GetUsers, GetEvents, etc.).
– HttpServer routes to HttpRequestHandlers → calls methods on AccessControlAdapter → reads from DataCache / executes actions via Adapter logic → returns JSON responses (using AdapterData.* DTOs).
4. When events occur (poller loops detect new events), FireAccessControlEvents is invoked → pushes notifications via NotificationsManager back to the VMS (e.g., via HTTP callback or push subscription).
5. ExecuteSystemAction / ExecuteItemAction methods on the adapter invoke commands back to the AccessControl system (through DataUpdater or direct API calls), returning success/failure.

##### Architectural Patterns & Principles
- Layered architecture:
– Data Layer (poller + cache)
– Adapter/Service Layer (business logic implementing IAccessControlAdapter)
– Presentation/API Layer (HTTP server + handlers)
– Notifications Layer
- Dependency Injection for loose coupling (Program.cs).
- Configuration externalized via JSON files.
- Interface‐based design (IAccessControlAdapter, INotificationsManager).
- Separation of concerns: polling vs. request‐serving vs. event‐pushing.

##### Checklist
[ ] Main external systems (VMS, AccessControl Emulator)
[ ] DataUpdater & DataCache
[ ] AccessControlAdapter core (interface + implementation)
[ ] HTTP Server & Handlers
[ ] NotificationsManager
[ ] Configuration files & logging subsystem
[ ] Clear component labels and port numbers where applicable

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Systems
    subgraph "External Systems" 
        direction TB
        Emulator["SimpleAccessControlEmulator"]:::external
        VMS["Video Management System (VMS)"]:::external
    end

    %% Data Layer
    subgraph "Data Layer" 
        direction TB
        Updater["AccessControlDataUpdater"]:::data
        Cache["AccessControlDataCache"]:::data
        Models["AccessControlData Models"]:::data
    end

    %% Adapter Core
    subgraph "Adapter Core" 
        direction TB
        Interface["IAccessControlAdapter"]:::adapter
        Impl["AccessControlAdapter"]:::adapter
        DTOs["AdapterData DTOs"]:::adapter
    end

    %% HTTP/API Layer
    subgraph "HTTP/API Layer" 
        direction TB
        Server["HttpServer"]:::api
        Handlers["HttpRequestHandlers"]:::api
    end

    %% Notifications
    subgraph "Notifications Layer" 
        direction TB
        NotifInterface["INotificationsManager"]:::notifications
        NotifManager["NotificationsManager"]:::notifications
    end

    %% Configuration & Logging
    subgraph "Configuration & Logging" 
        direction TB
        AppSettings["appsettings.json"]:::config
        DevSettings["appsettings.Development.json"]:::config
        AdapterSettings["AccessControlAdapterSettings.json"]:::config
        ServiceSettings["ServiceSettings.cs"]:::config
        Logging["Logging.cs"]:::config
        Cert["cert.pfx"]:::config
    end

    %% Service Host & Deployment
    subgraph "Service Host & Deployment"
        direction TB
        Program["Program.cs"]:::host
        ServiceWrapper["AccessControlAdapterService.cs"]:::host
    end

    %% Flows
    Emulator -->|polls| Updater
    Updater -->|updates| Cache
    Cache -->|provides data| Impl
    Interface -->|implemented by| Impl
    Impl -->|uses DTOs| DTOs
    VMS -->|HTTP requests| Server
    Server -->|routes| Handlers
    Handlers -->|calls| Impl
    Impl -->|reads/writes| Cache
    Impl -->|executes actions| Updater
    Updater -->|detects events| NotifManager
    NotifManager -->|pushes notifications| VMS

    %% Startup Flow
    Program -->|boots| Server
    Program -->|boots| Updater
    Program -->|boots| NotifManager
    Program -->|configures| AppSettings
    Program -->|configures| AdapterSettings
    Program -->|configures| DevSettings
    Program -->|configures| ServiceSettings
    Program -->|initializes| Logging
    Program -->|loads certificate| Cert
    ServiceWrapper -->|wraps| Program

    %% Legend
    subgraph Legend
        direction TB
        L1["Data Layer"]:::data
        L2["Adapter Core"]:::adapter
        L3["HTTP/API Layer"]:::api
        L4["Notifications"]:::notifications
        L5["External/Config"]:::external
    end

    %% Click Events
    click Updater "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlDataUpdater.cs"
    click Cache "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlDataCache.cs"
    click Models "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlData/CardHolderData.cs"
    click Models "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlData/DoorData.cs"
    click Models "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlData/EventDescData.cs"
    click Models "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlData/FireEventData.cs"
    click Models "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlData/OutputData.cs"
    click Models "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlData/PartitionData.cs"
    click Models "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlData/ZoneData.cs"
    click Interface "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/Adapter/IAccessControlAdapter.cs"
    click Impl "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/Adapter/AccessControlAdapter.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/ActionData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/EntityData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/EventData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/InfoData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/ItemData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/NotificationData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/ParameterData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/ResponseData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/StateData.cs"
    click DTOs "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AdapterData/UserData.cs"
    click Server "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/HttpServer.cs"
    click Handlers "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/HttpRequestHandlers.cs"
    click NotifInterface "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/Notifications/INotificationsManager.cs"
    click NotifManager "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/Notifications/NotificationsManager.cs"
    click AppSettings "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/appsettings.json"
    click DevSettings "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/appsettings.Development.json"
    click AdapterSettings "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlAdapterSettings.json"
    click ServiceSettings "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/ServiceSettings.cs"
    click Logging "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/Logging.cs"
    click Program "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/Program.cs"
    click ServiceWrapper "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/AccessControlAdapterService.cs"
    click Cert "https://github.com/a-h-software-house-inc/accesscontroladaptersample/blob/main/Source/Certificate/cert.pfx"

    %% Styles
    classDef data fill:#d0e7ff,stroke:#3399ff,color:#000;
    classDef adapter fill:#d0ffd6,stroke:#33cc33,color:#000;
    classDef api fill:#ffe0b3,stroke:#ff9933,color:#000;
    classDef notifications fill:#f0d6ff,stroke:#9933cc,color:#000;
    classDef external fill:#e0e0e0,stroke:#999999,color:#000;
    classDef config fill:#e0e0e0,stroke:#999999,color:#000;
    classDef host fill:#f2f2f2,stroke:#666666,color:#000;
```
