# jpaulm/javafbp architecture

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

- Interactive diagram: https://gitdiagram.com/jpaulm/javafbp
- Repository: https://github.com/jpaulm/javafbp

## Overview

##### Project type and purpose
- This is **JavaFBP**, an open-source Java library / toolkit implementing “classical” Flow-Based Programming (FBP).
- It provides a **runtime engine** and a set of **reusable components** (I/O, text, routing, audio, JDBC, WebSockets, etc.), plus a **ResourceKit** of sample networks and templates for building your own FBP applications.

##### File structure
Top-level structure
- build.gradle, pom.xml, gradlew/gradlew.bat, gradle/… → **build & distribution** (Gradle wrapper + scripts)
- src/main/java/com/jpaulmorrison/fbp/core/engine → **FBP Engine** (core runtime, network, ports, packets)
- src/main/java/com/jpaulmorrison/fbp/core/components → **Core Components** grouped by domain (io, text, routing, audio, swing, jdbc, parsexml, misc)
- src/main/java/com/jpaulmorrison/fbp/resourcekit → **ResourceKit**
– examples/components → sample building-block components
– examples/networks → sample networks demonstrating flows
– experimental → work-in-progress components & nets
– templates → component skeletons
- src/main/resources → auxiliary **test data** and LICENSE
- docs, README.md, lgpl-3.0.txt → **documentation & licensing**
- build/distributions, build/libs → **artifacts** (JAR, ZIP, tar)

##### Key points from the README
- Users include the JavaFBP jar in their projects and define their own networks via the API.
- Extensions for MySQL (ReadJDBC/WriteJDBC) and WebSockets exist in separate projects.
- Build with Gradle; publish to Maven Central; auto-generate Javadoc; distribute via build/distributions.

##### Capturing essential elements
- Interfaces (e.g., Component, Network, Packet)
- Data flows (e.g., packet movement from one component to another)
- Versioning/distribution artifacts (javafbp-4.1.14.jar)
- Don’t omit resourcekit/examples—they demonstrate usage

- How JavaFBP is built and distributed
- The core runtime engine and its API
- The rich library of components and their domains
- Sample networks and extension points
- Integration with external systems and user projects
Ensuring engineers can see the full architectural picture at a glance.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build & CI/CD
    subgraph "Build & CI/CD" 
        direction TB
        BuildGradle["build.gradle"]:::build
        PomXml["pom.xml"]:::build
        GradleWrapper["gradlew / gradlew.bat"]:::build
        GradleProps["gradle/wrapper/gradle-wrapper.properties"]:::build
        Artifact["javafbp-*.jar / .zip / .tar"]:::artifact
    end

    %% Core Engine
    subgraph "FBP Engine" 
        direction TB
        Engine["Engine Module\n(Network, Port, Packet)"]:::engine
    end

    %% Core Components
    subgraph "Core Components Library"
        direction TB
        IOComp["I/O Components"]:::components
        TextComp["Text Processing Components"]:::components
        RoutingComp["Routing Components"]:::components
        AudioComp["Audio Components"]:::components
        JdbcComp["JDBC Components"]:::components
        HttpComp["HTTP Components"]:::components
        SwingComp["Swing Components"]:::components
        XmlComp["XML Parser Components"]:::components
        MiscComp["Misc Components"]:::components
    end

    %% ResourceKit & Examples
    subgraph "ResourceKit & Examples"
        direction TB
        RK_Components["Example Components"]:::examples
        RK_Networks["Example Networks"]:::examples
        RK_Subnets["Example Subnets"]:::examples
        RK_ExperimentalComp["Experimental Components"]:::examples
        RK_ExperimentalNets["Experimental Networks"]:::examples
        RK_Templates["Component Templates"]:::examples
    end

    %% External Services
    subgraph "External Services"
        direction TB
        MySQL["MySQL (JDBC)"]:::external
        WebSockets["WebSockets API"]:::external
        FileSystem["File System I/O"]:::external
        HTTP["HTTP/URL"]:::external
        Sockets["Socket I/O"]:::external
        SwingUI["Swing UI"]:::external
    end

    %% User Project
    subgraph "User Application"
        direction TB
        UserApp["Custom Network & Components"]:::user
        PropsXML["<user>.JavaFBPProperties.xml"]:::user
    end

    %% Relationships
    BuildGradle -->|builds| Artifact
    PomXml -->|builds| Artifact
    GradleWrapper -->|builds| Artifact
    GradleProps -->|builds| Artifact

    Artifact -->|used by| UserApp
    Artifact -->|used by| RK_Components
    Artifact -->|used by| RK_Networks

    Engine -->|provides API to| IOComp
    Engine -->|provides API to| TextComp
    Engine -->|provides API to| RoutingComp
    Engine -->|provides API to| AudioComp
    Engine -->|provides API to| JdbcComp
    Engine -->|provides API to| HttpComp
    Engine -->|provides API to| SwingComp
    Engine -->|provides API to| XmlComp
    Engine -->|provides API to| MiscComp

    RK_Components -->|instantiate| Engine
    RK_Components -->|use| IOComp
    RK_Networks -->|instantiate| Engine
    RK_Networks -->|use| TextComp

    IOComp -->|call| FileSystem
    HttpComp -->|call| HTTP
    SocketsComp["ReadFromSocket / WriteToSocket"] -->|call| Sockets
    JdbcComp -->|call| MySQL
    SwingComp -->|call| SwingUI
    WebSocketsComp["WebSockets Extensions"] -->|call| WebSockets

    UserApp -->|invoke| Engine
    UserApp -->|extend| IOComp
    UserApp -->|extend| TextComp

    %% Click Events
    click BuildGradle "https://github.com/jpaulm/javafbp/blob/master/build.gradle"
    click PomXml "https://github.com/jpaulm/javafbp/blob/master/pom.xml"
    click GradleWrapper "https://github.com/jpaulm/javafbp/tree/master/gradlew"
    click GradleWrapper "https://github.com/jpaulm/javafbp/blob/master/gradlew.bat"
    click GradleProps "https://github.com/jpaulm/javafbp/blob/master/gradle/wrapper/gradle-wrapper.properties"
    click Engine "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/engine"
    click IOComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/io"
    click TextComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/text"
    click RoutingComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/routing"
    click AudioComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/audio"
    click JdbcComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/jdbc"
    click HttpComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/httpurl"
    click SwingComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/swing"
    click XmlComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/parsexml"
    click MiscComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/core/components/misc"
    click RK_Components "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/resourcekit/examples/components"
    click RK_Networks "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/resourcekit/examples/networks"
    click RK_Subnets "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/resourcekit/examples/subnets"
    click RK_ExperimentalComp "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/resourcekit/experimental/components"
    click RK_ExperimentalNets "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/resourcekit/experimental/networks"
    click RK_Templates "https://github.com/jpaulm/javafbp/tree/master/src/main/java/com/jpaulmorrison/fbp/resourcekit/templates"

    %% Styles
    classDef build fill:#f5a623,stroke:#d46900,color:#000;
    classDef artifact fill:#f8e1a0,stroke:#e6c069,color:#000;
    classDef engine fill:#6ca0dc,stroke:#357ab7,color:#fff;
    classDef components fill:#7fbf7f,stroke:#4f8f4f,color:#fff;
    classDef examples fill:#fbe25f,stroke:#e6c847,color:#000;
    classDef external fill:#cccccc,stroke:#999999,color:#000;
    classDef user fill:#c186c0,stroke:#8f4e8f,color:#fff;
```
