OWLIM-SE Usage Scenarios

Version 1 by barry.bishop
on May 24, 2011 20:03.

compared with
Current by barry.bishop
on Jan 31, 2012 00:13.

(show comment)
Key
This line was removed.
This word was removed. This word was added.
This line was added.

Changes (4)

View Page History
* the Sesame server and workbench Web applications (Java Enterprise Edition servlet components, referred to on the diagram below as "Sesame Web UI").

This section will describe using the Sesame API to create and access OWLIM-SE repositories, both on the local file-system and remotely via the Sesame HTTP server, plus a brief introduction will be given to the Sesame workbench Web application that provides many repository management functions through a convenient user interface. This is followed by information on using OWLIM-SE with Jena and some related components, i.e. [ARQ|http://jena.sourceforge.net/ARQ/] and [Joseki|http://www.joseki.org/] .

h1. Sesame Application Programming Interface (API)

Programmatically, OWLIM is used via the Sesame Java framework of classes and interfaces. Documentation for these interfaces (including Javadoc) can be found at [http://www.openrdf.org|http://www.openrdf.org]. Code snippets in the following sections are taken from (or are variations of) the GettingStarted example program that comes with the OWLIM-SE distribution.

h2. Using the Sesame API to access a local OWLIM repository
h1. Managing repositories with the Sesame Workbench

The [installation section|OWLIM-SE Installation] explains how to set up an OWLIM-SE repository that is exposed via the Sesame HTTP Server. In summary, the Sesame Server and Workbench applications are deployed to a Tomcat instance and the necessary library files (OWLIM-SE, Lucene, etc) are copied to the correct locations. After this, the Sesame console application is used with the {{owlim.ttl}} repository template file to connect to the Sesame server and create a repository instance.
When the Sesame server is running, it will show a welcome message at the following URL:
{noformat}http://<hostname|ip_address>:8080/openrdf-sesame{noformat}The server has a simple user interface that shows status, logging and configuration information.
{noformat}http://<hostname|ip_address>:8080/openrdf-workbench{noformat}The workbench lists repositories and their namespaces, allows for the addition and deletion of statements, and provides a query interface for SPARQL and SeRQL query languages. However, the list of repository types is currently hard-coded in the workbench, so an OWLIM repository must still be created using the Sesame console application, as described in the [installation section|OWLIM-SE Installation].

h1. SPARQL endpoint

The Sesame HTTP server is a fully fledged SPARQL endpoint - the Sesame HTTP protocol is a super-set of the [SPARQL 1.1 protocol|http://www.w3.org/TR/sparql11-protocol/] - that provides an interface for transmitting SPARQL queries and updates to a SPARQL processing service and returning the results via HTTP to the entity that requested them.

Any tools or utilities designed to interoperate with the SPARQL protocol will function with OWLIM when deployed using the Sesame HTTP server, i.e. the openrdf-sesame Web application.

h1. Graph Store HTTP Protocol

As of Sesame version 2.6.3, the SPARQL 1.1 Graph Store HTTP Protocol is fully supported for direct and indirect graph names. The [W3C working draft|http://www.w3.org/TR/sparql11-http-rdf-update/] has the most details, although further information can be found in the [Sesame user guide|http://www.openrdf.org/doc/sesame2/system/ch08.html].

This protocol supports the management of RDF statements in named graphs in the REST style, by providing the ability to get, delete, add to or overwrite statement in named graphs using the basic HTTP methods.


h1. Using OWLIM-SE with Jena