README.md

OWL Fuseki

A tool to start and stop a UI or UI-less Fuseki server with a given configuration file

Run as CLI

MacOS/Linux:

./gradlew owl-fuseki:run --args="..."

Windows:

gradlew.bat owl-fuseki:run --args="..."

Args:

-c   | --command start|stop [Required]
-g   | --configurationPath path/to/.fuseki.ttl [Required]
-o   | --outputFolderPath path/to/output/folder [Required]
-url | --remote-repository-url <url>	 [Optional, default: https://repo.maven.apache.org/maven2/]
-fv  | --fuseki-version  <version> [Optional, default: 4.6.1]
-p   | --port <port> [Optional, default: 3030)
-ui  | --webui [Optional]
-n   | --max-pings [Optional]
-cp  | --classpath group:artifact:exact-version [Optional, additional classpath dependencies]
-jvm | --jvm-arguments "-Xms256m" [Optional, additional JVM arguments]

Run as Gradle Task

This is an incremental task; Gradle will determine whether to run this task if any of the properties changed in values.

Example usage:

repositories {
    mavenLocal() 
    mavenCentral()
}

dependencies {
	classpath 'io.opencaesar.owl:owl-fuseki-gradle:3.+'
}

task startFuseki(type: io.opencaesar.owl.fuseki.StartFusekiTask) {
	configurationPath = file('path/to/.fuseki.ttl') // required
	outputFolderPath = file('path/to/output/folder') // required
	remoteRepositoryURL = 'some-url' // optional, default: 'https://repo.maven.apache.org/maven2/'
	fusekiVersion = '4.6.1' // optional, default: '4.6.1'
	port = 3030 // optional, default: 3030
	webUI = true // optional, default: false [creates a 'webapp' subfolder under outputFolderPath]
	maxPings = 10 // optional, default: 10
	classpath = ['group:artifact:exact-version'] // optional
	jvmArguments = ['-Xms256m'] // optional
}

task stopFuseki(type: io.opencaesar.owl.fuseki.StopFusekiTask) {
	outputFolderPath = file('path/to/output/folder') // required
}

Example of .fuseki.ttl:

@prefix fuseki:  <http://jena.apache.org/fuseki#> .
@prefix rdf:     <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs:    <http://www.w3.org/2000/01/rdf-schema#> .
@prefix tdb:     <http://jena.hpl.hp.com/2008/tdb#> .
@prefix ja:      <http://jena.hpl.hp.com/2005/11/Assembler#> .
@prefix :        <#> .

[] rdf:type fuseki:Server .

<#service> rdf:type fuseki:Service ;
    rdfs:label          "Oml Template" ;												# Human readable label for dataset
    fuseki:name         "oml-template" ;												# Name of the dataset in the endpoint url
    fuseki:serviceReadWriteGraphStore "data" ;											# SPARQL Graph store protocol (read and write)
    fuseki:endpoint 	[ fuseki:operation fuseki:query ;	fuseki:name "sparql"  ] ;	# SPARQL query service
    fuseki:endpoint 	[ fuseki:operation fuseki:shacl ;	fuseki:name "shacl" ] ;		# SHACL query service
    fuseki:dataset      <#dataset> .

# In memory TDB with union graph.
<#dataset> rdf:type   tdb:DatasetTDB ;
  tdb:location "--mem--" ;
  # Query timeout on this dataset (1s, 1000 milliseconds)
  ja:context [ ja:cxtName "arq:queryTimeout" ; ja:cxtValue "1000" ] ;
  # Make the default graph be the union of all named graphs.
  tdb:unionDefaultGraph true .