Client GUI

Based on the REST API EclipseStore provides a web user interface to browse through the storage data and inspect storage statistics.

Two variants exist:

the bundled Storage Viewer — a dependency-free Vanilla-JS UI served directly by the Javalin REST service (recommended), and
the standalone Vaadin client — a separate runnable jar (deprecated, see below).

Bundled Storage Viewer (recommended)

The Javalin REST service ships with a small static web viewer. It has zero additional dependencies (plain HTML/CSS/JS, ~65 KB of code) and is served from the REST service itself, so there is nothing extra to deploy and no CORS setup or reverse proxy is required.

It is disabled by default. Enable it with the eclipse_store_rest_ui_enabled flag:

java -Declipse_store_rest_ui_enabled=true -cp ... your.Main

Then open the root path of the REST service in your browser and enter the base URL of the REST service to connect:

http://localhost:4567/            <- open this
http://localhost:4567/store-data  <- enter this as the base URL, then click Connect

Because the viewer and the REST API share the same origin, the connection works without any additional configuration. The interface is identical to the screenshots shown below: browse the object graph in the Data tab and inspect storage statistics in the Statistics tab.

The bundled viewer is a pure client-side application: your browser calls the REST API directly. When you serve it from the REST service as described above this is same-origin and needs no extra setup. If you host the static files elsewhere (a different origin), the REST service must send CORS headers or you must place both behind a common reverse proxy.

Standalone Vaadin client (deprecated)

The standalone Vaadin client (storage-restclient-app and storage-restclient-app-standalone-assembly) is deprecated since 4.3.0 and scheduled for removal in 5.0.0. It pulls in Vaadin and Spring, which makes it heavyweight to run and hard to embed into existing projects. Use the bundled Storage Viewer described above instead.

It is a runnable jar which starts a simple web server which then can be accessed by a browser of your choice.

Since EclipseStore version 1.1.0 The Client GUI requires Java 17 to run!

To download it into the local repository the following Maven command:

CLI

mvn dependency:get -Dartifact=org.eclipse.store:storage-restclient-app-standalone-assembly:{maven-version}:jar -Dtransitive=false -Dclassifier=standalone

To download it into the current directory use the following Maven command:

CLI

mvn dependency:copy -Dartifact=org.eclipse.store:storage-restclient-app-standalone-assembly:{maven-version}:jar:standalone -DoutputDirectory=./

or this direct link:

https://repo1.maven.org/maven2/org/eclipse/store/storage-restclient-app-standalone-assembly/4.3.0/storage-restclient-app-standalone-assembly-4.3.0-standalone.jar

Start the client. The port parameter is optional, default port is 8080.

java -jar storage-restclient-app-standalone-assembly-4.3.0-standalone.jar --server.port=8888

Then just open http://localhost:8888/ in your browser, select the base URL of the REST service and click connect.

Now you can browse through the data of the storage:

Or view the statistics: