Running a HeFQUIN Service via a separate servlet container

HeFQUIN can be deployed as a web service using any Java servlet container such as Apache Tomcat, Eclipse Jetty, and GlassFish. This page describes how you can do this ...

by using one of the available releases or
by using the current developer version in the source code repository.

In either case, after starting it up, you can interact with the service like a SPARQL endpoint.

Use an Available Release

With every HeFQUIN release, we provide a WAR file that you can download and, then, simply deploy in your servlet container. After starting the servlet, you can test it by opening http://localhost:8080/ in a Web browser, and you can interact with the service like a SPARQL endpoint (the SPARQL endpoint should be exposed at http://localhost:8080/sparql).

If you want to configure the HeFQUIN service (e.g., with a description of your own federation), you can do so by placing a config.properties file in the working directory. The content of this file may look as follows.

FED_CONF_FILE=MyFedConf.ttl         # description of your federation

### Uncomment the following line if you want to use
### a custom configuration of the HeFQUIN engine.
#ENGINE_CONF_FILE=MyCustomEngineConf.ttl

Use a Version of the Source Code

You can also create a WAR file of the current developer version of HeFQUIN (or any other snapshot of the HeFQUIN source code). To do so, you need a local clone of the GitHub repository of HeFQUIN.

If you have not cloned the repository already, you can clone it either by using the SSH URL:

git clone git@github.com:LiUSemWeb/HeFQUIN.git

or by using the HTTP URL:

git clone https://github.com/LiUSemWeb/HeFQUIN.git

If you have cloned the repository earlier, make sure that you pull the latest version of the source code into your local clone:

git checkout main
git pull

Within the directory into which you have cloned the repo, you can now compile the WAR file using Maven by executing the following command.

mvn clean package && mvn package -pl hefquin-service -P build-war -am

Assuming the build finishes successfully, you find the WAR file in the subdirectory ./hefquin-service/target/. After deploying it in your servlet container, you can test and configure the service as described above.