You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by bu...@apache.org on 2015/07/16 10:53:14 UTC
svn commit: r958531 - in /websites/staging/jena/trunk/content: ./
documentation/fuseki2/fuseki-server-protocol.html
Author: buildbot
Date: Thu Jul 16 08:53:14 2015
New Revision: 958531
Log:
Staging update by buildbot for jena
Modified:
websites/staging/jena/trunk/content/ (props changed)
websites/staging/jena/trunk/content/documentation/fuseki2/fuseki-server-protocol.html
Propchange: websites/staging/jena/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jul 16 08:53:14 2015
@@ -1 +1 @@
-1690917
+1691339
Modified: websites/staging/jena/trunk/content/documentation/fuseki2/fuseki-server-protocol.html
==============================================================================
--- websites/staging/jena/trunk/content/documentation/fuseki2/fuseki-server-protocol.html (original)
+++ websites/staging/jena/trunk/content/documentation/fuseki2/fuseki-server-protocol.html Thu Jul 16 08:53:14 2015
@@ -144,7 +144,18 @@
<div class="col-md-12">
<div id="breadcrumbs"></div>
<h1 class="title"></h1>
- <h1 id="fuseki-http-administration-protocol">Fuseki HTTP Administration Protocol</h1>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h1 id="fuseki-http-administration-protocol">Fuseki HTTP Administration Protocol<a class="headerlink" href="#fuseki-http-administration-protocol" title="Permanent link">¶</a></h1>
<blockquote>
<p><em>These functions are available in version 2.0 and later.</em></p>
</blockquote>
@@ -165,8 +176,8 @@ for an overview of server administration
<p>All admin operations have URL paths starting <code>/$/</code> to avoid clashes with
dataset names and this prefix is reserved for the Fuseki control functions.
Further operations may be added within this naming scheme.</p>
-<h2 id="operations">Operations</h2>
-<table>
+<h2 id="operations">Operations<a class="headerlink" href="#operations" title="Permanent link">¶</a></h2>
+<table class="table">
<thead>
<tr>
<th>Method</th>
@@ -271,6 +282,11 @@ Further operations may be added within t
<td></td>
</tr>
<tr>
+<td><tt>GET</tt></td>
+<td><code>/$/backup-list/</code></td>
+<td></td>
+</tr>
+<tr>
<td><tt>POST</tt></td>
<td><code>/$/sleep</code></td>
<td></td>
@@ -292,22 +308,22 @@ Further operations may be added within t
</tr>
</tbody>
</table>
-<h2 id="ping">Ping</h2>
+<h2 id="ping">Ping<a class="headerlink" href="#ping" title="Permanent link">¶</a></h2>
<p>Pattern: <code>/$/ping</code></p>
<p>The URL <code>/$/ping</code> is a guaranteed low cost point to test whether a server
is running or not. It returns no other information other than to respond to the
request over <code>GET</code> or <code>POST</code> (to avoid any HTTP caching) with a 200 response.</p>
<p>Return: empty body</p>
-<h2 id="server-information">Server Information</h2>
+<h2 id="server-information">Server Information<a class="headerlink" href="#server-information" title="Permanent link">¶</a></h2>
<p>Pattern: <code>/$/server</code></p>
<p>The URL <code>/$/server</code> returns details about the server and it's current status in JSON.</p>
<p><em>@@details of JSON format.</em></p>
-<h2 id="datasets-and-services">Datasets and Services</h2>
+<h2 id="datasets-and-services">Datasets and Services<a class="headerlink" href="#datasets-and-services" title="Permanent link">¶</a></h2>
<p>Pattern: <code>/$/datasets/</code></p>
<p><code>/$/datasets/</code> is a container representing all datasets present in the server.
<code>/$/datasets/*{name}*</code> names a specific dataset. As a container, operations on items
in the container, via <code>GET</code>, <code>POST</code> and <code>DELETE</code>, operate on specific dataset.</p>
-<h3 id="adding-a-dataset-and-its-services">Adding a Dataset and its Services.</h3>
+<h3 id="adding-a-dataset-and-its-services">Adding a Dataset and its Services.<a class="headerlink" href="#adding-a-dataset-and-its-services" title="Permanent link">¶</a></h3>
<blockquote>
<p><em>@@ May add server-managed templates</em></p>
</blockquote>
@@ -324,10 +340,10 @@ for doing this: </p>
the dataset is persists across restart.</p>
<p>For in-memory datasets, the dataset is rebuilt from it's description
(this may include loading data from a file) but any changes are lost.</p>
-<h4 id="templates">Templates</h4>
+<h4 id="templates">Templates<a class="headerlink" href="#templates" title="Permanent link">¶</a></h4>
<p>A short-cut form for some common set-ups is provided by <tt>POST</tt>ing with
the following parameters (query string or HTML form):</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Parameter</th>
@@ -347,24 +363,24 @@ the following parameters (query string o
</table>
<p>The dataset name must not be already in-use.</p>
<p>Datasets are created in director <code>databases/</code>.</p>
-<h4 id="assembler-example">Assembler example</h4>
+<h4 id="assembler-example">Assembler example<a class="headerlink" href="#assembler-example" title="Permanent link">¶</a></h4>
<p>The assembler description contains data and service. It can be sent by posting the assembler RDF graph
in any RDF format or by posting from an HTML form (the syntax must be Turtle).</p>
<p>The assembler file is stored by the server will be used on restart or when makign the datsset active again.</p>
<blockquote>
<p><em>@@</em></p>
</blockquote>
-<h3 id="removing-a-dataset">Removing a Dataset</h3>
+<h3 id="removing-a-dataset">Removing a Dataset<a class="headerlink" href="#removing-a-dataset" title="Permanent link">¶</a></h3>
<p>Note: <code>DELETE</code> means "gone for ever". The dataset name and the details of its
configuration are completely deleted and can not be recovered. </p>
<p>The data of a TDB dataset is not deleted.</p>
-<h3 id="active-and-offline">Active and Offline</h3>
+<h3 id="active-and-offline">Active and Offline<a class="headerlink" href="#active-and-offline" title="Permanent link">¶</a></h3>
<p>A dataset is in one of two modes: "active", meaning it is services request over HTTP
(subject to configuration and security), or "offline", meaning the configuration and name
is known about by the server but the dataset is not attached to the server. When "offline",
any persistent data can be manipulated outside the server.</p>
<p>Datasets are initially "active". The transition from "active" to "offline" is graceful - all outstanding requests are completed.</p>
-<h2 id="statistics">Statistics</h2>
+<h2 id="statistics">Statistics<a class="headerlink" href="#statistics" title="Permanent link">¶</a></h2>
<blockquote>
<p><strong><code>/$/stats/*{name}*</code></strong></p>
</blockquote>
@@ -374,16 +390,21 @@ any persistent data can be manipulated o
<p><em>@@ stats details</em>
See <a href="fuseki-stats.html">Fuseki Statistics</a> for details of statistics kept by a Fuseki server.</p>
</blockquote>
-<h3 id="backup">Backup</h3>
+<h3 id="backup">Backup<a class="headerlink" href="#backup" title="Permanent link">¶</a></h3>
<p>Pattern: <code>/$/backup/*{name}*</code></p>
<p>This operation initiates a backup and returns a JSON object with the task Id in it.</p>
-<p>Backups are written to the server local directory 'backups' as gzip-compressed N-Quads files.</p>
+<p>Backups are written to the server local directory 'backups' as gzip-compressed N-Quads files.</p>
<p>See <a href="#tasks">Tasks</a> for how to monitor a backups progress.</p>
<p>Return: A task is allocated a identifier (usually, a number).
<code>{ "taskId" : "*{taskId}*" }</code>
The task id can be used to construct a URL to get details of the task:
<code>/$/tasks/*{taskId}*</code></p>
-<h2 id="tasks">Tasks</h2>
+<p>Pattern: <code>/$/backups-lists/</code></p>
+<p>Returns a list of all the files in the backup area of the server. This is
+useful for managing the files externally.</p>
+<p>The returned JOSN object is <code>{ backups: [ ... ] }</code> where the <code>[]</code> array is
+a list of file names.</p>
+<h2 id="tasks">Tasks<a class="headerlink" href="#tasks" title="Permanent link">¶</a></h2>
<p>Some operations cause a backgrond task to be executed, backup is an example.
The result of such operations includes a json object with teh task id and
also a <code>Location:</code> header with the URL of the task created.</p>