Eclipse GLSP Server

Contains the code for the Java-based framework to create GLSP server components.

Building

The GLSP server bundles are built with Java 11 or higher and maven. Execute mvn clean install -Pm2 (for maven) or mvn clean install -Pp2 (for p2). The nightly builds are available as maven repository or p2 update site.

Maven Repositories

Snapshots: https://oss.sonatype.org/content/repositories/snapshots/org/eclipse/glsp/
Releases/Release Candiates: https://oss.sonatype.org/content/groups/public/org/eclipse/glsp/

P2 Update Sites

Snapshots: https://download.eclipse.org/glsp/server/p2/nightly/

All changes on the master branch are deployed automatically to the corresponding snapshot repositories.

Structure of this repository

org.eclipse.glsp.graph: EMF-based implementation of graphical model that's used for client-server communication
org.eclipse.glsp.layout: Server-based layout using the Eclipse Layout Kernel framework (adapted from Eclipse Sprotty Server)
org.eclipse.glsp.server: Generic base implemenation for standalone GLSP servers (based on JSON-RPC)
org.eclipse.glsp.server.websocket: Extension of the base server implementation for communication over websockets
org.eclipse.glsp.example.workflow: GLSP server for the Workflow Diagram example

Workflow Diagram Example

The workflow diagram is a consistent example provided by all GLSP components. The example implements a simple flow chart diagram editor with different types of nodes and edges (see screenshot below). The example can be used to try out different GLSP features, as well as several available integrations with IDE platforms (Theia, VSCode, Eclipse, Standalone). As the example is fully open source, you can also use it as a blueprint for a custom implementation of a GLSP diagram editor. See our project website for an overview of the workflow example and all components implementing it.

How to start the Workflow Diagram example?

To see the diagram in action, you will need to choose and launch one diagram client, see here for an overview.

Building the Workflow Diagram example server

In the root of this repository, run

mvn clean verify -Pm2 -Pfatjar

In the folder examples/org.eclipse.glsp.example.workflow/target, you should have a jar file org.eclipse.glsp.example.workflow-X.X.X-SNAPSHOT-glsp.jar whereas X.X.X is the current version. You can now start the server by executing the following commands:

cd examples/org.eclipse.glsp.example.workflow/target
java -jar org.eclipse.glsp.example.workflow-X.X.X-SNAPSHOT-glsp.jar org.eclipse.glsp.example.workflow.launch.ExampleServerLauncher

To start the example server from within your IDE, run the main method of the class ExampleServerLauncher.java in the module glsp-server/examples/org.eclipse.glsp.example.workflow.

Once the server is running, choose a diagram client integration (such as Eclipse Theia, VSCode, Eclipse, or Standalone) below.

Where to find the sources?

In addition to this repository, the related source code can be found here:

ruspl-afed/glsp-server