# spotbugs/sonar-findbugs architecture

> Architecture diagram of the GitHub repository spotbugs/sonar-findbugs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-02-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/spotbugs/sonar-findbugs
- Repository: https://github.com/spotbugs/sonar-findbugs

## Overview

##### Main Components

a. Core Components:
- FindbugsPlugin (Entry Point)
- FindbugsSensor (Analysis Execution)
- FindbugsExecutor (SpotBugs Execution)
- ByteCodeResourceLocator (Class File Analysis)

b. Rule Management:
- FindbugsRulesDefinition
- FbContribRulesDefinition
- FindSecurityBugsRulesDefinition
- FindSecurityBugsJspRulesDefinition
- FindSecurityBugsScalaRulesDefinition

c. Profile Management:
- FindbugsProfileImporter
- FindbugsProfileExporter
- Various Profile implementations (Security, JSP, Scala)

##### External Integrations
- SpotBugs Engine
- FB-Contrib
- Find Security Bugs
- SonarQube API

##### Flow and Relationships
- Analysis flow:
- SonarQube Scanner → FindbugsPlugin → FindbugsSensor → FindbugsExecutor → SpotBugs Engine
- Configuration flow:
- Rules Definitions → Profile Management → Analysis Configuration

##### Integration Points
- Clear boundaries between:
- SonarQube platform
- Plugin components
- External analysis engines

##### Important Notes
- Supported languages (Java, JSP, Scala, Kotlin)
- Compilation requirements
- Configuration options
- Version compatibility information

##### The configuration and extensibility points

- Component groupings
- Integration boundaries

This design reflects the plugin's architecture as a modular system that integrates multiple static analysis tools while maintaining clean separation of concerns and clear data flow paths.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Input
        SRC[Source Code Files]
        BC[Bytecode Files]
    end

    subgraph "Core Components"
        FP[FindbugsPlugin]:::core
        FS[FindbugsSensor]:::core
        FE[FindbugsExecutor]:::core
        BCL[ByteCodeResourceLocator]:::core
        FCONF[FindbugsConfiguration]:::core
    end

    subgraph "Rule Management"
        FRD[FindbugsRulesDefinition]:::rules
        FCRD[FbContribRulesDefinition]:::rules
        FSRD[FindSecurityBugsRulesDefinition]:::rules
        FJRD[FindSecurityBugsJspRulesDefinition]:::rules
        FSSD[FindSecurityBugsScalaRulesDefinition]:::rules
    end

    subgraph "Profile Management"
        FPI[FindbugsProfileImporter]:::profile
        FPE[FindbugsProfileExporter]:::profile
        FSP[Security Profile]:::profile
        FJP[JSP Profile]:::profile
        FSP2[Scala Profile]:::profile
    end

    subgraph "Language Support"
        JSP[JSP Support]:::lang
        SCALA[Scala Support]:::lang
    end

    subgraph "External Tools"
        SB[SpotBugs Engine]:::external
        FBC[FB-Contrib]:::external
        FSB[Find Security Bugs]:::external
    end

    subgraph "SonarQube Platform"
        SQ[SonarQube Scanner]:::sonar
        SQAPI[SonarQube API]:::sonar
        ISSUES[Issues & Reports]:::sonar
    end

    SRC --> BC
    BC --> BCL
    SQ --> FP
    FP --> FS
    FS --> FE
    FE --> SB
    BCL --> FE
    
    FRD --> FCONF
    FCRD --> FCONF
    FSRD --> FCONF
    FJRD --> FCONF
    FSSD --> FCONF
    
    FPI --> FCONF
    FPE --> FCONF
    FSP --> FCONF
    FJP --> FCONF
    FSP2 --> FCONF
    
    JSP --> FS
    SCALA --> FS
    
    SB --> FBC
    SB --> FSB
    
    FE --> ISSUES
    ISSUES --> SQAPI

    classDef core fill:#4a90e2,stroke:#2c3e50,color:white
    classDef rules fill:#f39c12,stroke:#c27d0e,color:white
    classDef profile fill:#27ae60,stroke:#1e8449,color:white
    classDef lang fill:#8e44ad,stroke:#6c3483,color:white
    classDef external fill:#e74c3c,stroke:#c0392b,color:white
    classDef sonar fill:#95a5a6,stroke:#7f8c8d,color:white

    click FP "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/FindbugsPlugin.java"
    click FS "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/FindbugsSensor.java"
    click FE "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/FindbugsExecutor.java"
    click BCL "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/resource/ByteCodeResourceLocator.java"
    click FRD "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/rules/FindbugsRulesDefinition.java"
    click FCRD "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/rules/FbContribRulesDefinition.java"
    click FSRD "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/rules/FindSecurityBugsRulesDefinition.java"
    click FJRD "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/rules/FindSecurityBugsJspRulesDefinition.java"
    click FSSD "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/rules/FindSecurityBugsScalaRulesDefinition.java"
    click FPI "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/FindbugsProfileImporter.java"
    click FPE "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/FindbugsProfileExporter.java"
    click FSP "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/profiles/FindbugsSecurityMinimalProfile.java"
    click FJP "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/profiles/FindbugsSecurityJspProfile.java"
    click FSP2 "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/profiles/FindbugsSecurityScalaProfile.java"
    click FCONF "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/FindbugsConfiguration.java"
    click JSP "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/language/Jsp.java"
    click SCALA "https://github.com/spotbugs/sonar-findbugs/blob/master/src/main/java/org/sonar/plugins/findbugs/language/scala/Scala.java"
```
