# spring-projects/spring-pulsar architecture

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

- Interactive diagram: https://gitdiagram.com/spring-projects/spring-pulsar
- Repository: https://github.com/spring-projects/spring-pulsar

## Overview

##### Main Components

a. Core Components:
- PulsarTemplate (Main API for message production)
- PulsarListener (Message consumption)
- PulsarAdmin (Administration operations)
- Transaction Management
- Schema Management
- Topic Management

b. Integration Components:
- Spring Configuration Layer
- Spring Boot Auto-configuration
- Spring Transaction Management
- Spring Event Publishing
- Observation/Metrics Integration

c. Reactive Support:
- ReactivePulsarTemplate
- ReactivePulsarListener
- Reactive Transaction Management

##### Component Relationships

**┌─ Application Layer ─────────────────────────────────────┐**
- @PulsarListener  │ @EnablePulsar │ PulsarTemplate APIs │
- Spring Integration Layer ─────────────────────────────┤
- Configuration   │ Event Publishing │ Transaction Mgmt  │
- Core Implementation Layer ───────────────────────────┤
- Producer/Consumer│ Admin Operations│ Schema Resolution │
- Infrastructure Layer ──────────────────────────────┤
- Connection Management │ Caching │ Error Handling    │
- Apache Pulsar ──────────────────────────────────┘

##### Key Features to Highlight

a. Message Flow:
- Producer path (application → PulsarTemplate → Pulsar)
- Consumer path (Pulsar → PulsarListener → application)
- Transaction boundaries
- Error handling paths

b. Configuration Flow:
- Spring Boot auto-configuration
- Manual configuration options
- Property resolution

c. Management Features:
- Admin operations
- Monitoring/metrics
- Health checks

##### Specialized Components

Dedicated sections for:
- Cache providers (Caffeine implementation)
- Test support utilities
- Sample application patterns
- Function management

##### Integration Points

Connections to:
- Spring Framework core
- Spring Boot
- Spring Transaction
- Spring Observation
- Apache Pulsar client

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Application Layer"
        AL1["@PulsarListener"]:::annotation
        AL2["@EnablePulsar"]:::annotation
        AL3["PulsarTemplate APIs"]:::api
        AL4["ReactivePulsarTemplate"]:::reactive
        AL5["ReactivePulsarListener"]:::reactive
    end

    subgraph "Spring Integration Layer"
        SI1["Configuration"]:::spring
        SI2["Event Publishing"]:::spring
        SI3["Transaction Management"]:::spring
        SI4["Observation/Metrics"]:::spring
    end

    subgraph "Core Implementation Layer"
        CI1["Producer/Consumer"]:::core
        CI2["Admin Operations"]:::core
        CI3["Schema Resolution"]:::core
        CI4["Topic Resolution"]:::core
        CI5["Message Conversion"]:::core
    end

    subgraph "Infrastructure Layer"
        IL1["Connection Management"]:::infra
        IL2["Caffeine Cache"]:::infra
        IL3["Error Handling"]:::infra
        IL4["Test Support"]:::infra
    end

    subgraph "Apache Pulsar"
        AP["Pulsar Broker"]:::external
    end

    %% Relationships
    AL1 --> SI1
    AL2 --> SI1
    AL3 --> CI1
    AL4 --> CI1
    AL5 --> SI1

    SI1 --> CI1
    SI1 --> CI2
    SI2 --> CI1
    SI3 --> CI1
    SI4 --> IL1

    CI1 --> IL1
    CI2 --> IL1
    CI3 --> IL2
    CI4 --> IL2
    CI5 --> CI1

    IL1 --> AP
    IL2 --> AP

    %% Click Events
    click AL1 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar/src/main/java/org/springframework/pulsar/annotation/PulsarListener.java"
    click AL3 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar/src/main/java/org/springframework/pulsar/core/PulsarTemplate.java"
    click AL4 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar-reactive/src/main/java/org/springframework/pulsar/reactive/core/ReactivePulsarTemplate.java"
    click AL5 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar-reactive/src/main/java/org/springframework/pulsar/reactive/config/annotation/ReactivePulsarListener.java"
    click SI1 "https://github.com/spring-projects/spring-pulsar/tree/main/spring-pulsar/src/main/java/org/springframework/pulsar/config/"
    click SI2 "https://github.com/spring-projects/spring-pulsar/tree/main/spring-pulsar/src/main/java/org/springframework/pulsar/event/"
    click SI3 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar/src/main/java/org/springframework/pulsar/transaction/PulsarTransactionManager.java"
    click SI4 "https://github.com/spring-projects/spring-pulsar/tree/main/spring-pulsar/src/main/java/org/springframework/pulsar/observation/"
    click CI2 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar/src/main/java/org/springframework/pulsar/core/PulsarAdministration.java"
    click CI3 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar/src/main/java/org/springframework/pulsar/core/DefaultSchemaResolver.java"
    click CI4 "https://github.com/spring-projects/spring-pulsar/blob/main/spring-pulsar/src/main/java/org/springframework/pulsar/core/DefaultTopicResolver.java"
    click CI5 "https://github.com/spring-projects/spring-pulsar/tree/main/spring-pulsar/src/main/java/org/springframework/pulsar/support/converter/"
    click IL2 "https://github.com/spring-projects/spring-pulsar/tree/main/spring-pulsar-cache-provider-caffeine/src/main/java/org/springframework/pulsar/cache/provider/caffeine/"
    click IL4 "https://github.com/spring-projects/spring-pulsar/tree/main/spring-pulsar-test/src/main/java/org/springframework/pulsar/test/support/"

    %% Styles
    classDef spring fill:#6DB33F,stroke:#fff,stroke-width:2px,color:#fff
    classDef core fill:#1E88E5,stroke:#fff,stroke-width:2px,color:#fff
    classDef infra fill:#FFC107,stroke:#fff,stroke-width:2px,color:#000
    classDef external fill:#9E9E9E,stroke:#fff,stroke-width:2px,color:#fff
    classDef annotation fill:#7E57C2,stroke:#fff,stroke-width:2px,color:#fff
    classDef api fill:#00ACC1,stroke:#fff,stroke-width:2px,color:#fff
    classDef reactive fill:#E91E63,stroke:#fff,stroke-width:2px,color:#fff
```
