You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by an...@apache.org on 2014/02/26 19:55:57 UTC
svn commit: r1572196 - in /jackrabbit/site/live/oak/docs: ./ META-INF/
security/
Author: angela
Date: Wed Feb 26 18:55:55 2014
New Revision: 1572196
URL: http://svn.apache.org/r1572196
Log:
OAK-936: Site checkin for project Oak Documentation-0.16-SNAPSHOT
Modified:
jackrabbit/site/live/oak/docs/META-INF/NOTICE
jackrabbit/site/live/oak/docs/blobstore.html
jackrabbit/site/live/oak/docs/construct.html
jackrabbit/site/live/oak/docs/dev_getting_started.html
jackrabbit/site/live/oak/docs/differences.html
jackrabbit/site/live/oak/docs/differences_accesscontrol.html
jackrabbit/site/live/oak/docs/differences_authentication.html
jackrabbit/site/live/oak/docs/differences_permission.html
jackrabbit/site/live/oak/docs/differences_principal.html
jackrabbit/site/live/oak/docs/differences_privileges.html
jackrabbit/site/live/oak/docs/differences_user.html
jackrabbit/site/live/oak/docs/documentmk.html
jackrabbit/site/live/oak/docs/dos_and_donts.html
jackrabbit/site/live/oak/docs/downloads.html
jackrabbit/site/live/oak/docs/from_here.html
jackrabbit/site/live/oak/docs/index.html
jackrabbit/site/live/oak/docs/jsop-diff.html
jackrabbit/site/live/oak/docs/known_issues.html
jackrabbit/site/live/oak/docs/license.html
jackrabbit/site/live/oak/docs/microkernel.html
jackrabbit/site/live/oak/docs/nodestate.html
jackrabbit/site/live/oak/docs/overview.html
jackrabbit/site/live/oak/docs/participating.html
jackrabbit/site/live/oak/docs/query.html
jackrabbit/site/live/oak/docs/security/external_login_module.html
jackrabbit/site/live/oak/docs/security/permission_eval.html
jackrabbit/site/live/oak/docs/segmentmk.html
jackrabbit/site/live/oak/docs/use_getting_started.html
jackrabbit/site/live/oak/docs/when_things_go_wrong.html
Modified: jackrabbit/site/live/oak/docs/META-INF/NOTICE
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/META-INF/NOTICE?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/META-INF/NOTICE (original)
+++ jackrabbit/site/live/oak/docs/META-INF/NOTICE Wed Feb 26 18:55:55 2014
@@ -1,6 +1,6 @@
Oak Documentation
-Copyright 2012-2013 The Apache Software Foundation
+Copyright 2012-2014 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
Modified: jackrabbit/site/live/oak/docs/blobstore.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/blobstore.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/blobstore.html (original)
+++ jackrabbit/site/live/oak/docs/blobstore.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - The Blob Store</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/construct.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/construct.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/construct.html (original)
+++ jackrabbit/site/live/oak/docs/construct.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Repository construction</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/dev_getting_started.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/dev_getting_started.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dev_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/dev_getting_started.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Getting Started</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/differences.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences.html (original)
+++ jackrabbit/site/live/oak/docs/differences.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Backward compatibility</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
@@ -435,6 +435,9 @@
<li>
<p>Unregistering an observation listener blocks for no more than one second. If a pending <tt>onEvent()</tt> call does not complete by then a warning is logged and the listener will be unregistered without further waiting for the pending <tt>onEvent()</tt> call to complete. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1290">OAK-1290</a> and <a class="externalLink" href="https://java.net/jira/browse/JSR_333-74">JSR_333-74</a> for further information.</p></li>
+
+<li>
+<p>See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1459">OAK-1459</a> for a comparison of events being generated on Jackrabbit 2 vs. on Oak.</p></li>
</ul></div>
<div class="section">
<h2>Binary streams<a name="Binary_streams"></a></h2>
Modified: jackrabbit/site/live/oak/docs/differences_accesscontrol.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_accesscontrol.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_accesscontrol.html (original)
+++ jackrabbit/site/live/oak/docs/differences_accesscontrol.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - AccessControl Management : Differences wrt Jackrabbit 2.x</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/differences_authentication.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_authentication.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_authentication.html (original)
+++ jackrabbit/site/live/oak/docs/differences_authentication.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Authentication : Differences wrt Jackrabbit 2.x</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/differences_permission.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_permission.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_permission.html (original)
+++ jackrabbit/site/live/oak/docs/differences_permission.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Permission Evaluation : Differences wrt Jackrabbit 2.x</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
@@ -354,7 +354,7 @@
<h4>1. Characteristics of the Default Implementation<a name="a1._Characteristics_of_the_Default_Implementation"></a></h4>
<div class="section">
<h5>General<a name="General"></a></h5>
-<p><i>TODO</i></p></div>
+<p>In general the permission evaluation related code in Oak is intended to be more clearly separated from the access control management such as defined by the JCR and Jackrabbit API. While permission evaluation is considered to be an internal feature of the Oak core module, the package <tt>org.apache.jackrabbit.oak.spi.security.authorization.permission</tt> provides some extensions points that allow to plug custom extensions or implementations of the permission evaluation.</p></div>
<div class="section">
<h5>JCR API<a name="JCR_API"></a></h5>
<div class="section">
@@ -362,7 +362,48 @@
<p>Since Oak the permission related API calls not only allow to pass the action strings defined by JCR specification (see constants defined in <tt>Session.java</tt>) but also handles the names of the permission defined by Oak (see <tt>Permissions#getString(long permissions)</tt>).</p></div></div>
<div class="section">
<h5>Mapping of JCR Actions to Permissions<a name="Mapping_of_JCR_Actions_to_Permissions"></a></h5>
-<p><i>TODO</i></p></div>
+<p>`ACTION_READ’:</p>
+
+<ul>
+
+<li>access control content: <tt>Permissions.READ_ACCESS_CONTROL</tt></li>
+
+<li>regular nodes: <tt>Permissions.READ_NODE</tt></li>
+
+<li>regular properties: <tt>Permissions.READ_PROPERTY</tt></li>
+
+<li>non-existing items: <tt>Permissions.READ</tt></li>
+</ul>
+<p><tt>ACTION_ADD_NODE</tt>:</p>
+
+<ul>
+
+<li>access control content: <tt>Permissions.MODIFY_ACCESS_CONTROL</tt></li>
+
+<li>regular nodes: <tt>Permissions.ADD_NODE</tt></li>
+</ul>
+<p><tt>ACTION_REMOVE</tt>:</p>
+
+<ul>
+
+<li>access control content: <tt>Permissions.MODIFY_ACCESS_CONTROL</tt></li>
+
+<li>regular nodes: <tt>Permissions.REMOVE_NODE</tt></li>
+
+<li>regular properties: <tt>Permissions.REMOVE_PROPERTY</tt></li>
+
+<li>non-existing nodes: <tt>Permissions.REMOVE</tt></li>
+</ul>
+<p><tt>ACTION_SET_PROPERTY</tt>:</p>
+
+<ul>
+
+<li>access control content: <tt>Permissions.MODIFY_ACCESS_CONTROL</tt></li>
+
+<li>regular properties: <tt>Permissions.MODIFY_PROPERTY</tt></li>
+
+<li>non-existing properties: <tt>Permissions.ADD_PROPERTY</tt></li>
+</ul></div>
<div class="section">
<h5>Permissions<a name="Permissions"></a></h5>
<p>The set of permissions supported by Oak are listed in <a class="externalLink" href="http://svn.apache.org/repos/asf/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/security/authorization/permission/Permissions.java">Permissions</a>. The following changes have been compared compared to Jackrabbit 2.x:</p>
@@ -419,9 +460,6 @@
</ul>
<p>For API consumers and applications running on Jackrabbit Oak this means that combinations of multiple moves can not always be properly resolved. Consequently permissions will be evaluated as if the modifications did not include move (in general being more restrictive): If the move leads to changes that are detected by the diff mechanism, regular permissions will be evaluated for all items that appear to be added, removed or modified, while a regular move operations just requires <tt>REMOVE_NODE</tt> permission on the source, <tt>ADD_NODE</tt> and <tt>NODE_TYPE_MANAGEMENT</tt> permissions at the destination.</p></div>
<div class="section">
-<h5>Copy<a name="Copy"></a></h5>
-<p><i>TODO: permission evaluation with copy is not yet implemented <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-920">OAK-920</a></i></p></div>
-<div class="section">
<h5>User Management<a name="User_Management"></a></h5>
<p>By default user management operations require the specific user mgt related permission to be granted for the editing subject. This permission (including a corresponding privilege) has been introduced with Oak 1.0. For backwards compatibility with Jackrabbit 2.x this behavior can be turned off by setting the corresponding configuration flag.</p></div>
<div class="section">
@@ -468,11 +506,11 @@
<ul>
-<li><tt>PermissionProvider</tt>: <i>TODO</i></li>
+<li><tt>PermissionProvider</tt>: Main entry point for Oak internal permission evaluation.</li>
-<li><tt>Permissions</tt>: <i>TODO</i></li>
+<li><tt>Permissions</tt>: The permissions defined, respected and evaluated by the repository.</li>
-<li><tt>PermissionConstants</tt>: <i>TODO</i></li>
+<li><tt>PermissionConstants</tt>: Constants used throughout the permission evaluation.</li>
</ul></div>
<div class="section">
<h4>6. Configuration<a name="a6._Configuration"></a></h4>
Modified: jackrabbit/site/live/oak/docs/differences_principal.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_principal.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_principal.html (original)
+++ jackrabbit/site/live/oak/docs/differences_principal.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Principal Management : Differences wrt Jackrabbit 2.x</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/differences_privileges.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_privileges.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_privileges.html (original)
+++ jackrabbit/site/live/oak/docs/differences_privileges.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Privilege Management : Differences wrt Jackrabbit 2.x</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/differences_user.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_user.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_user.html (original)
+++ jackrabbit/site/live/oak/docs/differences_user.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - User Management : Differences to Jackrabbit 2.x</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/documentmk.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/documentmk.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/documentmk.html (original)
+++ jackrabbit/site/live/oak/docs/documentmk.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Oak DocumentMK</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/dos_and_donts.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/dos_and_donts.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dos_and_donts.html (original)
+++ jackrabbit/site/live/oak/docs/dos_and_donts.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/downloads.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/downloads.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/downloads.html (original)
+++ jackrabbit/site/live/oak/docs/downloads.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Downloads</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/from_here.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/from_here.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/from_here.html (original)
+++ jackrabbit/site/live/oak/docs/from_here.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/index.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/index.html (original)
+++ jackrabbit/site/live/oak/docs/index.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Jackrabbit Oak - the next generation content repository</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/jsop-diff.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/jsop-diff.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/jsop-diff.html (original)
+++ jackrabbit/site/live/oak/docs/jsop-diff.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/known_issues.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/known_issues.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/known_issues.html (original)
+++ jackrabbit/site/live/oak/docs/known_issues.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Known issues</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/license.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/license.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/license.html (original)
+++ jackrabbit/site/live/oak/docs/license.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - License</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/microkernel.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/microkernel.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/microkernel.html (original)
+++ jackrabbit/site/live/oak/docs/microkernel.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/nodestate.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestate.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestate.html (original)
+++ jackrabbit/site/live/oak/docs/nodestate.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Understanding the node state model</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/overview.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/overview.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/overview.html (original)
+++ jackrabbit/site/live/oak/docs/overview.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/participating.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/participating.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/participating.html (original)
+++ jackrabbit/site/live/oak/docs/participating.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Participating</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/query.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/query.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query.html (original)
+++ jackrabbit/site/live/oak/docs/query.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - The Query Engine</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/security/external_login_module.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/security/external_login_module.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/security/external_login_module.html (original)
+++ jackrabbit/site/live/oak/docs/security/external_login_module.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - The Oak Security Layer</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/security/permission_eval.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/security/permission_eval.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/security/permission_eval.html (original)
+++ jackrabbit/site/live/oak/docs/security/permission_eval.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - The Oak Security Layer</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/segmentmk.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/segmentmk.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/segmentmk.html (original)
+++ jackrabbit/site/live/oak/docs/segmentmk.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - SegmentMK design overview</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
@@ -365,18 +365,53 @@
<p>This document describes the overall design of the SegmentMK. See the source code and javadocs in <tt>org.apache.jackrabbit.oak.plugins.segment</tt> for full details.</p>
<h1>Segments</h1>
<p>The content tree and all its revisions are stored in a collection of immutable segments. Each segment is identified by a UUID and typically contains a continuous subset of the content tree, for example a node with its properties and closest child nodes. Some segments might also be used to store commonly occurring property values or other shared data. Segments can be to up to 256KiB in size.</p>
-<p>Segments come in two types: data and bulk segments. A data segment can contain any types of records, may refer to content in other segments and comes with a segment header that guides the parsing of the segment. Bulk segments on the other hand only contain raw binary data, interpreted as a sequence of block records. Bulk segments are only used for storing large binary values, and are handled separately from data segments to prevent large binaries from disrupting the compactness of the rest of the stored tree data.</p>
-<p>The type of a segment is encoded in its UUID and can thus be determined already before reading the segment. The following bit patterns are used (each <tt>x</tt> represents 4 random bits):</p>
+<p>Segments come in two types: data and bulk segments. The type of a segment is encoded in its UUID and can thus be determined already before reading the segment. The following bit patterns are used (each <tt>x</tt> represents four random bits):</p>
<ul>
-<li><tt>xxxxxxxx-xxxx-4xxx-Axxx-xxxxxxxxxxxx</tt>: data segment UUID</li>
+<li><tt>xxxxxxxx-xxxx-4xxx-Axxx-xxxxxxxxxxxx</tt> data segment UUID</li>
-<li><tt>xxxxxxxx-xxxx-4xxx-Bxxx-xxxxxxxxxxxx</tt>: bulk segment UUID</li>
+<li><tt>xxxxxxxx-xxxx-4xxx-Bxxx-xxxxxxxxxxxx</tt> bulk segment UUID</li>
</ul>
-<p>This encoding makes segment UUIDs appear as syntactically valid version 4 random UUIDs specified in RFC 4122.</p>
-<p>Content within a data segment can contain references to content within other segments. Each segment keeps a list of the UUIDs of all other segments it references. This list of segment references can be used to optimize both internal storage (as seen below) and garbage collection. Segments that are no longer referenced can be efficiently identified by traversing the graph of segment-level references without having to parse or even fetch the contents of each segment.</p>
-<p>The internal record structure of nodes is described in a moment once we first cover journal documents.</p>
+<p>(This encoding makes segment UUIDs appear as syntactically valid version 4 random UUIDs specified in RFC 4122.)</p>
+<div class="section">
+<h2>Bulk segments<a name="Bulk_segments"></a></h2>
+<p>Bulk segments contain raw binary data, interpreted simply as a sequence of block records with no headers or other extra metadata:</p>
+
+<div class="source">
+<pre>[block 1] [block 2] ... [block N]
+</pre></div>
+<p>A bulk segment whose length is <tt>n</tt> bytes consists of <tt>n div 4096</tt> block records of 4KiB each followed possibly a block record of <tt>n mod 4096</tt> bytes, if there still are remaining bytes in the segment. The structure of a bulk segment can thus be parsed based only on the segment length.</p></div>
+<div class="section">
+<h2>Data segments<a name="Data_segments"></a></h2>
+<p>A data segment can contain any types of records, may refer to content in other segments, and comes with a segment header that guides the parsing of the segment. The overall structure of a data segment is:</p>
+
+<div class="source">
+<pre>[segment header] [record 1] [record 2] ... [record N] [checksum]
+</pre></div>
+<p>The header and each record is zero-padded to make their size a multiple of four bytes and to align the next record at a four-byte boundary. The last four bytes of a segment contain the Adler-32 checksum of all the preceding bytes.</p>
+<p>The segment header consists of the following fields:</p>
+
+<div class="source">
+<pre>+--------+--------+--------+--------+--------+--------+--------+--------+
+| magic bytes: "0aK\n" in ASCII |version |idcount |rootcount |
++--------+--------+--------+--------+--------+--------+--------+--------+
+| nanosecond timestamp/counter (8 bytes) |
++--------+--------+--------+--------+--------+--------+--------+--------+
+| Referenced segment identifiers (idcount x 16 bytes) |
+| |
+| ...... |
+| |
++--------+--------+--------+--------+--------+--------+--------+--------+
+| Root record references (rootcount x 3 bytes) |
+| |
+| ...... +--------+--------+--------+
+| |
++--------+--------+--------+--------+--------+
+</pre></div>
+<p>The first four bytes of a segment always contain the ASCII string “0aK\n”, which is intended to make the binary segment data format easily detectable. The next byte indicates the version of segment format, and is set to zero for all segments that follow the format described here.</p>
+<p>The <tt>idcount</tt> byte indicates how many other segments are referenced by records within this segment. The identifiers of those segments are listed starting at offset 16 of the segment header. This lookup table of up to 255 segment identifiers is used to optimize garbage collection and to avoid having to repeat the 16-byte UUIDs whenever references to records in other segments are made.</p>
+<p>The 16-bit <tt>rootcount</tt> field indicates the number of root record references that follow after the segment identifier lookup table. The root record references are a debugging and recovery aid, that are not needed during normal operation. They identify the types and locations of those records within this segment that are not accessible by following references in other records within this segment. These root references give enough context for parsing all records within a segment without any external information.</p>
<h1>Journals</h1>
<p>Journals are special, atomically updated documents that record the state of the repository as a sequence of references to successive root node records.</p>
<p>A small system could consist of just a single journal and would serialize all repository updates through atomic updates of that journal. A larger system that needs more write throughput can have more journals, linked to each other in a tree hierarchy. Commits to journals in lower levels of the tree can proceed concurrently, but will need to be periodically merged back to the root journal. Potential conflicts and resulting data loss or inconsistency caused by such merges can be avoided by always committing against the root journal.</p>
@@ -384,7 +419,7 @@
<p>The root node references stored in journals are used as the starting point for garbage collection. It is assumed that all content currently visible to clients must be accessible through at least one of the journals. If a client wants to keep a reference to some old content revision that’s no longer referenced by one of the main journals, it should create an empty private branch based on that revision and keep refreshing the branch until that content is no longer needed.</p>
<h1>Records</h1>
<p>The content inside a segment is divided in records of different types: blocks, lists, maps, values, templates and nodes. These record types and their internal structures are described in subsections below.</p>
-<p>Each record is uniquely addressable by its location within the segment and the UUID of that segment. A single segment can contain up to 256kB of data and and references to up to 256 segments (including itself). Since all records are aligned at four-byte boundaries, 16 bits are needed to address all possible record locations within a segment. Thus only three bytes are needed to store a reference to any record in any segment (1 byte to identify the segment, 2 bytes for the record offset).</p>
+<p>Each record is uniquely addressable by its location within the segment and the UUID of that segment. A single segment can contain up to 256kB of data and and references to up to 256 segments (including itself). Since all records are aligned at four-byte boundaries, 16 bits are needed to address all possible record locations within a segment. Thus only three bytes are needed to store a reference to any record in any segment (1 byte to identify the segment, 2 bytes for the record offset).</p></div>
<div class="section">
<h2>Block records<a name="Block_records"></a></h2>
<p>Blocks are binary records of up to 4kB. They’re used as building blocks of large binary (or string) values and stored as-is with no extra metadata or structure. Blocks are the only record type that can’t contain references to other records. Block records are typically stored in <i>bulk segments</i> that consist only of block records and are thus easily identifiable as containing zero references to other segments.</p></div>
Modified: jackrabbit/site/live/oak/docs/use_getting_started.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/use_getting_started.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/use_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/use_getting_started.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/when_things_go_wrong.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/when_things_go_wrong.html?rev=1572196&r1=1572195&r2=1572196&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/when_things_go_wrong.html (original)
+++ jackrabbit/site/live/oak/docs/when_things_go_wrong.html Wed Feb 26 18:55:55 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-02-18
+ | Generated by Apache Maven Doxia at 2014-02-26
| Rendered using Apache Maven Fluido Skin 1.3.0
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20140218" />
+ <meta name="Date-Revision-yyyymmdd" content="20140226" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,7 +154,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-02-18</li>
+ <li id="publishDate">Last Published: 2014-02-26</li>
<li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>