Plugin Development — From Eclipse RCP to Bndtools
Deep-dive page: how to build, ship and test a LibreSocial plugin, and what the 2026 build modernisation changed.
Sources in order of authority: the current Gradle/Bndtools build (revival & build notes) is authoritative for how to build; the framework overview paper (2020) and Masinde's dissertation (2020) for plugin architecture; older GUI-era reports (PG 2013, PG 2012) are superseded wherever they describe the Eclipse RCP workbench UI (removed in 2014).
Plugin architecture (stable since ~2011)
Everything user-facing is an OSGi bundle running on Equinox: login, profile, wall, files, search, groups/forum, calendar, messaging, multichat, photos, voting, test, monitoring, error console — each a JAR with a manifest, registered services, and a lifecycle (framework paper). Plugins combine three building blocks:
- StorageDispatcher for persistence (DDS objects on PAST) — see StorageDispatcher;
- MessageDispatcher for overlay traffic;
- Notifications for asynchronous delivery incl. offline storage and group-key distribution — e.g. the many-to-many chat exchanges its symmetric key through Notifications, and WebRTC signalling piggybacks on it (PG 2013).
UI contract: REST + HTML5 (since the 2014 project group)
The Eclipse RCP front-end was replaced wholesale: the WebProvider plugin embeds a web server
serving static HTML5, plugin view-models use Knockout.js/Backbone.js/Knockback.js (MVVM), and a
RESTHandler routes baseRequest/target calls (e.g. photos/getalbumlist) to plugin APIs over
JSON/WebSockets (PG 2013).
Under the 2026 build, WebProvider is a refactored bundle (#78 closed) and TLS support was
added (#115 closed — the web UI is reachable over HTTPS).
The 2026 refactor wave (verified from the tracker)
Item-by-item Java-17/Bndtools refactors are almost complete: #52 closed (Bndtools workflow),
#67 closed (com.p2pframework core on Java 17), and bundles voting #75, searchplugin #76,
wallplugin #77, webprovider #78, profileplugin #79, photosplugin #80, notifications #81,
messageplugin #82, loginplugin #83, livechatplugin #84, groups #85, forum #87, filestorage #88,
commands #89, calendar #90, appstore #91 — all closed; plus #128 closed
(com.common.utilities pulled out of the unrefactored Gradle branch).
Only #86 (friendsplugin) is open. This is the single biggest completed milestone of the 2026
modernisation and the reason new plugins can be developed with plain Gradle+Bndtools instead of
an Eclipse PDE workspace.
App distribution
An AppStore infrastructure exists in four layers (model, server, plugin/client, GUI) with
PluginMeta/VersionMeta/PluginObjectFile models and private repositories; a 20-machine test
published 100 × 1.5 MB plugins, though the byte/s metrics were implausible and flagged as
unreliable (PG 2012). The appstore
bundle itself is refactored (#91); an update of that measurement on the Docker cluster would be
a good student project (blog: cluster testing).
Developer experience: what is still missing (open items)
- #31 OSGi bundle-creation documentation; #103 JavaDoc for bundles; #116 document the Bndtools migration progress — see blog: developer experience.
- #107 drive tests through the OSGi Equinox console; #130 restore unit-test infrastructure; #124 regression checks per refactored bundle (testing methodology).
- #46 split oversized framework interfaces — directly shrinks the plugin API surface (DDS internals).
A practical starting path today: clone the repo, build with ./gradlew (Bndtools cnf/), take
the smallest refactored bundle (e.g. voting #75) as template, and add a Tester plugin test case
following the master/slave TimedTestPlan pattern
(PG 2013 describes the pattern;
tester component the current tooling).
Related
plugin-system component · appstore component · app-kernel component · revival & build · bug catalogue