You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by bu...@apache.org on 2012/07/16 15:22:15 UTC
svn commit: r825993 - in /websites/staging/stanbol/trunk/content: ./
stanbol/docs/trunk/components/cmsadapter/cmsadapter5min.html
stanbol/docs/trunk/components/entityhub/index.html
stanbol/docs/trunk/components/index.html
Author: buildbot
Date: Mon Jul 16 13:22:14 2012
New Revision: 825993
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/cmsadapter/cmsadapter5min.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/entityhub/index.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/index.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Jul 16 13:22:14 2012
@@ -1 +1 @@
-1362024
+1362026
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/cmsadapter/cmsadapter5min.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/cmsadapter/cmsadapter5min.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/cmsadapter/cmsadapter5min.html Mon Jul 16 13:22:14 2012
@@ -20,7 +20,7 @@
-->
<link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
- <title>Apache Stanbol - </title>
+ <title>Apache Stanbol - 5 Minutes Tutorial for CMS Adapter</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="icon" type="image/png" href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
<script type="text/javascript">
@@ -84,9 +84,8 @@
<div class="breadcrump" style="font-size: 80%;">
<a href="/">Home</a> » <a href="/stanbol/">Stanbol</a> » <a href="/stanbol/docs/">Docs</a> » <a href="/stanbol/docs/trunk/">Trunk</a> » <a href="/stanbol/docs/trunk/components/">Components</a> » <a href="/stanbol/docs/trunk/components/cmsadapter/">Cmsadapter</a>
</div>
- <h1 class="title"></h1>
- <h1 id="5-minutes-documentation-for-cms-adapter">5 Minutes Documentation for CMS Adapter</h1>
-<p>The CMS Adapter component acts as a bridge between content management systems and the Apache Stanbol. Please note that all components of Apache Stanbol also provides RESTful services which allow accessing them directly from outside. CMS Adapter interacts with content management systems through JCR and CMIS specifications. In other words, any content repository compliant with JCR or CMIS specifications can make use of CMS Adapter functionalities. For the time being, there are two main functionalities that CMS Adapter offers: "Bidirectional Mapping" and "Contenthub Feed". </p>
+ <h1 class="title">5 Minutes Tutorial for CMS Adapter</h1>
+ <p>The CMS Adapter component acts as a bridge between content management systems and the Apache Stanbol. Please note that all components of Apache Stanbol also provides RESTful services which allow accessing them directly from outside. CMS Adapter interacts with content management systems through JCR and CMIS specifications. In other words, any content repository compliant with JCR or CMIS specifications can make use of CMS Adapter functionalities. For the time being, there are two main functionalities that CMS Adapter offers: "Bidirectional Mapping" and "Contenthub Feed". </p>
<p><strong>Note</strong>: URLs given in the curl commands and link are valid as long as full launcher of the Stanbol is launched with the default configurations. In other words, it assumed that the root URL of the Stanbol is <strong>http://localhost:8080</strong>.</p>
<h2 id="session-management">Session Management</h2>
<p>To be able to use Contenthub features, it is necessary to get a session key beforehand. While obtaining this key, CMS Adapter caches a JCR/CMIS session to be used when the generated session key is passed in the subsequent operations that require interaction with the content repository. A session can key can be obtained through REST services as follows:</p>
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/entityhub/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/entityhub/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/entityhub/index.html Mon Jul 16 13:22:14 2012
@@ -92,13 +92,13 @@
<li><strong>Entityhub</strong> (<code>/entityhub</code>): Allows to manage local entities as well as import entities from Sites or to define mappings from local Entities to Entities managed by Sites. An Apache Stanbol instance can only have a single Entityhub so if you want to manage multiple controlled vocabularies you should preferable use <a href="managedsite.html">ManagedSite</a> instead.</li>
<li><strong>Site Manager</strong> (<code>/entityhub/sites</code>): The SiteManager provides a unified access to all currently active Sites - your Entity Network. Requests sent to this endpoint will be forwarded to all currently active Sites. Users should note that queries (requests to the <code>/entityhub/sites/find</code> and <code>/entityhub/sites/query</code> endpoints) might be slow as remote services might need to be called for answering those requests. Retrieval of Entities (requests to the <code>/entityhub/sites/entity</code> endpoint) and also LDpath requests should perform reasonable well.</li>
<li><strong>Sites</strong> (<code>/entityhub/site/{siteId}</code>): Sites represent entity sources that are integrated with the Stanbol Entityhub. There are two different types of Sites<ul>
-<li><strong>ReferencedSite</strong>: This site allows to refer remote services to dereference (Entity id based retrieval) and query entities. It also supports local caches and indexes. A local cache allows to locally store retrieved Entity data to speed-up retrieval on subsequent requests. A local index is a locally available index over all/some of the data of the remote dataset. If such an index is available all requests will be processed using the index. The remote services are only used as a fallback. Local Indexes are created by the Entityhub Indexing tool. The usage scenario <a href="../customvocabulary.html">Working with Custom Vocabularies</a> provides a good overview on how to use this feature.</li>
+<li><strong>ReferencedSite</strong>: This site allows to refer remote services to dereference (Entity id based retrieval) and query entities. It also supports local caches and indexes. A local cache allows to locally store retrieved Entity data to speed-up retrieval on subsequent requests. A local index is a locally available index over all/some of the data of the remote dataset. If such an index is available all requests will be processed using the index. The remote services are only used as a fallback. Local Indexes are created by the Entityhub Indexing tool. The usage scenario <a href="../../customvocabulary.html">Working with Custom Vocabularies</a> provides a good overview on how to use this feature.</li>
<li><strong>ManagedSite</strong>: <a href="managedsite.html">ManagedSites</a> allow users to manage their own entity by using the RESTful API of the Entityhub. They are very similar to the <code>/entityhub</code> endpoint but do not allow to manage mappings are to import Entities from other Sites.</li>
</ul>
</li>
</ul>
<h2 id="restful-services">RESTful services</h2>
-<p>The documentation of the RESTful services provided by the Stanbol Entityhub is served by the Web UI of your Stanbol instance. If you do not have a running Stanbol server <a href="../tutorial.html">this introduction</a> provides you with all necessary information. You can also try to access the documentation on the Stanbol demo server available on the <a href="http://dev.iks-project.eu/">IKS development server</a> at <a href="http://dev.iks-project.eu:8081/entityhub">http://dev.iks-project.eu:8081/entityhub</a>.</p>
+<p>The documentation of the RESTful services provided by the Stanbol Entityhub is served by the Web UI of your Stanbol instance. If you do not have a running Stanbol server <a href="../../tutorial.html">this introduction</a> provides you with all necessary information. You can also try to access the documentation on the Stanbol demo server available on the <a href="http://dev.iks-project.eu/">IKS development server</a> at <a href="http://dev.iks-project.eu:8081/entityhub">http://dev.iks-project.eu:8081/entityhub</a>.</p>
</div>
<div id="footer">
Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/index.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/index.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/components/index.html Mon Jul 16 13:22:14 2012
@@ -87,8 +87,21 @@
<h1 class="title">Apache Stanbol Components</h1>
<p><img alt="Apache Stanbol Components" src="stanbol-components.png" title="Overview on the different Components included by Apache Stanbol" />
<figcaption>Figure 1: The Apache Stanbol Components</figcaption></p>
+<ul>
+<li>Jump to<ul>
+<li><a href="enhancer/">Enhancer</a> and <a href="enhancer/engines/">Enhancement Engines</a></li>
+<li><a href="entityhub/">Entityhub</a></li>
+<li><a href="contenthub/">Contenthub</a></li>
+<li><a href="ontologymanager/">Ontology Manager</a></li>
+<li><a href="rules/">Rules</a></li>
+<li><a href="reasoner/">Reasoners</a></li>
+<li><a href="cmsadapter/">CMS Adapter</a></li>
+<li><a href="factstore/">FactStore</a></li>
+</ul>
+</li>
+</ul>
<p>Apache Stanbol is built as a modular set of components. Each component is accessible via its own RESTful web interface. From this viewpoint, all Apache Stanbol features can be used via RESTful service calls. </p>
-<p>Components do not depend on each other. However they can be easily combined if needed as shown by the different <a href="scenarios.html">Usage Scenarios</a>. This ensures that the list of used components depend on the specific usage scenario and not on the Stanbol architecture.</p>
+<p>Components do not depend on each other. However they can be easily combined if needed as shown by the different <a href="scenarios.html">usage scenarios</a>. This ensures that the list of used components depend on the specific usage scenario and not on the Apache Stanbol architecture.</p>
<p>All components are implemented as <a href="http://www2.osgi.org/Specifications/HomePage">OSGi</a> bundles, components and services. By default Apache Stanbol uses <a href="http://felix.apache.org">Apache Felix</a> as OSGi environment. However generally we try to avoid the use of Felix specific features. If you need to run Stanbol in an other OSGi environment an encounter problems tell us by opening a <a href="https://issues.apache.org/jira/browse/STANBOL">JIRA issue</a> and/or asking about it on the Stanbol Developer <a href="mailinglists.html">mailing list</a>.</p>
<p>For deployment Stanbol uses the <a href="http://sling.apache.org">Apache Sling</a> launcher. While the Stanbol Community maintains different launcher options including run-able JARs and WAR files we expect users to configure their custom launchers optimized for their usage scenario. However it os also possible to us Stanbol with other launchers (such as <a href="http://karaf.apache.org/">Apache Karaf</a>) or to add its bundles to any existing OSGi environment.</p>
<p>Figure 2 depicts the main Apache Stanbol components and their arrangement within the Apache Stanbol architecture.</p>