How jpaulm/javafbp works
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.