# spring-projects-experimental/spring-boot-migrator architecture

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

- Interactive diagram: https://gitdiagram.com/spring-projects-experimental/spring-boot-migrator
- Repository: https://github.com/spring-projects-experimental/spring-boot-migrator

## Overview

Spring Boot Migrator (SBM) scans Java/Maven projects, evaluates migration recipes, and applies selected automated changes or provides migration guidance. The principal CLI workflow is scan, inspect applicable recipes, then apply a selected recipe; a separate Spring Boot 3 upgrade web UI lets users select recipes and view an upgrade report. The graph also preserves the documented JEE-to-Boot and Boot-upgrade recipe families. Internal links without sampled call sites are dashed; unsampled recipe capabilities are represented at their listed directories.

Main entry points: [`components/sbm-core/src/main/java/org/springframework/sbm/engine/recipe`](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/recipe) (Recipe engine), [`components/sbm-core/src/main/java/org/springframework/sbm/engine/commands`](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/commands) (Command engine), [`components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java`](https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java) (Project context), [`applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java`](https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java) (Report controller)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["User interfaces"]
  node_shell["CLI shell"]
  node_cli_commands["CLI commands"]
  node_web_ui["Upgrade web UI"]
end

subgraph group_engine["Migration engine"]
  node_command_engine["Command engine"]
  node_project_context["Project context"]
  node_project_parser["Project parsing"]
  node_project_resources["Project resources"]
  node_preconditions["Precondition checks"]
  node_recipe_engine["Recipe engine"]
  node_java_api["Java source API"]
  node_rewrite["OpenRewrite"]
end

subgraph group_recipes["Recipe capabilities"]
  node_boot_recipes["Boot upgrade recipes"]
  node_jee_recipes["JEE migration recipes"]
  node_mule_recipes["Mule migration recipes"]
  node_recipe_repository["Rewrite recipes"]
end

subgraph group_reporting["Upgrade reporting"]
  node_web_controller["Report controller"]
  node_report_output["Upgrade report"]
end

node_developer(("Developer"))
node_target["Target project"]

node_developer -->|"runs commands"| node_shell
node_developer -->|"uses upgrade UI"| node_web_ui
node_developer -->|"chooses project"| node_target
node_shell -.->|"dispatches commands"| node_cli_commands
node_cli_commands -.->|"invokes operations"| node_command_engine
node_web_ui -.->|"submits recipes"| node_web_controller
node_web_controller -->|"applies recipes"| node_command_engine
node_web_controller -->|"returns report"| node_report_output
node_command_engine -.->|"operates on context"| node_project_context
node_project_context -->|"searches resources"| node_project_resources
node_project_parser -.->|"initializes context"| node_project_context
node_command_engine -.->|"checks applicability"| node_preconditions
node_command_engine -.->|"runs recipes"| node_recipe_engine
node_project_context -->|"runs recipe"| node_rewrite
node_project_context -->|"exposes Java sources"| node_java_api
node_recipe_engine -.->|"provides recipes"| node_boot_recipes
node_recipe_engine -.->|"provides recipes"| node_jee_recipes
node_recipe_engine -.->|"provides recipes"| node_mule_recipes
node_recipe_engine -.->|"discovers recipes"| node_recipe_repository
node_boot_recipes -.->|"builds upgrade guidance"| node_report_output
node_target -.->|"is parsed from"| node_project_parser

click node_shell "https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/applications/spring-shell/src/main/java/org/springframework/sbm/SpringShellApplication.java"
click node_cli_commands "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/applications/spring-shell/src/main/java/org/springframework/sbm/shell"
click node_web_ui "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/applications/spring-boot-upgrade/src/main/resources/static/js"
click node_web_controller "https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java"
click node_report_output "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/applications/spring-boot-upgrade/src/main/java/org/springframework/sbm"
click node_command_engine "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/commands"
click node_project_context "https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java"
click node_project_parser "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/project/parser"
click node_project_resources "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/project/resource"
click node_preconditions "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/precondition"
click node_recipe_engine "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/recipe"
click node_java_api "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/java/api"
click node_rewrite "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/openrewrite"
click node_boot_recipes "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot"
click node_jee_recipes "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-recipes-jee-to-boot/src/main/java/org/springframework/sbm/jee"
click node_mule_recipes "https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-recipes-mule-to-boot/src/main/java/org/springframework/sbm/mule"
click node_recipe_repository "https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/components/openrewrite-spring-recipes/src/main/java/org/springframework/sbm/RewriteRecipesRepository.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_shell,node_cli_commands,node_web_ui toneBlue
class node_command_engine,node_project_context,node_project_parser,node_project_resources,node_preconditions,node_recipe_engine,node_java_api,node_rewrite toneAmber
class node_boot_recipes,node_jee_recipes,node_mule_recipes,node_recipe_repository toneMint
class node_web_controller,node_report_output toneRose
class node_developer,node_target toneIndigo
```

## Components

### User interfaces

- [CLI shell](https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/applications/spring-shell/src/main/java/org/springframework/sbm/SpringShellApplication.java): `applications/spring-shell/src/main/java/org/springframework/sbm/SpringShellApplication.java`
- [CLI commands](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/applications/spring-shell/src/main/java/org/springframework/sbm/shell): `applications/spring-shell/src/main/java/org/springframework/sbm/shell`
- [Upgrade web UI](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/applications/spring-boot-upgrade/src/main/resources/static/js): `applications/spring-boot-upgrade/src/main/resources/static/js`

### Migration engine

- [Command engine](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/commands): `components/sbm-core/src/main/java/org/springframework/sbm/engine/commands`
- [Project context](https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java): `components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java`
- [Project parsing](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/project/parser): `components/sbm-core/src/main/java/org/springframework/sbm/project/parser`
- [Project resources](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/project/resource): `components/sbm-core/src/main/java/org/springframework/sbm/project/resource`
- [Precondition checks](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/precondition): `components/sbm-core/src/main/java/org/springframework/sbm/engine/precondition`
- [Recipe engine](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/engine/recipe): `components/sbm-core/src/main/java/org/springframework/sbm/engine/recipe`
- [Java source API](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/java/api): `components/sbm-core/src/main/java/org/springframework/sbm/java/api`
- [OpenRewrite](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-core/src/main/java/org/springframework/sbm/openrewrite): `components/sbm-core/src/main/java/org/springframework/sbm/openrewrite`

### Recipe capabilities

- [Boot upgrade recipes](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot): `components/sbm-recipes-boot-upgrade/src/main/java/org/springframework/sbm/boot`
- [JEE migration recipes](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-recipes-jee-to-boot/src/main/java/org/springframework/sbm/jee): `components/sbm-recipes-jee-to-boot/src/main/java/org/springframework/sbm/jee`
- [Mule migration recipes](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/components/sbm-recipes-mule-to-boot/src/main/java/org/springframework/sbm/mule): `components/sbm-recipes-mule-to-boot/src/main/java/org/springframework/sbm/mule`
- [Rewrite recipes](https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/components/openrewrite-spring-recipes/src/main/java/org/springframework/sbm/RewriteRecipesRepository.java): `components/openrewrite-spring-recipes/src/main/java/org/springframework/sbm/RewriteRecipesRepository.java`

### Upgrade reporting

- [Report controller](https://github.com/spring-projects-experimental/spring-boot-migrator/blob/main/applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java): `applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java`
- [Upgrade report](https://github.com/spring-projects-experimental/spring-boot-migrator/tree/main/applications/spring-boot-upgrade/src/main/java/org/springframework/sbm): `applications/spring-boot-upgrade/src/main/java/org/springframework/sbm`

### Other components

- **Developer**
- **Target project**

## Connections

- Developer → CLI shell: runs commands
- Developer → Upgrade web UI: uses upgrade UI
- Developer → Target project: chooses project
- CLI shell → CLI commands: dispatches commands
- CLI commands → Command engine: invokes operations
- Upgrade web UI → Report controller: submits recipes
- Report controller → Command engine: applies recipes (evidence: `applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java`)
- Report controller → Upgrade report: returns report (evidence: `applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java`)
- Command engine → Project context: operates on context (evidence: `components/sbm-core/src/main/java/org/springframework/sbm/engine/commands/ApplyCommand.java`)
- Project context → Project resources: searches resources (evidence: `components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java`)
- Project parsing → Project context: initializes context
- Command engine → Precondition checks: checks applicability
- Command engine → Recipe engine: runs recipes (evidence: `components/sbm-core/src/main/java/org/springframework/sbm/engine/commands/ApplyCommand.java`)
- Project context → OpenRewrite: runs recipe (evidence: `components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java`)
- Project context → Java source API: exposes Java sources (evidence: `components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java`)
- Recipe engine → Boot upgrade recipes: provides recipes
- Recipe engine → JEE migration recipes: provides recipes (evidence: `components/sbm-recipes-jee-to-boot/src/main/java/org/springframework/sbm/jee/jaxws/GenerateWebServices.java`)
- Recipe engine → Mule migration recipes: provides recipes (evidence: `components/sbm-recipes-mule-to-boot/src/main/java/org/springframework/sbm/mule/MigrateRamlToSpringController.java`)
- Recipe engine → Rewrite recipes: discovers recipes
- Boot upgrade recipes → Upgrade report: builds upgrade guidance (evidence: `applications/spring-boot-upgrade/src/main/java/org/springframework/sbm/ReportController.java`)
- Target project → Project parsing: is parsed from
