# aastha22j02/addressbook-cicd-project architecture

> Architecture diagram of the GitHub repository aastha22j02/addressbook-cicd-project, 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/aastha22j02/addressbook-cicd-project
- Repository: https://github.com/aastha22j02/addressbook-cicd-project

## Overview

##### Project type and purpose
- This is a Java-based, full-stack web application tutorial built with the Vaadin Framework.
- It demonstrates an address book UI (frontend) backed by a simple service layer and in-memory data model (backend).
- The build and deployment are managed via Maven (pom.xml, build.xml, build.properties) and can run on Jetty or Tomcat.

##### File structure
- Top-level build files: pom.xml, build.xml, build.properties, Jenkinsfile(s).
- Source code under src/main/java/com/edurekademo:
- tutorial/addressbook: UI classes (AddressbookUI.java, ContactForm.java)
- tutorial/addressbook/backend: domain model (Contact.java) and service (ContactService.java)
- helper & utilities: resource bundles, comparators, converters, logger, property loader.
- PMD rules under src/main/pmd for static analysis.
- Tests under src/test/java/com/edurekademo/utilities.
- No external database—data is held in memory via ContactService.

##### README for additional insights
- Confirms Vaadin UI, Java 8 requirement, Maven build, Jetty/Tomcat deployment.
- No mention of persistent storage—pure in-memory example.
- Indicates tutorial nature (not production grade).

##### Diagramming the architecture
- Web Browser (Client)
- Vaadin UI Layer
- AddressbookUI
- ContactForm
- Service Layer (ContactService)
- Domain Model (Contact)
- In-Memory Data Store (List<Contact>)
- Utilities Layer (comparators, converters, resource bundle, logger)
- Build and CI/CD (Maven, PMD, Jenkins)
- Application Server (Jetty or Tomcat)

- Browser ↔ HTTP ↔ Vaadin UI Layer
- UI Layer → calls → Service Layer
- Service Layer → reads/writes → In-Memory Data Store
- Service & UI → use → Utilities Layer for logging, i18n, conversion
- CI/CD Pipeline → triggers → Maven build → PMD static analysis → Docker/Tomcat deploy

c. Architectural patterns and principles
- Layered architecture: Presentation → Service → Domain/Data
- Dependency inversion: UI and Service depend on generic utility interfaces
- In-memory repository (no external DB) for tutorial simplicity

d. Key technologies
- Java 8, Vaadin Framework
- Maven (pom.xml), Ant (build.xml), Jenkins pipelines (Jenkinsfile)
- PMD for code quality
- Jetty/Tomcat for deployment

## Diagram (Mermaid)

```mermaid
graph TD
    Browser["Web Browser"]:::external
    HTTP["HTTP"]:::external

    subgraph "Vaadin UI Layer"
        UI["AddressbookUI"]:::frontend
        Form["ContactForm"]:::frontend
    end

    subgraph "Service Layer"
        Service["ContactService"]:::backend
    end

    subgraph "Domain Model"
        Model["Contact"]:::backend
    end

    DataStore["In-Memory Data Store\n(List<Contact>)"]:::data

    subgraph "Utilities Layer"
        RB["GenericResourceBundle"]:::utils
        GC["GenericComparator"]:::utils
        CIC["CaseInsensitiveComparator"]:::utils
        Conv["HexAsciiConvertor"]:::utils
        Log["LoggerStackTraceUtil"]:::utils
        PH["PropertyHelper"]:::utils
        PL["PropertyLoader"]:::utils
        SU["StringUtilities"]:::utils
        PT["PrepareTargetMethod"]:::utils
    end

    subgraph "Build & CI/CD"
        Maven["pom.xml"]:::ci
        Ant["build.xml\nbuild.properties"]:::ci
        Jenkins["Jenkinsfile(s)"]:::ci
        subgraph "PMD Rules"
            R1["ruleset_basics.xml"]:::ci
            R2["ruleset_j2ee.xml"]:::ci
            R3["ruleset_security.xml"]:::ci
            R4["pmd.xsl"]:::ci
        end
    end

    subgraph "Tests"
        T1["ExceptionThrower"]:::test
        T2["TestGenericComparator"]:::test
        T3["TestHexAsciiConversion"]:::test
        T4["TestLogger"]:::test
        T5["UnitDTO"]:::test
        TR["Dateformat.properties"]:::test
    end

    Server["Application Server\n(Jetty/Tomcat)"]:::infra

    %% Connections
    Browser --> HTTP --> UI
    UI -->|"calls"| Service
    Service -->|"manages"| DataStore
    UI -->|"uses"| RB
    UI -->|"uses"| GC
    UI -->|"uses"| CIC
    UI -->|"uses"| Conv
    UI -->|"uses"| Log
    UI -->|"uses"| PH
    UI -->|"uses"| PL
    UI -->|"uses"| SU
    UI -->|"uses"| PT
    Service -->|"uses"| Log
    Service -->|"uses"| PL
    Jenkins -->|"triggers"| Maven
    Maven -->|"runs PMD"| R1
    Maven --> R2
    Maven --> R3
    Maven --> R4
    Maven -->|"packages WAR"| Server
    Tests -->|"test utilities"| GC
    Tests -->|"test converters"| Conv
    Tests -->|"test logger"| Log

    %% Click Events
    click UI "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/tutorial/addressbook/AddressbookUI.java"
    click Form "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/tutorial/addressbook/ContactForm.java"
    click Service "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/tutorial/addressbook/backend/ContactService.java"
    click Model "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/tutorial/addressbook/backend/Contact.java"
    click RB "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/helper/GenericResourceBundle.java"
    click GC "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/GenericComparator.java"
    click CIC "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/CaseInsensitiveComparator.java"
    click Conv "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/HexAsciiConvertor.java"
    click Log "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/LoggerStackTraceUtil.java"
    click PH "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/PropertyHelper.java"
    click PL "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/PropertyLoader.java"
    click SU "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/StringUtilities.java"
    click PT "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/java/com/edurekademo/utilities/PrepareTargetMethod.java"
    click Maven "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/pom.xml"
    click Ant "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/build.xml\nbuild.properties"
    click Jenkins "https://github.com/aastha22j02/addressbook-cicd-project/tree/master/Jenkinsfile"
    click R1 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/pmd/ruleset_basics.xml"
    click R2 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/pmd/ruleset_j2ee.xml"
    click R3 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/pmd/ruleset_security.xml"
    click R4 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/main/pmd/pmd.xsl"
    click T1 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/test/java/com/edurekademo/utilities/ExceptionThrower.java"
    click T2 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/test/java/com/edurekademo/utilities/TestGenericComparator.java"
    click T3 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/test/java/com/edurekademo/utilities/TestHexAsciiConversion.java"
    click T4 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/test/java/com/edurekademo/utilities/TestLogger.java"
    click T5 "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/test/java/com/edurekademo/utilities/UnitDTO.java"
    click TR "https://github.com/aastha22j02/addressbook-cicd-project/blob/master/src/test/resources/Dateformat.properties"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#2780E3,color:#000;
    classDef backend fill:#DFFFE0,stroke:#3BA935,color:#000;
    classDef data fill:#E8E8E8,stroke:#999,color:#000,shape:cylinder;
    classDef utils fill:#FFF4E5,stroke:#E08A00,color:#000;
    classDef ci fill:#F0F0F0,stroke:#666,color:#000;
    classDef test fill:#F5E0FF,stroke:#9C27B0,color:#000;
    classDef infra fill:#E8E8E8,stroke:#777,color:#000;
    classDef external fill:#FFFFFF,stroke:#333,color:#000;
```
