# gaetanopiazzolla/spring-event-notification architecture

> Architecture diagram of the GitHub repository gaetanopiazzolla/spring-event-notification, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gaetanopiazzolla/spring-event-notification
- Repository: https://github.com/gaetanopiazzolla/spring-event-notification

## Overview

Project Type: This is a Spring-based application implementing the Event Notification Pattern, focusing on database operations and event handling.

##### Core Components
- Controller Layer (BookController)
- Service Layer (BookService)
- Repository Layer (BookRepository)
- Domain Layer (Book entity)
- Event Infrastructure
- ApplicationEventQueue
- Event Listeners
- Event Publishers

##### Event Flow Components
- EntityListener (BookEntityListener)
- Event Types (DataChangeEvent)
- Operation Types (OperationType)
- Event Notification Configuration
- Transaction Synchronization

##### Component Relationships
a. Client Request → BookController
b. BookController → BookService
c. BookService → BookRepository
d. BookRepository → Database
e. Entity Changes → BookEntityListener
f. BookEntityListener → ApplicationEventQueue
g. ApplicationEventQueue → Event Listeners
h. Transaction Synchronization → Event Publishing

##### Symbols
- Rectangles: Components/Services
- Circles: Events
- Diamonds: Decision Points

##### Specific Elements
- Request/Response Flow
- Transaction Boundaries
- Event Generation Points
- Event Consumer Points
- Configuration Validation Flow
- Thread Local Management

##### Additional Details
- Notes about transaction management
- Error handling paths
- Async vs sync operations

Key Architectural Patterns to Highlight:
##### Transaction Synchronization

Level of Detail:
- Keep main components visible at a glance
- Critical configuration points
- Integration points between components

Remember to:
- Make the event flow clearly visible
- Transaction boundaries
- Where thread local context is managed
- Where configuration validation occurs
- Relationship between entity changes and event generation

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef web fill:#3498db,stroke:#2980b9,color:white
    classDef service fill:#2ecc71,stroke:#27ae60,color:white
    classDef repo fill:#f1c40f,stroke:#f39c12,color:black
    classDef event fill:#e74c3c,stroke:#c0392b,color:white
    classDef config fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef aspect fill:#9b59b6,stroke:#8e44ad,color:white
    classDef database fill:#34495e,stroke:#2c3e50,color:white
    classDef entity fill:#1abc9c,stroke:#16a085,color:white

    %% Components
    Client(("Client Request"))
    DB[(Database)]:::database

    subgraph WebLayer["Web Layer"]
        BC["BookController"]:::web
        ENRBA["EventNotificationResponseBodyAdvice"]:::web
        WC["WebConfig"]:::config
    end

    subgraph ServiceLayer["Service Layer"]
        BS["BookService"]:::service
        AEQ["ApplicationEventQueue"]:::event
    end

    subgraph RepositoryLayer["Repository Layer"]
        BR["BookRepository"]:::repo
    end

    subgraph DomainLayer["Domain Layer"]
        BE["Book Entity"]:::entity
        BEL["BookEntityListener"]:::event
    end

    subgraph EventInfrastructure["Event Infrastructure"]
        DCE["DataChangeEvent"]:::event
        OT["OperationType"]:::event
        UEL["UpdateEventListener"]:::event
    end

    subgraph CrossCuttingConcerns["Cross-Cutting Concerns"]
        TSA["TransactionSynchronizationAspect"]:::aspect
        TLCI["ThreadLocalClearingInterceptor"]:::aspect
        ENCV["EventNotificationConfigValidator"]:::config
    end

    %% Relationships
    Client --> BC
    BC --> BS
    BS --> BR
    BR --> DB
    BE --> BEL
    BEL --> AEQ
    AEQ --> UEL
    TSA -.-> BS
    TLCI -.-> BC
    ENCV -.-> WC
    BC --> ENRBA
    BEL --> DCE
    DCE --> OT

    %% Click Events
    click BC "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/BookController.java"
    click BS "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/service/BookService.java"
    click BR "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/domain/BookRepository.java"
    click BE "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/domain/Book.java"
    click BEL "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/domain/BookEntityListener.java"
    click AEQ "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/service/ApplicationEventQueue.java"
    click UEL "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/listener/UpdateEventListener.java"
    click DCE "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/service/DataChangeEvent.java"
    click OT "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/service/OperationType.java"
    click TSA "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/publisher/TransactionSynchronizationAspect.java"
    click ENCV "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/config/EventNotificationConfigValidator.java"
    click TLCI "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/config/ThreadLocalClearingInterceptor.java"
    click ENRBA "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/publisher/EventNotificationResponseBodyAdvice.java"
    click WC "https://github.com/GaetanoPiazzolla/spring-event-notification/blob/master/src/main/java/gae/piaz/pattern/events/config/WebConfig.java"

    %% Legend
    subgraph Legend
        WebComp["Web Component"]:::web
        ServiceComp["Service Component"]:::service
        RepoComp["Repository Component"]:::repo
        EventComp["Event Component"]:::event
        ConfigComp["Configuration Component"]:::config
        AspectComp["Aspect Component"]:::aspect
        EntityComp["Entity Component"]:::entity
    end
```
