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/10/06 15:35:12 UTC
svn commit: r1629650 [1/9] - in /jackrabbit/site/live/oak/docs: ./
architecture/ coldstandby/ nodestore/ oak_api/ plugins/ security/
security/accesscontrol/ security/authentication/ security/permission/
security/principal/ security/privilege/ security/...
Author: thomasm
Date: Mon Oct 6 13:35:10 2014
New Revision: 1629650
URL: http://svn.apache.org/r1629650
Log:
OAK-936: Site checkin for project Oak Documentation-1.1-SNAPSHOT
Added:
jackrabbit/site/live/oak/docs/.DS_Store (with props)
jackrabbit/site/live/oak/docs/big-picture.png (with props)
jackrabbit/site/live/oak/docs/big-picture.uxf
jackrabbit/site/live/oak/docs/blobstore.html
jackrabbit/site/live/oak/docs/command_line.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/from_here.html
jackrabbit/site/live/oak/docs/microkernel.html
jackrabbit/site/live/oak/docs/nodestate-r1.png (with props)
jackrabbit/site/live/oak/docs/nodestate-r2.png (with props)
jackrabbit/site/live/oak/docs/nodestate.html
jackrabbit/site/live/oak/docs/overview.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/when_things_go_wrong.html
Modified:
jackrabbit/site/live/oak/docs/FAQ.html
jackrabbit/site/live/oak/docs/architecture/nodestate.html
jackrabbit/site/live/oak/docs/architecture/overview.html
jackrabbit/site/live/oak/docs/architecture/transactional-model.html
jackrabbit/site/live/oak/docs/clustering.html
jackrabbit/site/live/oak/docs/coldstandby/coldstandby.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/dos_and_donts.html
jackrabbit/site/live/oak/docs/downloads.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/nodestore/documentmk.html
jackrabbit/site/live/oak/docs/nodestore/overview.html
jackrabbit/site/live/oak/docs/nodestore/segmentmk.html
jackrabbit/site/live/oak/docs/oak_api/error_codes.html
jackrabbit/site/live/oak/docs/oak_api/overview.html
jackrabbit/site/live/oak/docs/osgi_config.html
jackrabbit/site/live/oak/docs/participating.html
jackrabbit/site/live/oak/docs/plugins/blobstore.html
jackrabbit/site/live/oak/docs/query.html
jackrabbit/site/live/oak/docs/security/accesscontrol.html
jackrabbit/site/live/oak/docs/security/accesscontrol/differences.html
jackrabbit/site/live/oak/docs/security/accesscontrol/editing.html
jackrabbit/site/live/oak/docs/security/accesscontrol/restriction.html
jackrabbit/site/live/oak/docs/security/authentication.html
jackrabbit/site/live/oak/docs/security/authentication/differences.html
jackrabbit/site/live/oak/docs/security/authentication/externalloginmodule.html
jackrabbit/site/live/oak/docs/security/authentication/identitymanagement.html
jackrabbit/site/live/oak/docs/security/authentication/ldap.html
jackrabbit/site/live/oak/docs/security/authentication/preauthentication.html
jackrabbit/site/live/oak/docs/security/authentication/tokenmanagement.html
jackrabbit/site/live/oak/docs/security/authentication/usersync.html
jackrabbit/site/live/oak/docs/security/overview.html
jackrabbit/site/live/oak/docs/security/permission.html
jackrabbit/site/live/oak/docs/security/permission/differences.html
jackrabbit/site/live/oak/docs/security/permission/evaluation.html
jackrabbit/site/live/oak/docs/security/principal.html
jackrabbit/site/live/oak/docs/security/principal/differences.html
jackrabbit/site/live/oak/docs/security/privilege.html
jackrabbit/site/live/oak/docs/security/privilege/differences.html
jackrabbit/site/live/oak/docs/security/user.html
jackrabbit/site/live/oak/docs/security/user/authorizableaction.html
jackrabbit/site/live/oak/docs/security/user/differences.html
jackrabbit/site/live/oak/docs/security/user/membership.html
jackrabbit/site/live/oak/docs/security/user/query.html
jackrabbit/site/live/oak/docs/use_getting_started.html
Added: jackrabbit/site/live/oak/docs/.DS_Store
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/.DS_Store?rev=1629650&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jackrabbit/site/live/oak/docs/.DS_Store
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: jackrabbit/site/live/oak/docs/FAQ.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/FAQ.html?rev=1629650&r1=1629649&r2=1629650&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/FAQ.html (original)
+++ jackrabbit/site/live/oak/docs/FAQ.html Mon Oct 6 13:35:10 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-09-24
+ | Generated by Apache Maven Doxia at 2014-10-06
| 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="20140924" />
+ <meta name="Date-Revision-yyyymmdd" content="20141006" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Frequently asked questions</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -67,7 +67,7 @@
<li> <a href="architecture/overview.html" title="Overview">Overview</a>
</li>
- <li> <a href="architecture/nodestate.html" title="The node state model">The node state model</a>
+ <li> <a href="architecture/nodestate.html" title="The Node State Model">The Node State Model</a>
</li>
</ul>
</li>
@@ -109,19 +109,22 @@
<li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
</li>
- <li> <a href="construct.html" title="Repository construction">Repository construction</a>
+ <li> <a href="construct.html" title="Repository Construction">Repository Construction</a>
</li>
<li> <a href="osgi_config.html" title="Configuring Oak">Configuring Oak</a>
</li>
+ <li> <a href="command_line.html" title="Command Line Tools">Command Line Tools</a>
+</li>
+
<li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
</li>
<li> <a href="known_issues.html" title="Known Issues">Known Issues</a>
</li>
- <li> <a href="dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+ <li> <a href="dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a>
</li>
<li> <a href="coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a>
@@ -141,7 +144,7 @@
<li> <a href="participating.html" title="Participating">Participating</a>
</li>
- <li> <a href="apidocs/index.html" title="API docs">API docs</a>
+ <li> <a href="apidocs/index.html" title="API Docs">API Docs</a>
</li>
</ul>
</li>
@@ -182,7 +185,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-09-24</li>
+ <li id="publishDate">Last Published: 2014-10-06</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
@@ -231,9 +234,9 @@
<li>
- <a href="architecture/nodestate.html" title="The node state model">
+ <a href="architecture/nodestate.html" title="The Node State Model">
<i class="none"></i>
- The node state model</a>
+ The Node State Model</a>
</li>
<li class="nav-header">Main APIs</li>
@@ -297,9 +300,9 @@
<li>
- <a href="construct.html" title="Repository construction">
+ <a href="construct.html" title="Repository Construction">
<i class="none"></i>
- Repository construction</a>
+ Repository Construction</a>
</li>
<li>
@@ -311,6 +314,13 @@
<li>
+ <a href="command_line.html" title="Command Line Tools">
+ <i class="none"></i>
+ Command Line Tools</a>
+ </li>
+
+ <li>
+
<a href="differences.html" title="Differences to Jackrabbit 2">
<i class="none"></i>
Differences to Jackrabbit 2</a>
@@ -325,9 +335,9 @@
<li>
- <a href="dos_and_donts.html" title="Dos and don'ts">
+ <a href="dos_and_donts.html" title="Dos and Don'ts">
<i class="none"></i>
- Dos and don'ts</a>
+ Dos and Don'ts</a>
</li>
<li>
@@ -359,9 +369,9 @@
<li>
- <a href="apidocs/index.html" title="API docs">
+ <a href="apidocs/index.html" title="API Docs">
<i class="none"></i>
- API docs</a>
+ API Docs</a>
</li>
<li class="nav-header">Links</li>
Modified: jackrabbit/site/live/oak/docs/architecture/nodestate.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/architecture/nodestate.html?rev=1629650&r1=1629649&r2=1629650&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/architecture/nodestate.html (original)
+++ jackrabbit/site/live/oak/docs/architecture/nodestate.html Mon Oct 6 13:35:10 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-09-24
+ | Generated by Apache Maven Doxia at 2014-10-06
| 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="20140924" />
+ <meta name="Date-Revision-yyyymmdd" content="20141006" />
<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" />
@@ -67,7 +67,7 @@
<li> <a href="../architecture/overview.html" title="Overview">Overview</a>
</li>
- <li> <a href="../architecture/nodestate.html" title="The node state model">The node state model</a>
+ <li> <a href="../architecture/nodestate.html" title="The Node State Model">The Node State Model</a>
</li>
</ul>
</li>
@@ -109,19 +109,22 @@
<li> <a href="../use_getting_started.html" title="Getting Started">Getting Started</a>
</li>
- <li> <a href="../construct.html" title="Repository construction">Repository construction</a>
+ <li> <a href="../construct.html" title="Repository Construction">Repository Construction</a>
</li>
<li> <a href="../osgi_config.html" title="Configuring Oak">Configuring Oak</a>
</li>
+ <li> <a href="../command_line.html" title="Command Line Tools">Command Line Tools</a>
+</li>
+
<li> <a href="../differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
</li>
<li> <a href="../known_issues.html" title="Known Issues">Known Issues</a>
</li>
- <li> <a href="../dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+ <li> <a href="../dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a>
</li>
<li> <a href="../coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a>
@@ -141,7 +144,7 @@
<li> <a href="../participating.html" title="Participating">Participating</a>
</li>
- <li> <a href="../apidocs/index.html" title="API docs">API docs</a>
+ <li> <a href="../apidocs/index.html" title="API Docs">API Docs</a>
</li>
</ul>
</li>
@@ -182,7 +185,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-09-24</li>
+ <li id="publishDate">Last Published: 2014-10-06</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
@@ -231,7 +234,7 @@
<li class="active">
- <a href="#"><i class="none"></i>The node state model</a>
+ <a href="#"><i class="none"></i>The Node State Model</a>
</li>
<li class="nav-header">Main APIs</li>
@@ -295,9 +298,9 @@
<li>
- <a href="../construct.html" title="Repository construction">
+ <a href="../construct.html" title="Repository Construction">
<i class="none"></i>
- Repository construction</a>
+ Repository Construction</a>
</li>
<li>
@@ -309,6 +312,13 @@
<li>
+ <a href="../command_line.html" title="Command Line Tools">
+ <i class="none"></i>
+ Command Line Tools</a>
+ </li>
+
+ <li>
+
<a href="../differences.html" title="Differences to Jackrabbit 2">
<i class="none"></i>
Differences to Jackrabbit 2</a>
@@ -323,9 +333,9 @@
<li>
- <a href="../dos_and_donts.html" title="Dos and don'ts">
+ <a href="../dos_and_donts.html" title="Dos and Don'ts">
<i class="none"></i>
- Dos and don'ts</a>
+ Dos and Don'ts</a>
</li>
<li>
@@ -359,9 +369,9 @@
<li>
- <a href="../apidocs/index.html" title="API docs">
+ <a href="../apidocs/index.html" title="API Docs">
<i class="none"></i>
- API docs</a>
+ API Docs</a>
</li>
<li class="nav-header">Links</li>
Modified: jackrabbit/site/live/oak/docs/architecture/overview.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/architecture/overview.html?rev=1629650&r1=1629649&r2=1629650&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/architecture/overview.html (original)
+++ jackrabbit/site/live/oak/docs/architecture/overview.html Mon Oct 6 13:35:10 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-09-24
+ | Generated by Apache Maven Doxia at 2014-10-06
| 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="20140924" />
+ <meta name="Date-Revision-yyyymmdd" content="20141006" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Oak - The big picture</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -67,7 +67,7 @@
<li> <a href="../architecture/overview.html" title="Overview">Overview</a>
</li>
- <li> <a href="../architecture/nodestate.html" title="The node state model">The node state model</a>
+ <li> <a href="../architecture/nodestate.html" title="The Node State Model">The Node State Model</a>
</li>
</ul>
</li>
@@ -109,19 +109,22 @@
<li> <a href="../use_getting_started.html" title="Getting Started">Getting Started</a>
</li>
- <li> <a href="../construct.html" title="Repository construction">Repository construction</a>
+ <li> <a href="../construct.html" title="Repository Construction">Repository Construction</a>
</li>
<li> <a href="../osgi_config.html" title="Configuring Oak">Configuring Oak</a>
</li>
+ <li> <a href="../command_line.html" title="Command Line Tools">Command Line Tools</a>
+</li>
+
<li> <a href="../differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
</li>
<li> <a href="../known_issues.html" title="Known Issues">Known Issues</a>
</li>
- <li> <a href="../dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+ <li> <a href="../dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a>
</li>
<li> <a href="../coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a>
@@ -141,7 +144,7 @@
<li> <a href="../participating.html" title="Participating">Participating</a>
</li>
- <li> <a href="../apidocs/index.html" title="API docs">API docs</a>
+ <li> <a href="../apidocs/index.html" title="API Docs">API Docs</a>
</li>
</ul>
</li>
@@ -182,7 +185,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-09-24</li>
+ <li id="publishDate">Last Published: 2014-10-06</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
@@ -229,9 +232,9 @@
<li>
- <a href="../architecture/nodestate.html" title="The node state model">
+ <a href="../architecture/nodestate.html" title="The Node State Model">
<i class="none"></i>
- The node state model</a>
+ The Node State Model</a>
</li>
<li class="nav-header">Main APIs</li>
@@ -295,9 +298,9 @@
<li>
- <a href="../construct.html" title="Repository construction">
+ <a href="../construct.html" title="Repository Construction">
<i class="none"></i>
- Repository construction</a>
+ Repository Construction</a>
</li>
<li>
@@ -309,6 +312,13 @@
<li>
+ <a href="../command_line.html" title="Command Line Tools">
+ <i class="none"></i>
+ Command Line Tools</a>
+ </li>
+
+ <li>
+
<a href="../differences.html" title="Differences to Jackrabbit 2">
<i class="none"></i>
Differences to Jackrabbit 2</a>
@@ -323,9 +333,9 @@
<li>
- <a href="../dos_and_donts.html" title="Dos and don'ts">
+ <a href="../dos_and_donts.html" title="Dos and Don'ts">
<i class="none"></i>
- Dos and don'ts</a>
+ Dos and Don'ts</a>
</li>
<li>
@@ -359,9 +369,9 @@
<li>
- <a href="../apidocs/index.html" title="API docs">
+ <a href="../apidocs/index.html" title="API Docs">
<i class="none"></i>
- API docs</a>
+ API Docs</a>
</li>
<li class="nav-header">Links</li>
Modified: jackrabbit/site/live/oak/docs/architecture/transactional-model.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/architecture/transactional-model.html?rev=1629650&r1=1629649&r2=1629650&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/architecture/transactional-model.html (original)
+++ jackrabbit/site/live/oak/docs/architecture/transactional-model.html Mon Oct 6 13:35:10 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-09-24
+ | Generated by Apache Maven Doxia at 2014-10-06
| 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="20140924" />
+ <meta name="Date-Revision-yyyymmdd" content="20141006" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Transactional model of sessions</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -67,7 +67,7 @@
<li> <a href="../architecture/overview.html" title="Overview">Overview</a>
</li>
- <li> <a href="../architecture/nodestate.html" title="The node state model">The node state model</a>
+ <li> <a href="../architecture/nodestate.html" title="The Node State Model">The Node State Model</a>
</li>
</ul>
</li>
@@ -109,19 +109,22 @@
<li> <a href="../use_getting_started.html" title="Getting Started">Getting Started</a>
</li>
- <li> <a href="../construct.html" title="Repository construction">Repository construction</a>
+ <li> <a href="../construct.html" title="Repository Construction">Repository Construction</a>
</li>
<li> <a href="../osgi_config.html" title="Configuring Oak">Configuring Oak</a>
</li>
+ <li> <a href="../command_line.html" title="Command Line Tools">Command Line Tools</a>
+</li>
+
<li> <a href="../differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
</li>
<li> <a href="../known_issues.html" title="Known Issues">Known Issues</a>
</li>
- <li> <a href="../dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+ <li> <a href="../dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a>
</li>
<li> <a href="../coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a>
@@ -141,7 +144,7 @@
<li> <a href="../participating.html" title="Participating">Participating</a>
</li>
- <li> <a href="../apidocs/index.html" title="API docs">API docs</a>
+ <li> <a href="../apidocs/index.html" title="API Docs">API Docs</a>
</li>
</ul>
</li>
@@ -182,7 +185,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-09-24</li>
+ <li id="publishDate">Last Published: 2014-10-06</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
@@ -231,9 +234,9 @@
<li>
- <a href="../architecture/nodestate.html" title="The node state model">
+ <a href="../architecture/nodestate.html" title="The Node State Model">
<i class="none"></i>
- The node state model</a>
+ The Node State Model</a>
</li>
<li class="nav-header">Main APIs</li>
@@ -297,9 +300,9 @@
<li>
- <a href="../construct.html" title="Repository construction">
+ <a href="../construct.html" title="Repository Construction">
<i class="none"></i>
- Repository construction</a>
+ Repository Construction</a>
</li>
<li>
@@ -311,6 +314,13 @@
<li>
+ <a href="../command_line.html" title="Command Line Tools">
+ <i class="none"></i>
+ Command Line Tools</a>
+ </li>
+
+ <li>
+
<a href="../differences.html" title="Differences to Jackrabbit 2">
<i class="none"></i>
Differences to Jackrabbit 2</a>
@@ -325,9 +335,9 @@
<li>
- <a href="../dos_and_donts.html" title="Dos and don'ts">
+ <a href="../dos_and_donts.html" title="Dos and Don'ts">
<i class="none"></i>
- Dos and don'ts</a>
+ Dos and Don'ts</a>
</li>
<li>
@@ -361,9 +371,9 @@
<li>
- <a href="../apidocs/index.html" title="API docs">
+ <a href="../apidocs/index.html" title="API Docs">
<i class="none"></i>
- API docs</a>
+ API Docs</a>
</li>
<li class="nav-header">Links</li>
Added: jackrabbit/site/live/oak/docs/big-picture.png
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/big-picture.png?rev=1629650&view=auto
==============================================================================
Binary file - no diff available.
Propchange: jackrabbit/site/live/oak/docs/big-picture.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: jackrabbit/site/live/oak/docs/big-picture.uxf
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/big-picture.uxf?rev=1629650&view=auto
==============================================================================
--- jackrabbit/site/live/oak/docs/big-picture.uxf (added)
+++ jackrabbit/site/live/oak/docs/big-picture.uxf Mon Oct 6 13:35:10 2014
@@ -0,0 +1,528 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+<diagram program="umlet" version="12.2">
+ <zoom_level>10</zoom_level>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>20</y>
+ <w>610</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>JCR
+bg=green</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>300</y>
+ <w>610</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>Oak API
+bg=green</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>190</y>
+ <w>610</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>JCR Delegate
+--
+SessionDelegate, NodeDelegate, etc.
+- the "business logic" of implementing the JCR API based on the simpler Oak concepts
+bg=yellow</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>80</y>
+ <w>610</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>JCR Impl
+--
+SessionImpl, NodeImpl, etc.
+- namespace mapping
+- perform() mechanism (autorefresh, etc.)
+bg=yellow</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>360</y>
+ <w>610</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>Oak core
+--
+TreeImpl, SecureNodeBuilder, etc.
+- org.apache.jackrabbit.oak.core
+- takes care of access controls, node ordering, etc.
+bg=yellow</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>470</y>
+ <w>610</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>NodeStore
+bg=green</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>650</y>
+ <w>230</w>
+ <h>60</h>
+ </coordinates>
+ <panel_attributes>SegmentMK
+bg=yellow</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>270</x>
+ <y>650</y>
+ <w>230</w>
+ <h>60</h>
+ </coordinates>
+ <panel_attributes>DocumentMK
+bg=yellow</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>430</x>
+ <y>590</y>
+ <w>190</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>MicroKernel interface
+bg=green
+fg=gray</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>550</x>
+ <y>650</y>
+ <w>70</w>
+ <h>60</h>
+ </coordinates>
+ <panel_attributes>"H2" MK
+bg=yellow
+fg=gray</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>430</x>
+ <y>530</y>
+ <w>190</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>KernelNodeStore
+bg=yellow
+fg=gray</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>470</x>
+ <y>750</y>
+ <w>130</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>BlobStore
+--
+blobs contain
+binary data
+bg=green</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>220</x>
+ <y>880</y>
+ <w>190</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>MongoDB
+bg=gray</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>10</x>
+ <y>880</y>
+ <w>190</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>Tar files
+bg=gray</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>430</x>
+ <y>880</y>
+ <w>190</w>
+ <h>30</h>
+ </coordinates>
+ <panel_attributes>RDBMS
+bg=gray</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>280</x>
+ <y>20</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<<-
+</panel_attributes>
+ <additional_attributes>30;30;30;60</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>280</x>
+ <y>130</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<-
+</panel_attributes>
+ <additional_attributes>30;60;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>280</x>
+ <y>240</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;60;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>280</x>
+ <y>300</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<<-
+</panel_attributes>
+ <additional_attributes>30;30;30;60</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>280</x>
+ <y>410</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;60;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>490</x>
+ <y>470</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<<-
+fg=gray</panel_attributes>
+ <additional_attributes>30;30;30;60</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>490</x>
+ <y>530</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<-
+fg=gray</panel_attributes>
+ <additional_attributes>30;60;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>550</x>
+ <y>590</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<<-
+fg=gray</panel_attributes>
+ <additional_attributes>30;30;30;60</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>430</x>
+ <y>590</y>
+ <w>50</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>lt=<<-
+fg=gray</panel_attributes>
+ <additional_attributes>30;30;30;60</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>360</x>
+ <y>470</y>
+ <w>50</w>
+ <h>200</h>
+ </coordinates>
+ <panel_attributes>lt=<<-
+</panel_attributes>
+ <additional_attributes>30;30;30;180</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>90</x>
+ <y>470</y>
+ <w>50</w>
+ <h>200</h>
+ </coordinates>
+ <panel_attributes>lt=<<-
+</panel_attributes>
+ <additional_attributes>30;30;30;180</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>330</x>
+ <y>750</y>
+ <w>130</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>DocumentStore
+--
+documents contain
+tree data (nodes,
+non-binary props)
+bg=green</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>360</x>
+ <y>680</y>
+ <w>50</w>
+ <h>90</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;70;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>460</x>
+ <y>680</y>
+ <w>50</w>
+ <h>90</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;70;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>540</x>
+ <y>680</y>
+ <w>50</w>
+ <h>90</h>
+ </coordinates>
+ <panel_attributes>lt=<-
+fg=gray</panel_attributes>
+ <additional_attributes>30;70;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>50</x>
+ <y>750</y>
+ <w>130</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>SegmentStore
+--
+segments contain
+both tree and
+binary data
+bg=green</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>90</x>
+ <y>680</y>
+ <w>50</w>
+ <h>90</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;70;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Class</type>
+ <coordinates>
+ <x>190</x>
+ <y>750</y>
+ <w>130</w>
+ <h>80</h>
+ </coordinates>
+ <panel_attributes>DataStore
+--
+binary data
+in Jackrabbit 2.x
+data stores
+bg=green</panel_attributes>
+ <additional_attributes/>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>260</x>
+ <y>680</y>
+ <w>50</w>
+ <h>90</h>
+ </coordinates>
+ <panel_attributes>lt=<.</panel_attributes>
+ <additional_attributes>30;70;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>190</x>
+ <y>680</y>
+ <w>50</w>
+ <h>90</h>
+ </coordinates>
+ <panel_attributes>lt=<.</panel_attributes>
+ <additional_attributes>30;70;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>360</x>
+ <y>800</y>
+ <w>50</w>
+ <h>100</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;80;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>360</x>
+ <y>800</y>
+ <w>190</w>
+ <h>100</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>170;80;170;50;30;50;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>90</x>
+ <y>800</y>
+ <w>50</w>
+ <h>100</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;80;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>90</x>
+ <y>800</y>
+ <w>170</w>
+ <h>100</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>150;80;150;50;30;50;30;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>360</x>
+ <y>800</y>
+ <w>190</w>
+ <h>100</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;80;30;50;170;50;170;30</additional_attributes>
+ </element>
+ <element>
+ <type>com.umlet.element.Relation</type>
+ <coordinates>
+ <x>500</x>
+ <y>800</y>
+ <w>50</w>
+ <h>100</h>
+ </coordinates>
+ <panel_attributes>lt=<-</panel_attributes>
+ <additional_attributes>30;80;30;30</additional_attributes>
+ </element>
+</diagram>
Added: jackrabbit/site/live/oak/docs/blobstore.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/blobstore.html?rev=1629650&view=auto
==============================================================================
--- jackrabbit/site/live/oak/docs/blobstore.html (added)
+++ jackrabbit/site/live/oak/docs/blobstore.html Mon Oct 6 13:35:10 2014
@@ -0,0 +1,430 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-04-15
+ | 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="20140415" />
+ <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" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit-oak">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="index.html" title="Jackrabbit Oak">Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="license.html" title="License">License</a>
+</li>
+
+ <li> <a href="downloads.html" title="Downloads">Downloads</a>
+</li>
+
+ <li> <a href="from_here.html" title="From here">From here</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="nodestate.html" title="The node state model">The node state model</a>
+</li>
+
+ <li> <a href="microkernel.html" title="NodesStore and MicroKernel">NodesStore and MicroKernel</a>
+</li>
+
+ <li> <a href="query.html" title="Query">Query</a>
+</li>
+
+ <li> <a href="blobstore.html" title="BlobStore">BlobStore</a>
+</li>
+
+ <li> <a href="security/overview.html" title="Security">Security</a>
+</li>
+
+ <li> <a href="clustering.html" title="Clustering">Clustering</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+
+ <li> <a href="osgi_config.html" title="Configuring Oak">Configuring Oak</a>
+</li>
+
+ <li> <a href="known_issues.html" title="Known Issues">Known Issues</a>
+</li>
+
+ <li> <a href="dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+</li>
+
+ <li> <a href="when_things_go_wrong.html" title="When things go wrong">When things go wrong</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="dev_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="participating.html" title="Participating">Participating</a>
+</li>
+
+ <li> <a href="apidocs/index.html" title="API docs">API docs</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://jackrabbit.apache.org/oak" title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Oak Documentation</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2014-04-15</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.20-SNAPSHOT</li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+
+ <li>
+
+ <a href="index.html" title="Jackrabbit Oak">
+ <i class="none"></i>
+ Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="license.html" title="License">
+ <i class="none"></i>
+ License</a>
+ </li>
+
+ <li>
+
+ <a href="downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+
+ <li>
+
+ <a href="from_here.html" title="From here">
+ <i class="none"></i>
+ From here</a>
+ </li>
+ <li class="nav-header">Concepts and architecture</li>
+
+ <li>
+
+ <a href="overview.html" title="Overview">
+ <i class="none"></i>
+ Overview</a>
+ </li>
+
+ <li>
+
+ <a href="nodestate.html" title="The node state model">
+ <i class="none"></i>
+ The node state model</a>
+ </li>
+
+ <li>
+
+ <a href="microkernel.html" title="NodesStore and MicroKernel">
+ <i class="none"></i>
+ NodesStore and MicroKernel</a>
+ </li>
+
+ <li>
+
+ <a href="query.html" title="Query">
+ <i class="none"></i>
+ Query</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>BlobStore</a>
+ </li>
+
+ <li>
+
+ <a href="security/overview.html" title="Security">
+ <i class="none"></i>
+ Security</a>
+ </li>
+
+ <li>
+
+ <a href="clustering.html" title="Clustering">
+ <i class="none"></i>
+ Clustering</a>
+ </li>
+ <li class="nav-header">Using Oak</li>
+
+ <li>
+
+ <a href="use_getting_started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="differences.html" title="Differences to Jackrabbit 2">
+ <i class="none"></i>
+ Differences to Jackrabbit 2</a>
+ </li>
+
+ <li>
+
+ <a href="osgi_config.html" title="Configuring Oak">
+ <i class="none"></i>
+ Configuring Oak</a>
+ </li>
+
+ <li>
+
+ <a href="known_issues.html" title="Known Issues">
+ <i class="none"></i>
+ Known Issues</a>
+ </li>
+
+ <li>
+
+ <a href="dos_and_donts.html" title="Dos and don'ts">
+ <i class="none"></i>
+ Dos and don'ts</a>
+ </li>
+
+ <li>
+
+ <a href="when_things_go_wrong.html" title="When things go wrong">
+ <i class="none"></i>
+ When things go wrong</a>
+ </li>
+ <li class="nav-header">Developing Oak</li>
+
+ <li>
+
+ <a href="dev_getting_started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="participating.html" title="Participating">
+ <i class="none"></i>
+ Participating</a>
+ </li>
+
+ <li>
+
+ <a href="apidocs/index.html" title="API docs">
+ <i class="none"></i>
+ API docs</a>
+ </li>
+ <li class="nav-header">Links</li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
+ <i class="none"></i>
+ Apache Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
+ <i class="none"></i>
+ Apache Jackrabbit</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-doc/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. --><div class="section">
+<h2>The Blob Store<a name="The_Blob_Store"></a></h2>
+<p>The Oak BlobStore is similar to the Jackrabbit 2.x DataStore. However, there are a few minor problems the BlobStore tries to address. Because, for the Jackrabbit DataStore:</p>
+
+<ul>
+
+<li>
+<p>a temporary file is created when adding a large binary, even if the binary already exists</p></li>
+
+<li>
+<p>sharding is slow and complicated because the hash needs to be calculated first, before the binary is stored in the target shard (the FileDataStore still doesn’t support sharding the directory currently)</p></li>
+
+<li>
+<p>file handles are kept open until the consumer is done reading, which complicates the code, and we could potentially get “too many open files” when the consumer doesn’t close the stream</p></li>
+
+<li>
+<p>for database based data stores, there is a similar (even worse) problem that streams are kept open, which means we need to use connection pooling, and if the user doesn’t close the stream we could run out of connections</p></li>
+
+<li>
+<p>for database based data stores, for some databases (MySQL), binaries are fully read in memory, which results in out-of-memory</p></li>
+
+<li>
+<p>binaries that are similar are always stored separately no matter what</p></li>
+</ul>
+<p>Those problems are solved in Oak BlobStores, because binaries are split into blocks of 2 MB. This is similar to how DropBox works internally: <a class="externalLink" href="http://serverfault.com/questions/52861/how-does-dropbox-version-upload-large-files">http://serverfault.com/questions/52861/how-does-dropbox-version-upload-large-files</a> - blocks are processed in memory so that temp files are never needed, and blocks are cached. File handles don’t need to be kept open. Sharding is trivial because each block is processed separately.</p>
+<p>Binaries that are similar: in the BlobStore, currently, they are stored separately except if some of the 2 MB blocks match. However, the algorithm in the BlobStore would allow to re-use all matching parts, because in the BlobStore, concatenating blob ids means concatenating the data.</p>
+<p>Another change was that most DataStore implementations use SHA-1, while the BlobStore uses SHA-256. Using SHA-256 will be a requirement at some point, see also <a class="externalLink" href="http://en.wikipedia.org/wiki/SHA-2">http://en.wikipedia.org/wiki/SHA-2</a> “Federal agencies … must use the SHA-2 family of hash functions for these applications after 2010”. This might affect some potential users.</p></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2012-2014
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file
Modified: jackrabbit/site/live/oak/docs/clustering.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/clustering.html?rev=1629650&r1=1629649&r2=1629650&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/clustering.html (original)
+++ jackrabbit/site/live/oak/docs/clustering.html Mon Oct 6 13:35:10 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-09-24
+ | Generated by Apache Maven Doxia at 2014-10-06
| 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="20140924" />
+ <meta name="Date-Revision-yyyymmdd" content="20141006" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Clustering</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -67,7 +67,7 @@
<li> <a href="architecture/overview.html" title="Overview">Overview</a>
</li>
- <li> <a href="architecture/nodestate.html" title="The node state model">The node state model</a>
+ <li> <a href="architecture/nodestate.html" title="The Node State Model">The Node State Model</a>
</li>
</ul>
</li>
@@ -109,19 +109,22 @@
<li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
</li>
- <li> <a href="construct.html" title="Repository construction">Repository construction</a>
+ <li> <a href="construct.html" title="Repository Construction">Repository Construction</a>
</li>
<li> <a href="osgi_config.html" title="Configuring Oak">Configuring Oak</a>
</li>
+ <li> <a href="command_line.html" title="Command Line Tools">Command Line Tools</a>
+</li>
+
<li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
</li>
<li> <a href="known_issues.html" title="Known Issues">Known Issues</a>
</li>
- <li> <a href="dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+ <li> <a href="dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a>
</li>
<li> <a href="coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a>
@@ -141,7 +144,7 @@
<li> <a href="participating.html" title="Participating">Participating</a>
</li>
- <li> <a href="apidocs/index.html" title="API docs">API docs</a>
+ <li> <a href="apidocs/index.html" title="API Docs">API Docs</a>
</li>
</ul>
</li>
@@ -182,7 +185,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-09-24</li>
+ <li id="publishDate">Last Published: 2014-10-06</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
@@ -231,9 +234,9 @@
<li>
- <a href="architecture/nodestate.html" title="The node state model">
+ <a href="architecture/nodestate.html" title="The Node State Model">
<i class="none"></i>
- The node state model</a>
+ The Node State Model</a>
</li>
<li class="nav-header">Main APIs</li>
@@ -295,9 +298,9 @@
<li>
- <a href="construct.html" title="Repository construction">
+ <a href="construct.html" title="Repository Construction">
<i class="none"></i>
- Repository construction</a>
+ Repository Construction</a>
</li>
<li>
@@ -309,6 +312,13 @@
<li>
+ <a href="command_line.html" title="Command Line Tools">
+ <i class="none"></i>
+ Command Line Tools</a>
+ </li>
+
+ <li>
+
<a href="differences.html" title="Differences to Jackrabbit 2">
<i class="none"></i>
Differences to Jackrabbit 2</a>
@@ -323,9 +333,9 @@
<li>
- <a href="dos_and_donts.html" title="Dos and don'ts">
+ <a href="dos_and_donts.html" title="Dos and Don'ts">
<i class="none"></i>
- Dos and don'ts</a>
+ Dos and Don'ts</a>
</li>
<li>
@@ -359,9 +369,9 @@
<li>
- <a href="apidocs/index.html" title="API docs">
+ <a href="apidocs/index.html" title="API Docs">
<i class="none"></i>
- API docs</a>
+ API Docs</a>
</li>
<li class="nav-header">Links</li>
Modified: jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html?rev=1629650&r1=1629649&r2=1629650&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html (original)
+++ jackrabbit/site/live/oak/docs/coldstandby/coldstandby.html Mon Oct 6 13:35:10 2014
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-09-29
+ | Generated by Apache Maven Doxia at 2014-10-06
| 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="20140929" />
+ <meta name="Date-Revision-yyyymmdd" content="20141006" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak - Cold Standby</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" />
@@ -67,7 +67,7 @@
<li> <a href="../architecture/overview.html" title="Overview">Overview</a>
</li>
- <li> <a href="../architecture/nodestate.html" title="The node state model">The node state model</a>
+ <li> <a href="../architecture/nodestate.html" title="The Node State Model">The Node State Model</a>
</li>
</ul>
</li>
@@ -109,19 +109,22 @@
<li> <a href="../use_getting_started.html" title="Getting Started">Getting Started</a>
</li>
- <li> <a href="../construct.html" title="Repository construction">Repository construction</a>
+ <li> <a href="../construct.html" title="Repository Construction">Repository Construction</a>
</li>
<li> <a href="../osgi_config.html" title="Configuring Oak">Configuring Oak</a>
</li>
+ <li> <a href="../command_line.html" title="Command Line Tools">Command Line Tools</a>
+</li>
+
<li> <a href="../differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
</li>
<li> <a href="../known_issues.html" title="Known Issues">Known Issues</a>
</li>
- <li> <a href="../dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+ <li> <a href="../dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a>
</li>
<li> <a href="../coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a>
@@ -141,7 +144,7 @@
<li> <a href="../participating.html" title="Participating">Participating</a>
</li>
- <li> <a href="../apidocs/index.html" title="API docs">API docs</a>
+ <li> <a href="../apidocs/index.html" title="API Docs">API Docs</a>
</li>
</ul>
</li>
@@ -182,7 +185,7 @@
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2014-09-29</li>
+ <li id="publishDate">Last Published: 2014-10-06</li>
<li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
@@ -231,9 +234,9 @@
<li>
- <a href="../architecture/nodestate.html" title="The node state model">
+ <a href="../architecture/nodestate.html" title="The Node State Model">
<i class="none"></i>
- The node state model</a>
+ The Node State Model</a>
</li>
<li class="nav-header">Main APIs</li>
@@ -297,9 +300,9 @@
<li>
- <a href="../construct.html" title="Repository construction">
+ <a href="../construct.html" title="Repository Construction">
<i class="none"></i>
- Repository construction</a>
+ Repository Construction</a>
</li>
<li>
@@ -311,6 +314,13 @@
<li>
+ <a href="../command_line.html" title="Command Line Tools">
+ <i class="none"></i>
+ Command Line Tools</a>
+ </li>
+
+ <li>
+
<a href="../differences.html" title="Differences to Jackrabbit 2">
<i class="none"></i>
Differences to Jackrabbit 2</a>
@@ -325,9 +335,9 @@
<li>
- <a href="../dos_and_donts.html" title="Dos and don'ts">
+ <a href="../dos_and_donts.html" title="Dos and Don'ts">
<i class="none"></i>
- Dos and don'ts</a>
+ Dos and Don'ts</a>
</li>
<li class="active">
@@ -359,9 +369,9 @@
<li>
- <a href="../apidocs/index.html" title="API docs">
+ <a href="../apidocs/index.html" title="API Docs">
<i class="none"></i>
- API docs</a>
+ API Docs</a>
</li>
<li class="nav-header">Links</li>
Added: jackrabbit/site/live/oak/docs/command_line.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/command_line.html?rev=1629650&view=auto
==============================================================================
--- jackrabbit/site/live/oak/docs/command_line.html (added)
+++ jackrabbit/site/live/oak/docs/command_line.html Mon Oct 6 13:35:10 2014
@@ -0,0 +1,484 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-10-06
+ | 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="20141006" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Jackrabbit Oak - Command Line Tools</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit-oak">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="index.html" title="Jackrabbit Oak">Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="license.html" title="License">License</a>
+</li>
+
+ <li> <a href="downloads.html" title="Downloads">Downloads</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and Architecture <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="architecture/overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="architecture/nodestate.html" title="The Node State Model">The Node State Model</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Main APIs <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.day.com/specs/jcr/2.0/index.html" title="JCR API">JCR API</a>
+</li>
+
+ <li> <a href="oak_api/overview.html" title="Oak API">Oak API</a>
+</li>
+
+ <li> <a href="nodestore/overview.html" title="NodeStore and MicroKernel API">NodeStore and MicroKernel API</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Features and Plugins <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="query.html" title="Query">Query</a>
+</li>
+
+ <li> <a href="security/overview.html" title="Security">Security</a>
+</li>
+
+ <li> <a href="plugins/blobstore.html" title="BlobStore">BlobStore</a>
+</li>
+
+ <li> <a href="clustering.html" title="Clustering">Clustering</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="construct.html" title="Repository Construction">Repository Construction</a>
+</li>
+
+ <li> <a href="osgi_config.html" title="Configuring Oak">Configuring Oak</a>
+</li>
+
+ <li> <a href="command_line.html" title="Command Line Tools">Command Line Tools</a>
+</li>
+
+ <li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+
+ <li> <a href="known_issues.html" title="Known Issues">Known Issues</a>
+</li>
+
+ <li> <a href="dos_and_donts.html" title="Dos and Don'ts">Dos and Don'ts</a>
+</li>
+
+ <li> <a href="coldstandby/coldstandby.html" title="Cold Standby">Cold Standby</a>
+</li>
+
+ <li> <a href="FAQ.html" title="FAQ">FAQ</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="dev_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="participating.html" title="Participating">Participating</a>
+</li>
+
+ <li> <a href="apidocs/index.html" title="API Docs">API Docs</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://jackrabbit.apache.org/oak" title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Oak Documentation</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2014-10-06</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 1.1-SNAPSHOT</li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+
+ <li>
+
+ <a href="index.html" title="Jackrabbit Oak">
+ <i class="none"></i>
+ Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="license.html" title="License">
+ <i class="none"></i>
+ License</a>
+ </li>
+
+ <li>
+
+ <a href="downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+ <li class="nav-header">Concepts and Architecture</li>
+
+ <li>
+
+ <a href="architecture/overview.html" title="Overview">
+ <i class="none"></i>
+ Overview</a>
+ </li>
+
+ <li>
+
+ <a href="architecture/nodestate.html" title="The Node State Model">
+ <i class="none"></i>
+ The Node State Model</a>
+ </li>
+ <li class="nav-header">Main APIs</li>
+
+ <li>
+
+ <a href="http://www.day.com/specs/jcr/2.0/index.html" class="externalLink" title="JCR API">
+ <i class="none"></i>
+ JCR API</a>
+ </li>
+
+ <li>
+
+ <a href="oak_api/overview.html" title="Oak API">
+ <i class="none"></i>
+ Oak API</a>
+ </li>
+
+ <li>
+
+ <a href="nodestore/overview.html" title="NodeStore and MicroKernel API">
+ <i class="none"></i>
+ NodeStore and MicroKernel API</a>
+ </li>
+ <li class="nav-header">Features and Plugins</li>
+
+ <li>
+
+ <a href="query.html" title="Query">
+ <i class="none"></i>
+ Query</a>
+ </li>
+
+ <li>
+
+ <a href="security/overview.html" title="Security">
+ <i class="none"></i>
+ Security</a>
+ </li>
+
+ <li>
+
+ <a href="plugins/blobstore.html" title="BlobStore">
+ <i class="none"></i>
+ BlobStore</a>
+ </li>
+
+ <li>
+
+ <a href="clustering.html" title="Clustering">
+ <i class="none"></i>
+ Clustering</a>
+ </li>
+ <li class="nav-header">Using Oak</li>
+
+ <li>
+
+ <a href="use_getting_started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="construct.html" title="Repository Construction">
+ <i class="none"></i>
+ Repository Construction</a>
+ </li>
+
+ <li>
+
+ <a href="osgi_config.html" title="Configuring Oak">
+ <i class="none"></i>
+ Configuring Oak</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>Command Line Tools</a>
+ </li>
+
+ <li>
+
+ <a href="differences.html" title="Differences to Jackrabbit 2">
+ <i class="none"></i>
+ Differences to Jackrabbit 2</a>
+ </li>
+
+ <li>
+
+ <a href="known_issues.html" title="Known Issues">
+ <i class="none"></i>
+ Known Issues</a>
+ </li>
+
+ <li>
+
+ <a href="dos_and_donts.html" title="Dos and Don'ts">
+ <i class="none"></i>
+ Dos and Don'ts</a>
+ </li>
+
+ <li>
+
+ <a href="coldstandby/coldstandby.html" title="Cold Standby">
+ <i class="none"></i>
+ Cold Standby</a>
+ </li>
+
+ <li>
+
+ <a href="FAQ.html" title="FAQ">
+ <i class="none"></i>
+ FAQ</a>
+ </li>
+ <li class="nav-header">Developing Oak</li>
+
+ <li>
+
+ <a href="dev_getting_started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="participating.html" title="Participating">
+ <i class="none"></i>
+ Participating</a>
+ </li>
+
+ <li>
+
+ <a href="apidocs/index.html" title="API Docs">
+ <i class="none"></i>
+ API Docs</a>
+ </li>
+ <li class="nav-header">Links</li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
+ <i class="none"></i>
+ Apache Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
+ <i class="none"></i>
+ Apache Jackrabbit</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak/docs/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. --><div class="section">
+<h2>Command Line Tools<a name="Command_Line_Tools"></a></h2>
+<div class="section">
+<h3>Oak Run<a name="Oak_Run"></a></h3>
+<p>This tool supports maintenance operations such as backup and compaction.</p>
+<div class="section">
+<h4>Backup<a name="Backup"></a></h4>
+<p>To back up a repository, use:</p>
+
+<div class="source">
+<pre>java -mx4g -jar oak-run-*.jar backup <repository> <backup>
+</pre></div>
+<p>When using the (default) Tar storage, the <tt><repository></tt> setting is the path to the directory that contains the segment (data*.tar) files. The <tt><backup></tt> option is the target directory.</p></div>
+<div class="section">
+<h4>Checkpoint<a name="Checkpoint"></a></h4>
+<p>To list the checkpoints of a repository, use:</p>
+
+<div class="source">
+<pre>java -mx4g -jar oak-run-*.jar checkpoint <repository>
+</pre></div>
+<p>When using the (default) Tar storage, the <tt><repository></tt> setting is the path to the directory that contains the segment (data*.tar) files.</p></div>
+<div class="section">
+<h4>Using Memory Mapped Files<a name="Using_Memory_Mapped_Files"></a></h4>
+<p>When using the Tar storage, some operations, for example backup and checkpoint, allow to use memory mapped files to reduce memory usage. To use this option, set the system property <tt>tar.memoryMapped</tt> to <tt>true</tt>. Example:</p>
+
+<div class="source">
+<pre>java -Dtar.memoryMapped=true -mx4g -jar oak-run-*.jar checkpoint <repository>
+</pre></div></div></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2012-2014
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_thin_badge.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
\ No newline at end of file