This is a sample OSLC PROMCODE server, that is based on the OASIS OSLC PROMCODE Specification 1.0.

Follow the 3 sections below to:

1. Setup persistent store
2. Run the OSLC Server
3. Navigate the OSLC server
4. Populate the OSLC server

You will set up an RDF data store to store the OSLC PROMCODE resources.

We will utilize the Apache Jena Fuseki that is an open source RDF server. You can select either Docker Compose, Docker version, or Java version.

The easiest way to run both the PROMCODE server and Fuseki together:

1. Make sure you have Docker and Docker Compose installed
2. Run the following command from the repository root:

   docker-compose up --build

3. This will start both services:
   • Fuseki server at http://localhost:3030 (admin/admin)
   • PROMCODE server at http://localhost:8080/promcode-server

To stop the services:

docker-compose down

To view logs:

docker-compose logs -f

Pre-built Docker images are available from GitHub Container Registry for both x86_64 (amd64) and ARM64 architectures:

# Run the latest version
docker run -p 8080:8080 ghcr.io/oslc/promcode-lyo-server:latest

# Run a specific version
docker run -p 8080:8080 ghcr.io/oslc/promcode-lyo-server:0.1.0

Note: Images are automatically rebuilt weekly to ensure the latest security updates from base images.

1. Download docker version of fuseki server from https://repo1.maven.org/maven2/org/apache/jena/jena-fuseki-docker/4.2.0/
2. docker-compose build --build-arg JENA_VERSION=3.16.0
3. docker-compose run --rm --service-ports fuseki --update --mem /dataset

1. Download jar file from https://repo1.maven.org/maven2/org/apache/jena/jena-fuseki-server/
2. For the latest Java version, run the following command
   • java -cp jena-fuseki-server-4.2.0.jar org.apache.jena.fuseki.main.cmds.FusekiMainCmd --update --mem /dataset
3. For Java 1.8 , run the following command
   • java -cp jena-fuseki-server-3.16.0.jar org.apache.jena.fuseki.main.cmds.FusekiMainCmd --update --mem /dataset

There are multiple options to run the OSLC Server. Below are the simplest options if you don't want to use anything except JDK and a Maven installation. Prerequisites:

• JDK 11
• Maven 3

Follow these steps to start the server:

cd promcode-lyo-server
mvn clean jetty:run-war

Now proceed to the steps listed in the next section Navigating OSLC servers.

Follow these steps to start the server:

cd promcode-lyo-server
mvn clean cargo:run

If you prefer to use Docker, you can run both the PROMCODE server and Fuseki using Docker Compose:

docker-compose up --build

This will:

• Build the PROMCODE server Docker image
• Start Fuseki server on port 3030
• Start PROMCODE server on port 8080
• Create a Docker network for service communication
• Persist Fuseki data in a Docker volume

The OSLC server is available at the following URL:

• http://localhost:8080/promcode-server/

From that point, you can navigate through the Service Provider Catalog, or using the built-in Swagger Editor.

THe server contains no data at startup. You can add resources to the server by performing resource operations on their creation factories.

This can be done through the built-in Swagger editor, or using the command line.

Bash/Linux/macOS:

curl -i --data-raw '@prefix dcterms: <http://purl.org/dc/terms/> .
@prefix oslc_promcode: <http://open-services.net/ns/promcode#> .
<> a oslc_promcode:Artifact ;
   dcterms:identifier "1" ;
   dcterms:title "A1" ;
   dcterms:description "UI for making a reservation" .' \
-H "Accept: text/turtle;" \
-H "Content-type: text/turtle" \
http://localhost:8080/oslc/service1/artifacts/create

PowerShell/Windows:

curl -i --data-raw '@prefix dcterms: <http://purl.org/dc/terms/> .
@prefix oslc_promcode: <http://open-services.net/ns/promcode#> .
<> a oslc_promcode:Artifact ;
   dcterms:identifier "1" ;
   dcterms:title "A1" ;
   dcterms:description "UI for making a reservation" .' `
-H "Accept: text/turtle;" `
-H "Content-type: text/turtle" `
http://localhost:8080/oslc/service1/artifacts/create

2. To retrieve the created artifact:

   curl -H "Accept: text/turtle;" http://localhost:8080/oslc/artifact/1

This server is modelled and generated using Lyo Designer.

It is recommended that any changes to the code should be done using LyoDesigner to maintain traceability between the model and the code. Below are some instructions on how to open the projects in this repository with LyoDesigner.

It is recommended you get familiar with the LyoDesigner tool before you perform any changes.

To open the relevant projects for the OSLC PROMCODE server, you need to follow the steps below.

The first step is to install Lyo Designer.

The PROMCODE domain model is already modelled and made available to be used by any PROMCODE server installation.

1. Import the Lyo Git repository
2. In LyoDesigner, import the Modelling project under the "domains\org.eclipse.lyo.tools.domainmodels" folder.

This project contains the PROMCODE model, and all other OSLC Domain Specifications.

In LyoDesigner, import the Modelling project under the "promcode-lyo-server-model" folder.

This model depends on the PROMCODE domain model, imported in the previous step. It is important the domain model is imported first.

This models a simple PROMCODE server, which can be used as a basis for your own extensions and modifications.

1. In LyoDesigner, import the Maven project under the "promcode-lyo-server" folder.

This maven project is generated from the server model imported above.

• OASIS OSLC PROMCODE Specification 1.0