You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by th...@apache.org on 2014/01/23 16:06:14 UTC
svn commit: r1560705 - in /jackrabbit/site/live/oak/docs: ./ security/
Author: thomasm
Date: Thu Jan 23 15:06:13 2014
New Revision: 1560705
URL: http://svn.apache.org/r1560705
Log:
OAK-759 MongoMK: read from a secondary member when possible
Modified:
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/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/mongomk.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/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/blobstore.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/blobstore.html?rev=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/blobstore.html (original)
+++ jackrabbit/site/live/oak/docs/blobstore.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/construct.html (original)
+++ jackrabbit/site/live/oak/docs/construct.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dev_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/dev_getting_started.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences.html (original)
+++ jackrabbit/site/live/oak/docs/differences.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
@@ -456,6 +456,12 @@
<li>Oak uses a MVCC model where a session operates on a snapshot of the repository. It is therefore very difficult to ensure new UUIDs only in case of a conflict. Based on the snapshot view of a session, an existing node with a conflicting UUID may not be visible until commit.</li>
</ul></div>
<div class="section">
+<h2>Identifiers<a name="Identifiers"></a></h2>
+<p>In contrast to Jackrabbit 2.x, only referenceable nodes in Oak have a UUID assigned. With Jackrabbit 2.x the UUID is only visible in content when the node is referenceable and exposes the UUID as a <tt>jcr:uuid</tt> property. But using <tt>Node.getIdentifer()</tt>, it is possible to get the UUID of any node. With Oak this method will only return a UUID when the node is referenceable, otherwise the identifier is the UUID of the nearest referenceable ancestor with the relative path to the node.</p></div>
+<div class="section">
+<h2>Versioning<a name="Versioning"></a></h2>
+<p>Because of the different identifier implementation in Oak, the value of a <tt>jcr:frozenUuid</tt> property on a frozen node will not always be a UUID (see also section about Identifiers). The property reflects the value returned by <tt>Node.getIdentifier()</tt> when a node is copied into the version storage as a frozen node. This also means a node restored from a frozen node will only have a <tt>jcr:uuid</tt> when it is actually referenceable.</p></div>
+<div class="section">
<h2>Security<a name="Security"></a></h2>
<ul>
Modified: jackrabbit/site/live/oak/docs/differences_accesscontrol.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_accesscontrol.html?rev=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_accesscontrol.html (original)
+++ jackrabbit/site/live/oak/docs/differences_accesscontrol.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_authentication.html (original)
+++ jackrabbit/site/live/oak/docs/differences_authentication.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_permission.html (original)
+++ jackrabbit/site/live/oak/docs/differences_permission.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/differences_principal.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences_principal.html?rev=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_principal.html (original)
+++ jackrabbit/site/live/oak/docs/differences_principal.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_privileges.html (original)
+++ jackrabbit/site/live/oak/docs/differences_privileges.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences_user.html (original)
+++ jackrabbit/site/live/oak/docs/differences_user.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dos_and_donts.html (original)
+++ jackrabbit/site/live/oak/docs/dos_and_donts.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/downloads.html (original)
+++ jackrabbit/site/live/oak/docs/downloads.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/from_here.html (original)
+++ jackrabbit/site/live/oak/docs/from_here.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/index.html (original)
+++ jackrabbit/site/live/oak/docs/index.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/jsop-diff.html (original)
+++ jackrabbit/site/live/oak/docs/jsop-diff.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/known_issues.html (original)
+++ jackrabbit/site/live/oak/docs/known_issues.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/license.html (original)
+++ jackrabbit/site/live/oak/docs/license.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/microkernel.html (original)
+++ jackrabbit/site/live/oak/docs/microkernel.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
Modified: jackrabbit/site/live/oak/docs/mongomk.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/mongomk.html?rev=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/mongomk.html (original)
+++ jackrabbit/site/live/oak/docs/mongomk.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Oak MongoMK</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -154,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
@@ -351,6 +351,16 @@
<p>This module contains a <tt>MicroKernel</tt> implementation using MongoDB to persist content.</p>
<div class="section">
<h2>Content Model<a name="Content_Model"></a></h2>
+<p>The repository data is stored in two collections: the <tt>nodes</tt> collection for node data, and the <tt>blobs</tt> collection for binaries. There is a third collection, <tt>clusterNodes</tt>, which contains metadata of all cluster nodes. The data can be viewed using the MongoDB shell:</p>
+
+<div class="source">
+<pre>> show collections
+blobs
+clusterNodes
+nodes
+</pre></div></div>
+<div class="section">
+<h2>Node Content Model<a name="Node_Content_Model"></a></h2>
<p>The <tt>MongoMK</tt> stores each node in a separate MongoDB document and updates to a node are stored by adding new revision/value pairs to the document. This way the previous state of a node is preserved and can still be retrieved by a session looking at a given snapshot (revision) of the repository.</p>
<p>The basic MongoDB document of a node in Oak looks like this:</p>
@@ -570,7 +580,8 @@
<h2>Background Operations<a name="Background_Operations"></a></h2>
<p>Each MongoMK instance connecting to same database in Mongo server performs certain background task.</p>
<div class="section">
-<h3>Renew Cluster Id Lease<a name="Renew_Cluster_Id_Lease"></a></h3></div>
+<h3>Renew Cluster Id Lease<a name="Renew_Cluster_Id_Lease"></a></h3>
+<p>Each cluster node uses a unique cluster node id, which is the last part of the revision id. Each cluster node has a lease on the cluster node id, as described in the section <a href="#Cluster_Node_Metadata">Cluster Node Metadata</a>.</p></div>
<div class="section">
<h3>Background Document Split<a name="Background_Document_Split"></a></h3>
<p>MongoMK periodically checks documents for their size and if necessary splits them up and moves old data to a previous document. This is done in the background by each MongoMK instance for the data it created.</p></div>
@@ -585,6 +596,41 @@
<div class="section">
<h3>Conflict Detection and Handling<a name="Conflict_Detection_and_Handling"></a></h3></div></div>
<div class="section">
+<h2>Cluster Node Metadata<a name="Cluster_Node_Metadata"></a></h2>
+<p>Cluster node metadata is stored in the <tt>clusterNodes</tt> collection. There is one entry for each cluster node that is running, and there are entries for cluster nodes that were ran. Old entries are kept so that if a cluster node is started again, it gets the same cluster node id as before (which is not strictly needed for consistency, but nice for support, if one would want to find out which change originated from which cluster node).</p>
+<p>Each running cluster node updates the lease time of the cluster node id once every minute, to ensure each cluster node uses a different cluster node id.</p>
+
+<div class="source">
+<pre>> db.clusterNodes.find().pretty()
+
+{
+ "_id" : "1",
+ "_modCount" : NumberLong(2),
+ "leaseEnd" : NumberLong("1390465250135"),
+ "instance" : "/Users/test/jackrabbit/oak/trunk/oak-jcr",
+ "machine" : "mac:20c9d043f141",
+ "info" : "...pid: 11483, uuid: 6b6e8e4f-8322-4b19-a2b2-de0c573620b9 ..."
+}
+{
+ "_id" : "2",
+ "_modCount" : NumberLong(2),
+ "leaseEnd" : NumberLong("1390465252206"),
+ "instance" : "/Users/mueller/jackrabbit/oak/trunk/oak-jcr",
+ "machine" : "mac:20c9d043f141",
+ "info" : "...pid: 11483, uuid: 28ada13d-ec9c-4d48-aeb9-cef53aa4bb9e ..."
+}
+</pre></div>
+<p>The <tt>_id</tt> is the cluster node id of the node, which is the last part of the revision id. The <tt>leaseEnd</tt> is updated once per minute by running cluster nodes. It is the number of milliseconds since 1970. The <tt>instance</tt> is the current working directory. The <tt>machine</tt> is the lowest number of the network addresses, or a random uuid if this is not available. The <tt>info</tt> contains the same info as a string, plus additionally the process id and the uuid.</p>
+<div class="section">
+<h3>Changing the Read Preference and Write Concern at Runtime<a name="Changing_the_Read_Preference_and_Write_Concern_at_Runtime"></a></h3>
+<p>The read preference and write concern of all cluster nodes can be changed at runtime without having to restart the instances, by setting the property <tt>readWriteMode</tt> of this collection. All cluster nodes will pick up the change within one minute (when they renew the lease of the cluster node id). This is a string property with the format <tt>'read:<readPreference>, write:<writeConcern>'</tt> (please note the space after the comma, and no spaces before and after the colon). The following shell command will set the read preference to <tt>primary</tt> and the write concern to <tt>majority</tt> for all cluster nodes:</p>
+
+<div class="source">
+<pre>> db.clusterNodes.update({},
+ {$set: {readWriteMode:'read:primary, write:majority'}},
+ {multi: true})
+</pre></div></div></div>
+<div class="section">
<h2>License<a name="License"></a></h2>
<p>(see the top-level <a href="../LICENSE.txt">LICENSE.txt</a> for full license details)</p>
<p>Collective work: Copyright 2013 The Apache Software Foundation.</p>
Modified: jackrabbit/site/live/oak/docs/nodestate.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/nodestate.html?rev=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/nodestate.html (original)
+++ jackrabbit/site/live/oak/docs/nodestate.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/overview.html (original)
+++ jackrabbit/site/live/oak/docs/overview.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/participating.html (original)
+++ jackrabbit/site/live/oak/docs/participating.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/query.html (original)
+++ jackrabbit/site/live/oak/docs/query.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/security/permission_eval.html (original)
+++ jackrabbit/site/live/oak/docs/security/permission_eval.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/segmentmk.html (original)
+++ jackrabbit/site/live/oak/docs/segmentmk.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>
@@ -348,10 +348,34 @@
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. --><h1>SegmentMK design overview</h1>
+<p>The SegmentMK is an Oak storage backend that stores content as various types of <i>records</i> within larger <i>segments</i>. One or more <i>journals</i> are used to track the latest state of the repository.</p>
+<p>The SegmentMK was designed from the ground up based on the following key principles:</p>
+
+<ul>
+
+<li>
+<p>Immutability. Segments are immutable, which makes is easy to cache frequently accessed segments. This also makes it less likely for programming or system errors to cause repository inconsistencies, and simplifies features like backups or master-slave clustering.</p></li>
+
+<li>
+<p>Compactness. The formatting of records is optimized for size to reduce IO costs and to fit as much content in caches as possible. A node stored in SegmentMK typically consumes only a fraction of the size it would as a bundle in Jackrabbit Classic.</p></li>
+
+<li>
+<p>Locality. Segments are written so that related records, like a node and its immediate children, usually end up stored in the same segment. This makes tree traversals very fast and avoids most cache misses for typical clients that access more than one related node per session.</p></li>
+</ul>
+<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 <i>segments</i>. Each segment is identified by a UUID and typically contains a continuous subset of the content tree. Some segments might also be used to store commonly occurring property values or other shared data. Segments range from a few dozens of bytes to up to 256kB in size and are stored as documents in a MongoDB collection.</p>
-<p>Since segments are immutable, it’s easy for a client to keep a local in-memory cache of frequently accessed segments. Since segments also leverage locality of reference, i.e. nearby nodes are often stored in the same segment, it’s common for things like small child nodes to already exist in the cache by the time they get accessed. The intention is to avoid as many network or database roundtrips as possible by using local cache memory as efficiently as possible.</p>
-<p>Content within a 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 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>
+
+<ul>
+
+<li><tt>xxxxxxxx-xxxx-4xxx-Axxx-xxxxxxxxxxxx</tt>: data 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>
<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>
@@ -376,8 +400,20 @@
<p>The result is a hierarchically stored immutable map where each element can be accessed in O(log N) time and the size overhead of updating or inserting list elements is also O(log N).</p></div>
<div class="section">
<h2>Value records<a name="Value_records"></a></h2>
-<p>Value records are byte arrays used for storing all names and values of the content tree. Since item names can be thought of as name values and since all JCR and Oak values can be expressed in binary form, it is easiest to simply use that form for storing all values. The size overhead of such a form for small value types like booleans or dates is amortized by the facts that those types are used only for a minority of values in typical content trees and that repeating copies of a value can be stored just once.</p>
-<p>Small values, up to N kB (exact size TBD, N ~ 32), are stored inline in the record, prefixed by a byte or two to indicate the length of the value. Larger values are split into a list of fixed-size blocks and a possibly smaller tail block, and the value is stored as a list of block references.</p></div>
+<p>Value records are byte arrays used for storing all names and values of the content tree. Since item names can be thought of as name values and since all JCR and Oak values can be expressed in binary form (strings encoded in UTF-8), it is easiest to simply use that form for storing all values. The size overhead of such a form for small value types like booleans or dates is amortized by the facts that those types are used only for a minority of values in typical content trees and that repeating copies of a value can be stored just once.</p>
+<p>There are four types of value records: small, medium, long and external. The small- and medium-sized values are stored in inline form, prepended by one or two bytes that indicate the length of the value. Long values of up to two exabytes (2^61) are stored as a list of block records. Finally an external value record contains the length of the value and a string reference (up to 4kB in length) to some external storage location.</p>
+<p>The type of a value record is encoded in the high-order bits of the first byte of the record. These bit patterns are:</p>
+
+<ul>
+
+<li><tt>0xxxxxxx</tt>: small value, length (0 - 127 bytes) encoded in 7 bits</li>
+
+<li><tt>10xxxxxx</tt>: medium value length (128 - 16511 bytes) encoded in 6 + 8 bits</li>
+
+<li><tt>110xxxxx</tt>: long value, length (up to 2^61 bytes) encoded in 5 + 7*8 bits</li>
+
+<li><tt>1110xxxx</tt>: external value, reference string length encoded in 4 + 8 bits</li>
+</ul></div>
<div class="section">
<h2>Template records<a name="Template_records"></a></h2>
<p>A template record describes the common structure of a family of related nodes. Since the structures of most nodes in a typical content tree fall into a small set of common templates, it makes sense to store such templates separately instead of repeating that information separately for each node. For example, the property names and types as well as child node names of all nt:file nodes are typically the same. The presence of mixins and different subtypes increases the number of different templates, but they’re typically still far fewer than nodes in the repository.</p>
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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/use_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/use_getting_started.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</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=1560705&r1=1560704&r2=1560705&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/when_things_go_wrong.html (original)
+++ jackrabbit/site/live/oak/docs/when_things_go_wrong.html Thu Jan 23 15:06:13 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-01-22
+ | Generated by Apache Maven Doxia at 2014-01-23
| 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="20140122" />
+ <meta name="Date-Revision-yyyymmdd" content="20140123" />
<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,8 +154,8 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-01-22</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.15-SNAPSHOT</li>
+ <li id="publishDate">Last Published: 2014-01-23</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.16-SNAPSHOT</li>