Lightweight Docker image

.docker/Dockerfile

@@ -0,0 +1,46 @@
+FROM eclipse-temurin:11 as jre-build
+WORKDIR /app
+
+# Version can be specified at build time
+ARG VERSION=1.4.2
+
+# Annotations to embed in container
+LABEL org.opencontainers.image.title="TopBraid SHACL API"
+LABEL org.opencontainers.image.description="SHACL API in Java based on Apache Jena "
+LABEL org.opencontainers.image.source=https://github.com/TopQuadrant/shacl
+LABEL org.opencontainers.image.licenses=Apache-2.0
+LABEL org.opencontainers.image.version=${VERSION}
+
+# BUILD STAGE 1: install minimal Java environment + curl & zip for SHACL API
+
+# Create a custom Java runtime
+RUN $JAVA_HOME/bin/jlink \
+         --add-modules java.base,java.compiler,java.desktop,java.management,java.naming,java.net.http,java.rmi,java.scripting,java.security.jgss,java.security.sasl,java.sql,java.xml.crypto,jdk.unsupported \
+         --strip-debug \
+         --no-man-pages \
+         --no-header-files \
+         --compress=2 \
+         --output /javaruntime
+
+RUN apt-get -y update && \
+    apt-get -y install curl zip && \
+    rm -rf /var/lib/apt/lists/*
+
+# Download and unpack binary version for appropriate release
+RUN curl -s https://repo1.maven.org/maven2/org/topbraid/shacl/${VERSION}/shacl-${VERSION}-bin.zip > shacl.zip
+RUN unzip shacl.zip && rm shacl.zip
+
+# BUILD STAGE 2: keep only Java and SHACL
+
+FROM ubuntu:jammy
+
+ARG VERSION=1.4.2
+
+ENV JAVA_HOME=/usr
+ENV PATH "/app/shacl-${VERSION}/bin:${PATH}"
+
+COPY --from=jre-build /javaruntime $JAVA_HOME
+COPY --chmod=0755 --from=jre-build /app/shacl-${VERSION} /app/shacl-${VERSION}
+COPY --chmod=0755 "entrypoint.sh" "/entrypoint.sh"
+
+ENTRYPOINT ["/entrypoint.sh"]

.docker/entrypoint.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+set -e
+
+# add conditions to either use "validate" or "infer"
+# as commands, otherwise print a help statement
+
+if [ $1 == validate ] ; then
+	set -- shaclvalidate.sh "$@"
+elif [ $1 == infer ] ; then
+	set -- shaclinfer.sh "$@"
+else
+	cat << EOF
+Please use this docker image as follows:
+docker run -v /path/to/data:/data IMAGE [COMMAND] [PARAMETERS]
+COMMAND:
+	validate 
+		to run validation
+	infer
+		to run rule inferencing
+PARAMETER:
+	-datafile /data/myfile.ttl [MANDATORY]
+		input to be validated (only .ttl format supported)
+	-shapesfile /data/myshapes.ttl [OPTIONAL]
+		shapes for validation (only .ttl format supported)
+EOF
+	exit 1
+fi
+
+exec "$@"

README.md

@@ -1,82 +1,119 @@
-# TopBraid SHACL API
-
-**An open source implementation of the W3C Shapes Constraint Language (SHACL) based on Apache Jena.**
-
-Contact: Holger Knublauch (holger@topquadrant.com)
-
-Can be used to perform SHACL constraint checking and rule inferencing in any Jena-based Java application.
-This API also serves as a reference implementation of the SHACL spec.
-
-Coverage:
-* [SHACL Core and SHACL-SPARQL validation](https://www.w3.org/TR/shacl/)
-* [SHACL Advanced Features (Rules etc)](https://www.w3.org/TR/shacl-af/)
-
-Former Coverage until version 1.4.0
-* [SHACL Compact Syntax](https://w3c.github.io/shacl/shacl-compact-syntax/)
-
-Former Coverage until version 1.3.2
-* [SHACL JavaScript Extensions](https://www.w3.org/TR/shacl-js/)
-
-The TopBraid SHACL API is internally used by the European Commission's generic [SHACL-based RDF validator](https://www.itb.ec.europa.eu/shacl/any/upload) (used to validate RDF content against SHACL shapes)
-and [SHACL shape validator](https://www.itb.ec.europa.eu/shacl/shacl/upload) (used to validate SHACL shapes themselves).
-
-The same code is used in the TopBraid products (currently aligned with the TopBraid 7.1 release).
-
-Feedback and questions should become GitHub issues or sent to TopBraid Users mailing list:
-https://groups.google.com/forum/#!forum/topbraid-users
-Please prefix your messages with [SHACL API]
-
-To get started, look at the class ValidationUtil in
-the package org.topbraid.shacl.validation.
-There is also an [Example Test Case](../master/src/test/java/org/topbraid/shacl/ValidationExample.java)
-
-## Application dependency
-
-Releases are available in the central maven repository:
-
-```
-<dependency>
-  <groupId>org.topbraid</groupId>
-  <artifactId>shacl</artifactId>
-  <version>*VER*</version>
-</dependency>
-```
-## Command Line Usage
-
-Download the latest release from:
-
-`https://repo1.maven.org/maven2/org/topbraid/shacl/`
-
-The binary distribution is:
-
-`https://repo1.maven.org/maven2/org/topbraid/shacl/*VER*/shacl-*VER*-bin.zip`.
-
-Two command line utilities are included: shaclvalidate (performs constraint validation) and shaclinfer (performs SHACL rule inferencing).
-
-To use them, set up your environment similar to https://jena.apache.org/documentation/tools/ (note that the SHACL download includes Jena).
-
-For example, on Windows:
-
-```
-SET SHACLROOT=C:\Users\Holger\Desktop\shacl-1.4.1-bin
-SET PATH=%PATH%;%SHACLROOT%\bin
-```
-
-As another example, for Linux, add to .bashrc these lines:
-
-```
-# for shacl
-export SHACLROOT=/home/holger/shacl/shacl-1.4.1-bin/shacl-1.4.1/bin
-export PATH=$SHACLROOT:$PATH 
-```
-
-Both tools take the following parameters, for example:
-
-`shaclvalidate.bat -datafile myfile.ttl -shapesfile myshapes.ttl`
-
-where `-shapesfile` is optional and falls back to using the data graph as shapes graph.
-Add -validateShapes in case you want to include the metashapes (from the tosh namespace in particular).
-
-Currently only Turtle (.ttl) files are supported.
-
-The tools print the validation report or the inferences graph to the output screen.
+# TopBraid SHACL API
+
+**An open source implementation of the W3C Shapes Constraint Language (SHACL) based on Apache Jena.**
+
+Contact: Holger Knublauch (holger@topquadrant.com)
+
+Can be used to perform SHACL constraint checking and rule inferencing in any Jena-based Java application.
+This API also serves as a reference implementation of the SHACL spec.
+
+Coverage:
+* [SHACL Core and SHACL-SPARQL validation](https://www.w3.org/TR/shacl/)
+* [SHACL Advanced Features (Rules etc)](https://www.w3.org/TR/shacl-af/)
+
+Former Coverage until version 1.4.0
+* [SHACL Compact Syntax](https://w3c.github.io/shacl/shacl-compact-syntax/)
+
+Former Coverage until version 1.3.2
+* [SHACL JavaScript Extensions](https://www.w3.org/TR/shacl-js/)
+
+The TopBraid SHACL API is internally used by the European Commission's generic [SHACL-based RDF validator](https://www.itb.ec.europa.eu/shacl/any/upload) (used to validate RDF content against SHACL shapes)
+and [SHACL shape validator](https://www.itb.ec.europa.eu/shacl/shacl/upload) (used to validate SHACL shapes themselves).
+
+The same code is used in the TopBraid products (currently aligned with the TopBraid 7.1 release).
+
+Feedback and questions should become GitHub issues or sent to TopBraid Users mailing list:
+https://groups.google.com/forum/#!forum/topbraid-users
+Please prefix your messages with [SHACL API]
+
+To get started, look at the class ValidationUtil in
+the package org.topbraid.shacl.validation.
+There is also an [Example Test Case](../master/src/test/java/org/topbraid/shacl/ValidationExample.java)
+
+## Application dependency
+
+Releases are available in the central maven repository:
+
+```
+<dependency>
+  <groupId>org.topbraid</groupId>
+  <artifactId>shacl</artifactId>
+  <version>*VER*</version>
+</dependency>
+```
+## Command Line Usage
+
+Download the latest release from:
+
+`https://repo1.maven.org/maven2/org/topbraid/shacl/`
+
+The binary distribution is:
+
+`https://repo1.maven.org/maven2/org/topbraid/shacl/*VER*/shacl-*VER*-bin.zip`.
+
+Two command line utilities are included: shaclvalidate (performs constraint validation) and shaclinfer (performs SHACL rule inferencing).
+
+To use them, set up your environment similar to https://jena.apache.org/documentation/tools/ (note that the SHACL download includes Jena).
+
+For example, on Windows:
+
+```
+SET SHACLROOT=C:\Users\Holger\Desktop\shacl-1.4.1-bin
+SET PATH=%PATH%;%SHACLROOT%\bin
+```
+
+As another example, for Linux, add to .bashrc these lines:
+
+```
+# for shacl
+export SHACLROOT=/home/holger/shacl/shacl-1.4.1-bin/shacl-1.4.1/bin
+export PATH=$SHACLROOT:$PATH 
+```
+
+Both tools take the following parameters, for example:
+
+`shaclvalidate.bat -datafile myfile.ttl -shapesfile myshapes.ttl`
+
+where `-shapesfile` is optional and falls back to using the data graph as shapes graph.
+Add -validateShapes in case you want to include the metashapes (from the tosh namespace in particular).
+
+Currently only Turtle (.ttl) files are supported.
+
+The tools print the validation report or the inferences graph to the output screen.
+
+## Dockerfile Usage
+
+The `Dockerfile` in the `.docker` folder includes a minimal Java Runtime Environment for the SHACL API that clocks in at 144Mb. To build the docker imageß use:
+
+```
+docker build -t topquadrant/shacl:1.4.2 .docker/
+```
+
+To use the Docker image, there are two possible commands. To run the validator:
+
+```
+docker run --rm -v /path/to/data:/data topquadrant/shacl:1.4.2 validate -datafile /data/myfile.ttl -shapesfile /data/myshapes.ttl
+```
+
+To run rule inferencing:
+
+```
+docker run --rm -v /path/to/data:/data topquadrant/shacl:1.4.2 infer -datafile /data/myfile.ttl -shapesfile /data/myshapes.ttl
+```
+
+Any other command after `topquadrant/shacl:1.4.2` will print the following help page:
+
+```
+Please use this docker image as follows:
+docker run -v /path/to/data:/data topquadrant/shacl:1.4.2 [COMMAND] [PARAMETERS]
+COMMAND:
+	validate 
+		to run validation
+	infer
+		to run rule inferencing
+PARAMETERS:
+	-datafile /data/myfile.ttl [MANDATORY]
+		input to be validated (only .ttl format supported)
+	-shapesfile /data/myshapes.ttl [OPTIONAL]
+		shapes for validation (only .ttl format supported)
+```