# spring-projects/spring-session architecture

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

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

## Overview

##### Project type and purpose
- This is an open-source, multi-module Java library (“Spring Session”) that provides a core session-management API plus multiple storage‐adapter modules (Redis, JDBC, Hazelcast, MongoDB), documentation, samples, and build infrastructure.
- Its primary function at runtime is to replace or augment the container’s HttpSession/WebSocket/WebSession support in a container-neutral way.

##### File structure
- Top-level files: settings.gradle, build.gradle, gradle.properties, CI workflows under .github, release scripts under scripts/release.
- buildSrc/: custom Gradle plugins and conventions applied to all modules.
- Modules (each under its own directory):
- spring-session-core (defines SessionRepository API, filters, runtime hints)
- spring-session-data-redis
- spring-session-jdbc
- spring-session-hazelcast
- spring-session-data-mongodb
- spring-session-bom & spring-session-dependencies (dependency management)
- spring-session-docs (Antora-based documentation site)
- spring-session-samples (dozens of sample Spring Boot and JavaConfig applications)
- etc/: style and IDE configuration; etc/checkstyle; gradle/wrapper; scripts/release.

##### README for additional insights
- Confirms core vs. data modules.
- Lists supported transports (HttpSession, WebSocket, WebSession).
- Notes Gradle-based build and sample locations.

##### Diagramming conventions
- Use clear, consistent labels for each module or component.
– Blue rectangles for core modules
– Green for adapters
– Orange for samples
– Gray for build/CI infrastructure

Be very detailed—break out filters, interfaces, adapters, stores, build plugins, CI workflows, docs, and samples as separate components to fully capture the architecture.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build Infrastructure
    subgraph "Build Infrastructure" 
        direction TB
        BuildSrc["buildSrc"]:::infra
        Settings["settings.gradle"]:::infra
        BuildGradle["build.gradle"]:::infra
        GradleProps["gradle.properties"]:::infra
        LibsToml["gradle/libs.versions.toml"]:::infra
        CI["CI Workflows"]:::infra
        ReleaseScripts["Release Scripts"]:::infra
    end

    %% Core Module
    subgraph "Spring Session Core" 
        direction TB
        SessionRepoAPI["SessionRepository API"]:::core
        SessionFilter["SessionRepositoryFilter (HTTP)"]:::core
        WebSocketIntegration["WebSocketConnectHandlerDecoratorFactory"]:::core
        ReactiveAdapter["SpringSessionWebSessionStore / ReactiveSessionRepository"]:::core
    end

    %% Adapter Modules
    subgraph "Storage Adapters" 
        direction TB
        RedisAdapter["RedisIndexedSessionRepository / ReactiveRedisSessionRepository"]:::adapter
        JDBCAdapter["JdbcIndexedSessionRepository"]:::adapter
        HazelcastAdapter["HazelcastIndexedSessionRepository"]:::adapter
        MongoAdapter["MongoIndexedSessionRepository"]:::adapter
    end

    %% External Stores
    subgraph "External Data Stores"
        direction TB
        RedisStore[(Redis Server)]:::store
        RDB[(Relational DB)]:::store
        HazelcastCluster[(Hazelcast Cluster)]:::store
        MongoCluster[(MongoDB Cluster)]:::store
    end

    %% Documentation & Samples
    subgraph "Documentation & Samples"
        direction TB
        Docs["Antora Documentation"]:::docs
        Samples["Sample Applications"]:::samples
    end

    %% Dependencies
    BOM["spring-session-bom & dependencies"]:::infra

    %% Relationships
    Settings -->|configures| BuildSrc
    BuildGradle -->|defines plugins| BuildSrc
    BuildSrc -->|applies to| SessionRepoAPI
    BuildSrc -->|applies to| RedisAdapter
    BuildSrc -->|applies to| JDBCAdapter
    BuildSrc -->|applies to| HazelcastAdapter
    BuildSrc -->|applies to| MongoAdapter
    CI -->|build/test/release| SessionRepoAPI
    CI -->|build/test/release| RedisAdapter
    CI -->|build/test/release| JDBCAdapter
    CI -->|build/test/release| HazelcastAdapter
    CI -->|build/test/release| MongoAdapter
    ReleaseScripts -->|release automation| CI

    SessionFilter -->|uses| SessionRepoAPI
    WebSocketIntegration -->|uses| SessionRepoAPI
    ReactiveAdapter -->|uses| SessionRepoAPI

    SessionRepoAPI -->|implemented by| RedisAdapter
    SessionRepoAPI -->|implemented by| JDBCAdapter
    SessionRepoAPI -->|implemented by| HazelcastAdapter
    SessionRepoAPI -->|implemented by| MongoAdapter

    RedisAdapter -->|reads/writes| RedisStore
    JDBCAdapter -->|reads/writes| RDB
    HazelcastAdapter -->|reads/writes| HazelcastCluster
    MongoAdapter -->|reads/writes| MongoCluster

    Docs -->|documents| SessionRepoAPI
    Docs -->|documents| RedisAdapter
    Docs -->|documents| JDBCAdapter
    Docs -->|documents| HazelcastAdapter
    Docs -->|documents| MongoAdapter

    Samples -->|use| SessionFilter
    Samples -->|use| WebSocketIntegration
    Samples -->|use| ReactiveAdapter

    BOM -->|manages versions| SessionRepoAPI
    BOM -->|manages versions| RedisAdapter
    BOM -->|manages versions| JDBCAdapter
    BOM -->|manages versions| HazelcastAdapter
    BOM -->|manages versions| MongoAdapter

    %% Click events
    click Settings "https://github.com/spring-projects/spring-session/blob/main/settings.gradle"
    click BuildGradle "https://github.com/spring-projects/spring-session/blob/main/build.gradle"
    click GradleProps "https://github.com/spring-projects/spring-session/blob/main/gradle.properties"
    click LibsToml "https://github.com/spring-projects/spring-session/blob/main/gradle/libs.versions.toml"
    click BuildSrc "https://github.com/spring-projects/spring-session/tree/main/buildSrc"
    click BuildSrc "https://github.com/spring-projects/spring-session/blob/main/buildSrc/build.gradle"
    click AbstractSpringJavaPlugin "https://github.com/spring-projects/spring-session/blob/main/buildSrc/src/main/groovy/io/spring/gradle/convention/AbstractSpringJavaPlugin.groovy"
    click AntoraVersionPlugin "https://github.com/spring-projects/spring-session/blob/main/buildSrc/src/main/java/org/springframework/gradle/antora/AntoraVersionPlugin.java"
    click CI "https://github.com/spring-projects/spring-session/blob/main/ .github/workflows/continuous-integration-workflow.yml"
    click CI "https://github.com/spring-projects/spring-session/blob/main/ .github/workflows/release-scheduler.yml"
    click CI "https://github.com/spring-projects/spring-session/blob/main/ .github/workflows/deploy-docs.yml"
    click ReleaseScripts "https://github.com/spring-projects/spring-session/blob/main/scripts/release/wait-for-done.sh"
    click ReleaseScripts "https://github.com/spring-projects/spring-session/blob/main/scripts/release/release-notes-sections.yml"
    click SessionRepoAPI "https://github.com/spring-projects/spring-session/blob/main/spring-session-core/src/main/java/org/springframework/session/SessionRepository.java"
    click SessionFilter "https://github.com/spring-projects/spring-session/blob/main/spring-session-core/src/main/java/org/springframework/session/web/http/SessionRepositoryFilter.java"
    click WebSocketIntegration "https://github.com/spring-projects/spring-session/blob/main/spring-session-core/src/main/java/org/springframework/session/web/socket/handler/WebSocketConnectHandlerDecoratorFactory.java"
    click ReactiveAdapter "https://github.com/spring-projects/spring-session/blob/main/spring-session-core/src/main/java/org/springframework/session/web/server/session/SpringSessionWebSessionStore.java"
    click ReactiveAdapter "https://github.com/spring-projects/spring-session/blob/main/spring-session-core/src/main/java/org/springframework/session/ReactiveSessionRepository.java"
    click RedisAdapter "https://github.com/spring-projects/spring-session/blob/main/spring-session-data-redis/src/main/java/org/springframework/session/data/redis/RedisIndexedSessionRepository.java"
    click RedisAdapter "https://github.com/spring-projects/spring-session/blob/main/spring-session-data-redis/src/main/java/org/springframework/session/data/redis/ReactiveRedisSessionRepository.java"
    click JDBCAdapter "https://github.com/spring-projects/spring-session/blob/main/spring-session-jdbc/src/main/java/org/springframework/session/jdbc/JdbcIndexedSessionRepository.java"
    click HazelcastAdapter "https://github.com/spring-projects/spring-session/blob/main/spring-session-hazelcast/src/main/java/org/springframework/session/hazelcast/HazelcastIndexedSessionRepository.java"
    click MongoAdapter "https://github.com/spring-projects/spring-session/blob/main/spring-session-data-mongodb/src/main/java/org/springframework/session/data/mongo/MongoIndexedSessionRepository.java"
    click BOM "https://github.com/spring-projects/spring-session/blob/main/spring-session-bom/spring-session-bom.gradle"
    click BOM "https://github.com/spring-projects/spring-session/blob/main/spring-session-dependencies/spring-session-dependencies.gradle"
    click Docs "https://github.com/spring-projects/spring-session/blob/main/spring-session-docs/antora.yml"
    click Docs "https://github.com/spring-projects/spring-session/blob/main/spring-session-docs/modules/ROOT/pages/api.adoc"
    click Docs "https://github.com/spring-projects/spring-session/blob/main/spring-session-docs/modules/ROOT/pages/guides/boot-redis.adoc"
    click Samples "https://github.com/spring-projects/spring-session/tree/main/spring-session-samples/"

    %% Styles
    classDef core fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef adapter fill:#90EE90,stroke:#333,stroke-width:1px
    classDef store fill:#FFCCCB,stroke:#333,stroke-width:1px
    classDef infra fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef docs fill:#FFD700,stroke:#333,stroke-width:1px
    classDef samples fill:#FFA500,stroke:#333,stroke-width:1px
```
