You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by un...@apache.org on 2005/01/14 15:42:01 UTC

svn commit: r125168 - in incubator/jackrabbit/trunk/xdocs: . arch arch/overview images/arch

Author: uncled
Date: Fri Jan 14 06:41:59 2005
New Revision: 125168

URL: http://svn.apache.org/viewcvs?view=rev&rev=125168
Log:
explainations about jcr-levels added to architecture documentation
Added:
   incubator/jackrabbit/trunk/xdocs/arch/overview/
   incubator/jackrabbit/trunk/xdocs/arch/overview/jcrlevels.xml   (contents, props changed)
   incubator/jackrabbit/trunk/xdocs/images/arch/level-1.jpg   (contents, props changed)
   incubator/jackrabbit/trunk/xdocs/images/arch/level-2.jpg   (contents, props changed)
   incubator/jackrabbit/trunk/xdocs/images/arch/level-adv.jpg   (contents, props changed)
Modified:
   incubator/jackrabbit/trunk/xdocs/arch/overview.xml
   incubator/jackrabbit/trunk/xdocs/navigation.xml

Modified: incubator/jackrabbit/trunk/xdocs/arch/overview.xml
Url: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/xdocs/arch/overview.xml?view=diff&rev=125168&p1=incubator/jackrabbit/trunk/xdocs/arch/overview.xml&r1=125167&p2=incubator/jackrabbit/trunk/xdocs/arch/overview.xml&r2=125168
==============================================================================
--- incubator/jackrabbit/trunk/xdocs/arch/overview.xml	(original)
+++ incubator/jackrabbit/trunk/xdocs/arch/overview.xml	Fri Jan 14 06:41:59 2005
@@ -74,7 +74,7 @@
 <p>
 The Content Repository API Layer is split into two major sections.
 <ul>
-<li>The Content Repository API defined by JSR-170</li>
+<li><a href="overview/jcrlevels.html">The Content Repository API defined by JSR-170</a></li>
 <li>A number features of a content repository, that have been removed from the JSR-170 specification since they are difficult to implement on existing non-java-based content repositories and administrational Repository tasks that have also been deliberately excluded from JSR-170</li>
 </ul>
 </p>

Added: incubator/jackrabbit/trunk/xdocs/arch/overview/jcrlevels.xml
Url: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/xdocs/arch/overview/jcrlevels.xml?view=auto&rev=125168
==============================================================================
--- (empty file)
+++ incubator/jackrabbit/trunk/xdocs/arch/overview/jcrlevels.xml	Fri Jan 14 06:41:59 2005
@@ -0,0 +1,93 @@
+<?xml version="1.0"?>
+<!--
+   Copyright 2004-2005 The Apache Software Foundation or its licensors,
+                       as applicable.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+  -->
+<document>
+ <properties>
+  <title>Levels of Content Repository API for Java Technology (JSR-170)</title>
+ </properties>
+ <body>
+
+<section name="JSR-170 Levels">
+<p>
+The Content Repository API for Java Technology (JSR-170) is split into different
+Levels of compliancy, to allow Repository Vendors to gradually adopt JSR-170
+and to avoid that the overhead is unnecessarily high for repository vendors
+that only want to expose portions of their repository functionality through
+a JSR-170 compliant Interface.
+</p>
+<p>
+JSR-170 specifies a Level 1, a Level 2 and a set of advanced repository 
+feature blocks. Jackrabbit is fully JSR-170 compliant and therefore
+supports Level 1, Level 2 and all the optional blocks.
+</p>
+</section>
+
+<section name="Level 1 : Ease of Adoption, Covering many usecases">
+<p>
+The Scope of Level 1 of JSR-170 to cover a large number of simple 
+Applications, that need to search repositories and need to read 
+from repositories.
+Level 1 specifies a read-only API that allows to 
+introspect Node and Property-types and offers hierarchical
+read access to content stored in a repository.
+</p>
+<img src="../../images/arch/level-1.jpg"/>
+<p>
+Level 1 of JSR-170 is geared to allow people to write 
+applications such as search and display Portlets, 
+CMS-Templates, Reports, Exports or other applications 
+that harvest, search, present or display information 
+from one or multiple repositories.
+</p>
+</section>
+
+<section name="Level 2 : Writeable Repository">
+<p>
+Level 2 of JSR-170 specifies all the writing 
+capabilities need to bi-directionally interact with a
+content repository in a fine and coarse grained 
+fashion.
+</p>
+<img src="../../images/arch/level-2.jpg"/>
+<p>
+Applications written against Level 2 of JSR-170 include
+management applications or generally speaking any 
+application that generates data, information or content
+for both structured and unstrcutured information.
+</p>
+</section>
+
+<section name="Advanced Options">
+<p>
+On top of Level 1 or Level 2 a number of functional 
+block serve for more advanced repository functionality.
+This includes functions like: Versioning, 
+(JTA) Transactions, Query using SQL, Explicit 
+Locking and Content Observation.
+</p>
+<img src="../../images/arch/level-adv.jpg" />
+<p>
+A fully JSR-170 compliant repository like Jackrabbit
+encompasses all the functionalities and therefore
+lends itself as general purpose, off-the-shelf 
+infrastructure for Content-, Document- and
+Source Code Management or for just about any 
+other application that persists content.
+</p>
+</section>
+</body>
+</document>

Added: incubator/jackrabbit/trunk/xdocs/images/arch/level-1.jpg
Url: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/xdocs/images/arch/level-1.jpg?view=auto&rev=125168
==============================================================================
Binary file. No diff available.

Added: incubator/jackrabbit/trunk/xdocs/images/arch/level-2.jpg
Url: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/xdocs/images/arch/level-2.jpg?view=auto&rev=125168
==============================================================================
Binary file. No diff available.

Added: incubator/jackrabbit/trunk/xdocs/images/arch/level-adv.jpg
Url: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/xdocs/images/arch/level-adv.jpg?view=auto&rev=125168
==============================================================================
Binary file. No diff available.

Modified: incubator/jackrabbit/trunk/xdocs/navigation.xml
Url: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/xdocs/navigation.xml?view=diff&rev=125168&p1=incubator/jackrabbit/trunk/xdocs/navigation.xml&r1=125167&p2=incubator/jackrabbit/trunk/xdocs/navigation.xml&r2=125168
==============================================================================
--- incubator/jackrabbit/trunk/xdocs/navigation.xml	(original)
+++ incubator/jackrabbit/trunk/xdocs/navigation.xml	Fri Jan 14 06:41:59 2005
@@ -21,7 +21,9 @@
   <menu name="Apache Jackrabbit">
     <item name="Overview"               href="/index.html" />
     <item name="Architecture&#xA0;Doc"  href="/arch/index.html"  collapse="true">
-      <item name="Overview"                 href="/arch/overview.html"/>
+      <item name="Overview"                 href="/arch/overview.html" collapse="true">
+        <item name="JSR-170 Levels"         href="/arch/overview/jcrlevels.html"/>
+      </item>
       <item name="Deployment&#xA0;Options"  href="/arch/deploy.html"/>
       <item name="Core&#xA0;Operations"     href="/arch/operate/index.html"  collapse="true">
         <item name="Start-up,&#xA0;Initialize" href="/arch/operate/startup.html"/>