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 2018/08/21 10:31:38 UTC
svn commit: r1838538 [2/35] - in /jackrabbit/site/live/oak/docs: ./
architecture/ coldstandby/ features/ nodestore/ nodestore/document/
nodestore/segment/ oak-mongo-js/ oak-mongo-js/fonts/ oak-mongo-js/scripts/
oak-mongo-js/scripts/prettify/ oak-mongo-...
Modified: jackrabbit/site/live/oak/docs/command_line.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/command_line.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/command_line.html (original)
+++ jackrabbit/site/live/oak/docs/command_line.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Command Line Tools</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,8 +240,7 @@
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">
+ --><div class="section">
<h2><a name="Command_Line_Tools"></a>Command Line Tools</h2>
<div class="section">
<h3><a name="Oak_Run"></a>Oak Run</h3>
@@ -256,31 +252,25 @@
<h4><a name="Backup"></a>Backup</h4>
<p>To back up a repository, use:</p>
-<div>
-<div>
-<pre class="source">java -mx4g -jar oak-run-*.jar backup <repository> <backup>
+<div class="source">
+<div class="source"><pre class="prettyprint">java -mx4g -jar oak-run-*.jar backup <repository> <backup>
</pre></div></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>
+<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><a name="Checkpoint"></a>Checkpoint</h4>
<p>To list the checkpoints of a repository, use:</p>
-<div>
-<div>
-<pre class="source">java -mx4g -jar oak-run-*.jar checkpoints <repository>
+<div class="source">
+<div class="source"><pre class="prettyprint">java -mx4g -jar oak-run-*.jar checkpoints <repository>
</pre></div></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>
+<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><a name="Compaction"></a>Compaction</h4>
<p>The oak-run compact operation may be used to perform an offline compaction:</p>
-<div>
-<div>
-<pre class="source">java -mx4g -jar oak-run-*.jar compact <repository>
+<div class="source">
+<div class="source"><pre class="prettyprint">java -mx4g -jar oak-run-*.jar compact <repository>
</pre></div></div>
-
<p>It makes sense to find and remove the old checkpoints, using the <tt>checkpoints</tt> command described above.</p></div>
<div class="section">
<h4><a name="Index_Management"></a>Index Management</h4>
@@ -288,39 +278,37 @@
<div class="section">
<h4><a name="System_properties_supported_by_the_oak-run"></a>System properties supported by the oak-run</h4>
<p>When performing operations on the SegmentNodeStore (eg. backup, checkpoints, compact), it’s possible to tweak various system properties to get the optimal performance. These are:</p>
-<ul>
+<ul>
+
<li><tt>cache</tt> - cache size for the SegmentNodeStore (default: <tt>256</tt>),</li>
+
<li><tt>compaction-progress-log</tt> - how many entries should be compacted between log messages (default: <tt>150000</tt>),</li>
+
<li><tt>update.limit</tt> - threshold for the flush of a temporary transaction to disk (default: <tt>10000</tt>),</li>
+
<li><tt>tar.memoryMapped</tt> - allow to use memory mapped files to reduce memory usage (default: <tt>false</tt>),</li>
</ul>
<p>Example:</p>
-<div>
-<div>
-<pre class="source">java -Dtar.memoryMapped=true -mx4g -jar oak-run-*.jar checkpoints <repository>
-</pre></div></div>
-</div>
+<div class="source">
+<div class="source"><pre class="prettyprint">java -Dtar.memoryMapped=true -mx4g -jar oak-run-*.jar checkpoints <repository>
+</pre></div></div></div>
<div class="section">
<h4><a name="Analyzing_Thread_Dumps"></a>Analyzing Thread Dumps</h4>
<p>To analyze thread dumps, filter out idle threads, and get profiling data, use the following, there the directory contains thread dump files:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-run-*.jar threaddump --filter --profile <directory>
-</pre></div></div>
-</div></div>
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-run-*.jar threaddump --filter --profile <directory>
+</pre></div></div></div></div>
<div class="section">
<h3><a name="MongoDB_Shell_with_oak-mongo.js"></a>MongoDB Shell with oak-mongo.js</h3>
<p>MongoDB comes with a command line shell that can be extended with custom JavaScript. Oak provides a oak-mongo.js file with MongoMK specific extensions. You first need to download the JavaScript file and then start the MongoDB shell with the file.</p>
-<div>
-<div>
-<pre class="source">wget https://s.apache.org/oak-mongo.js
+<div class="source">
+<div class="source"><pre class="prettyprint">wget https://s.apache.org/oak-mongo.js
mongo --shell oak-mongo.js
</pre></div></div>
-
<p>Now the MongoDB shell has an <tt>oak</tt> namespace with <a href="oak-mongo-js/oak.html">additional functions</a>.</p></div></div>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/constraints.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/constraints.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/constraints.html (original)
+++ jackrabbit/site/live/oak/docs/constraints.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Constraints</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,26 +240,31 @@
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>Constraints</h1>
+ --><h1>Constraints</h1>
<div class="section">
<h2><a name="Item_Names"></a>Item Names</h2>
<p>The JCR specification already restricts what can go into the “local” part of an item name - see <a class="externalLink" href="https://docs.adobe.com/docs/en/spec/jcr/2.0/3_Repository_Model.html#3.2%20Names">JCR v2.0 Specification, Section 3.2</a>. In particular:</p>
-<ul>
-<li>Characters not allowed in XML are forbidden in names as well; this affects most control characters plus unpaired surrogates; see <a class="externalLink" href="https://www.w3.org/TR/xml/#NT-Char">Extensible Markup Language (XML) 1.0 (Fifth Edition), Section 2.2</a>.</li>
+<ul>
+
+<li>Characters not allowed in XML are forbidden in names as well; this affects most control characters plus unpaired surrogates; see <a class="externalLink" href="https://www.w3.org/TR/xml/#NT-Char">Extensible Markup Language (XML) 1.0 (Fifth Edition), Section 2.2</a>.</li>
+
<li>Furthermore, the names <tt>.</tt> and <tt>..</tt> can not be used.</li>
-<li>Finally, the characters <tt>/</tt>, <tt>:</tt>, <tt>[</tt>, <tt>]</tt>, <tt>|</tt>, and <tt>*</tt> are forbidden. For these, the <a class="externalLink" href="https://docs.adobe.com/docs/en/spec/jcr/2.0/3_Repository_Model.html#3.2.5.4%20Exposing%20Non-JCR%20Names">JCR v2.0 Specification, Section 3.2.5.4</a> proposes a mapping to “private-use” code points.</li>
+
+<li>Finally, the characters <tt>/</tt>, <tt>:</tt>, <tt>[</tt>, <tt>]</tt>, <tt>|</tt>, and <tt>*</tt> are forbidden. For these, the <a class="externalLink" href="https://docs.adobe.com/docs/en/spec/jcr/2.0/3_Repository_Model.html#3.2.5.4%20Exposing%20Non-JCR%20Names">JCR v2.0 Specification, Section 3.2.5.4</a> proposes a mapping to “private-use” code points.</li>
</ul>
<p>On top of that, Oak implements several <i>additional</i> restrictions (as per <a class="externalLink" href="https://docs.adobe.com/content/docs/en/spec/jcr/2.0/3_Repository_Model.html#3.2.4%20Naming%20Restrictions">JCR v2.0 Specification, Section 3.2.4</a>):</p>
-<ul>
+<ul>
+
<li>The space character (U+0020) is disallowed at the beginning and the end of a (local) name (see <a class="externalLink" href="https://docs.adobe.com/content/docs/en/spec/jcr/2.0/5_Reading.html#5.2.2.1%20Name%20Patterns">JCR v2.0 Specification, Section 5.2.2.1</a> for motivation).</li>
+
<li>Other ASCII whitespace characters (CR, LF, TAB) are always disallowed (before OAK 1.10, more were disallowed, see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-4857">OAK-4857</a>).</li>
</ul>
<p>Finally, the chosen persistence implementation might restrict node names even further, for instance:</p>
-<ul>
+<ul>
+
<li>in the “Document NodeStore”, the UTF-8 representation of local names can not exceed ~150 bytes.</li>
</ul></div>
<div class="section">
Modified: jackrabbit/site/live/oak/docs/construct.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/construct.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/construct.html (original)
+++ jackrabbit/site/live/oak/docs/construct.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Repository Construction</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,40 +240,32 @@
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>Repository Construction</h1>
+ --><h1>Repository Construction</h1>
<p>Oak comes with a simple and flexible mechanism for constructing content repositories for use in embedded deployments and test cases. This article describes this mechanism. Deployments in managed environments like OSGi should use the native construction/configuration mechanism of the environment.</p>
<p>First, we construct a Repository instance. Both the <tt>Oak</tt> and the <tt>Jcr</tt> classes support <tt>with()</tt> methods, so you can easily extend the repository with custom functionality if you like. To construct an in-memory repository, use:</p>
-<div>
-<div>
-<pre class="source"> Repository repo = new Jcr(new Oak()).createRepository();
+<div class="source">
+<div class="source"><pre class="prettyprint"> Repository repo = new Jcr(new Oak()).createRepository();
</pre></div></div>
-
<p>To use a tar file based Segment NodeStore backend, use:</p>
-<div>
-<div>
-<pre class="source"> FileStore fs = FileStoreBuilder.fileStoreBuilder(new File("repository")).build();
+<div class="source">
+<div class="source"><pre class="prettyprint"> FileStore fs = FileStoreBuilder.fileStoreBuilder(new File("repository")).build();
SegmentNodeStore ns = SegmentNodeStoreBuilders.builder(fs).build();
Repository repo = new Jcr(new Oak(ns)).createRepository();
</pre></div></div>
-
<p>To use a MongoDB backend, use:</p>
-<div>
-<div>
-<pre class="source"> DB db = new MongoClient("127.0.0.1", 27017).getDB("test2");
+<div class="source">
+<div class="source"><pre class="prettyprint"> DB db = new MongoClient("127.0.0.1", 27017).getDB("test2");
DocumentNodeStore ns = new DocumentMK.Builder().
setMongoDB(db).getNodeStore();
Repository repo = new Jcr(new Oak(ns)).createRepository();
</pre></div></div>
-
<p>To login to the repository and do some work (using the default username/password combination), use:</p>
-<div>
-<div>
-<pre class="source"> Session session = repo.login(
+<div class="source">
+<div class="source"><pre class="prettyprint"> Session session = repo.login(
new SimpleCredentials("admin", "admin".toCharArray()));
Node root = session.getRootNode();
if (root.hasNode("hello")) {
@@ -290,12 +279,10 @@
}
session.save();
</pre></div></div>
-
<p>To logout and close the backend store, use:</p>
-<div>
-<div>
-<pre class="source"> session.logout();
+<div class="source">
+<div class="source"><pre class="prettyprint"> session.logout();
// depending on NodeStore implementation either:
// close FileStore
fs.close();
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=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dev_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/dev_getting_started.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Getting Started</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,119 +240,126 @@
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">
+ --><div class="section">
<h2><a name="Getting_Started"></a>Getting Started</h2>
<p>Many parts of Oak are still under construction, so it may be a bit difficult to find your way around the codebase. The <a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/README.md">README files</a>, this documentation, and the <a class="externalLink" href="http://oak.markmail.org/">Oak mailing list</a> archives are good places to start learning about Oak.</p>
<p>There is also the <a class="externalLink" href="http://wiki.apache.org/jackrabbit/Jackrabbit%203">Jackrabbit 3 wiki page</a>, which is mostly outdated though and should only be consulted for historical research.</p>
<p>To get started developing Oak, checkout the sources from <a class="externalLink" href="https://svn.apache.org/repos/asf/jackrabbit/oak/trunk">svn</a>, or <a class="externalLink" href="https://github.com/apache/jackrabbit-oak">fork them</a> on GitHub. Then build the latest sources with Maven 3 and Java 7 (or higher) like this:</p>
-<div>
-<div>
-<pre class="source">mvn clean install
+<div class="source">
+<div class="source"><pre class="prettyprint">mvn clean install
</pre></div></div>
-
<p>To enable all integration tests, including the JCR TCK, use:</p>
-<div>
-<div>
-<pre class="source">mvn clean install -PintegrationTesting
+<div class="source">
+<div class="source"><pre class="prettyprint">mvn clean install -PintegrationTesting
</pre></div></div>
-
<p>Before committing changes or submitting a patch, please make sure that the above integration testing build passes without errors. If you like, you can enable integration tests by default by setting the <tt>OAK_INTEGRATION_TESTING</tt> environment variable.</p></div>
<div class="section">
<h2><a name="MongoDB_integration"></a>MongoDB integration</h2>
<p>Parts of the Oak build expects a MongoDB instance to be available for testing. By default a MongoDB instance running on localhost is expected, and the relevant tests are simply skipped if such an instance is not found. You can also configure the build to use custom MongoDB settings with the following properties (shown with their default values):</p>
-<div>
-<div>
-<pre class="source">-Dmongo.host=127.0.0.1
+<div class="source">
+<div class="source"><pre class="prettyprint">-Dmongo.host=127.0.0.1
-Dmongo.port=27017
-Dmongo.db=MongoMKDB
-Dmongo.db2=MongoMKDB2
</pre></div></div>
-
<p>Note that the configured test databases will be <i>dropped</i> by the test cases.</p></div>
<div class="section">
<h2><a name="Components"></a>Components</h2>
<p>The build consists of the following components:</p>
-<ul>
-<li>oak-parent - parent POM</li>
-<li>oak-doc - Oak documentation</li>
-<li>oak-commons - shared utility code</li>
+<ul>
+
+<li>oak-parent - parent POM</li>
+
+<li>oak-doc - Oak documentation</li>
+
+<li>oak-commons - shared utility code</li>
+
+<li>
+<p><a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md">oak-api</a> - Oak repository API </p></li>
+
+<li>oak-core - Oak repository implementation</li>
+
+<li>oak-core-spi - Oak repository extensions</li>
+
<li>
-
-<p><a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md">oak-api</a> - Oak repository API</p>
-</li>
-<li>oak-core - Oak repository implementation</li>
-<li>oak-core-spi - Oak repository extensions</li>
+<p>oak-jcr - JCR binding for the Oak repository</p></li>
+
<li>
-
-<p>oak-jcr - JCR binding for the Oak repository</p>
-</li>
-<li>
-
-<p>oak-solr-core - Apache Solr indexing and search</p>
-</li>
+<p>oak-solr-core - Apache Solr indexing and search</p></li>
+
<li>oak-solr-osgi</li>
-<li>oak-lucene - Lucene-based query index</li>
-<li>
-
-<p>oak-auth-external - External authentication support</p>
-</li>
-<li>oak-auth-ldap - LDAP implementation of external authentication</li>
+
+<li>oak-lucene - Lucene-based query index</li>
+
+<li>
+<p>oak-auth-external - External authentication support</p></li>
+
+<li>oak-auth-ldap - LDAP implementation of external authentication</li>
+
<li>oak-authorization-cug - Authorization model for closed user groups (CUG)</li>
+
<li>
-
-<p>oak-blob - Oak Blob Store API</p>
-</li>
-<li>oak-blob-plugins - Oak Blob : Extensions and Base Implementations</li>
-<li>oak-blob-cloud - S3 cloud blob store implementation</li>
+<p>oak-blob - Oak Blob Store API</p></li>
+
+<li>oak-blob-plugins - Oak Blob : Extensions and Base Implementations</li>
+
+<li>oak-blob-cloud - S3 cloud blob store implementation</li>
+
<li>oak-blob-cloud-azure - Azure cloud blob store implementation</li>
+
<li>
-
-<p>oak-store-spi - Oak NodeStore and Commit SPI</p>
-</li>
-<li>oak-segment-tar - TarMK API and nodestore implementation</li>
+<p>oak-store-spi - Oak NodeStore and Commit SPI </p></li>
+
+<li>oak-segment-tar - TarMK API and nodestore implementation</li>
+
<li>oak-store-document - Oak DocumentNodeStore implementation on MongoDB and RDB</li>
+
<li>oak-store-composite - CompositeNodeStore implementation</li>
+
<li>
-
-<p>oak-upgrade - tooling for upgrading Jackrabbit repositories to Oak and sidegrading Oak to Oak</p>
-</li>
-<li>
-
-<p>oak-run - runnable jar packaging</p>
-</li>
-<li>oak-run-commons - utilities shared by oak-run and oak-benchmarks</li>
+<p>oak-upgrade - tooling for upgrading Jackrabbit repositories to Oak and sidegrading Oak to Oak</p></li>
+
<li>
-
-<p>oak-benchmarks - benchmark tests</p>
-</li>
-<li>oak-it - integration tests</li>
-<li>oak-it-osgi - integration tests for OSGi</li>
+<p>oak-run - runnable jar packaging</p></li>
+
+<li>oak-run-commons - utilities shared by oak-run and oak-benchmarks</li>
+
+<li>
+<p>oak-benchmarks - benchmark tests</p></li>
+
+<li>oak-it - integration tests</li>
+
+<li>oak-it-osgi - integration tests for OSGi</li>
+
<li>
-
-<p>oak-http - HTTP binding for Oak</p>
-</li>
+<p>oak-http - HTTP binding for Oak</p></li>
+
<li>oak-pojosr</li>
+
<li>
-
-<p><a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-exercise/README.md">oak-exercise</a> - Oak training material</p>
-</li>
-<li>oak-examples - Oak examples (webapp and standalone)</li>
+<p><a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-exercise/README.md">oak-exercise</a> - Oak training material</p></li>
+
+<li>oak-examples - Oak examples (webapp and standalone)</li>
</ul></div>
<div class="section">
<h2><a name="Archive"></a>Archive</h2>
<p>The following components have been moved to the Jackrabbit Attic:</p>
-<ul>
-<li>oak-mk-api - MicroKernel API (<i>deprecated</i>, OAK-2701)</li>
-<li>oak-mk - MicroKernel implementation (see OAK-2702)</li>
-<li>oak-mk-remote - MicroKernel remoting (see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2693">OAK-2693</a>)</li>
-<li>oak-it/mk - integration tests for MicroKernel</li>
-<li>oak-remote - Oak Remote API (see OAK-7035)</li>
+<ul>
+
+<li>oak-mk-api - MicroKernel API (<i>deprecated</i>, OAK-2701)</li>
+
+<li>oak-mk - MicroKernel implementation (see OAK-2702)</li>
+
+<li>oak-mk-remote - MicroKernel remoting (see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2693">OAK-2693</a>)</li>
+
+<li>oak-it/mk - integration tests for MicroKernel</li>
+
+<li>oak-remote - Oak Remote API (see OAK-7035)</li>
</ul></div>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/developing-with-git.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/developing-with-git.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/developing-with-git.html (original)
+++ jackrabbit/site/live/oak/docs/developing-with-git.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Developing with Git</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,17 +240,15 @@
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>Developing with Git</h1>
+ --><h1>Developing with Git</h1>
<p>Oak codebase is backed by SVN, not git. The github location is a mirror that could lag hours behind.</p>
<p>Following an example on how to start on a feature named: FEATURE. Where you’ll work and commit against your fork on github and eventually produce a patch to be attached to the jira issue or commit it straight to svn (assuming you have rights).</p>
<div class="section">
<h2><a name="Initialising_the_local_environment"></a>Initialising the local environment</h2>
<p>First of all you need to <a class="externalLink" href="http://github.com/apache/jackrabbit-oak">fork the github repo</a>.</p>
-<div>
-<div>
-<pre class="source"># clone your fork (as origin) into ./jackrabbit-oak
+<div class="source">
+<div class="source"><pre class="prettyprint"># clone your fork (as origin) into ./jackrabbit-oak
git clone https://github.com/YOUR_USER/jackrabbit-oak.git
cd jackrabbit-oak
@@ -273,15 +268,13 @@ git config svn.authorsfile .git/authors.
git svn init --prefix=upstream/ --tags=tags --trunk=trunk \
--branches=branches \
https://svn.apache.org/repos/asf/jackrabbit/oak
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h2><a name="Creating_a_new_feature_branch"></a>Creating a new feature branch</h2>
<p>Now it’s possible to start working on a feature branch like this</p>
-<div>
-<div>
-<pre class="source"># Ensure you're in upstream-trunk
+<div class="source">
+<div class="source"><pre class="prettyprint"># Ensure you're in upstream-trunk
git checkout upstream-trunk
# align with svn
@@ -292,15 +285,13 @@ git checkout -b FEATURE
# push it to your fork
git push --set-upstream origin FEATURE
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h2><a name="Work_on_the_feature_branch"></a>Work on the feature branch</h2>
<p>Now the work can be carried out easily on the feature branch by keeping it regularly aligned with svn and pushing it to the fork</p>
-<div>
-<div>
-<pre class="source"># Merge the latest trunk from svn
+<div class="source">
+<div class="source"><pre class="prettyprint"># Merge the latest trunk from svn
git checkout upstream-trunk
git svn rebase
git checkout FEATURE
@@ -310,15 +301,13 @@ git merge upstream-trunk
# sending the commits to github
git push
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h2><a name="Producing_a_patch_against_trunk"></a>Producing a patch against trunk</h2>
<p>Now the work is completed and you want to attach a patch to the jira issue for commit and/or review</p>
-<div>
-<div>
-<pre class="source">git checkout upstream-trunk
+<div class="source">
+<div class="source"><pre class="prettyprint">git checkout upstream-trunk
git svn rebase
git checkout FEATURE
git merge upstream-trunk
@@ -329,15 +318,13 @@ git push
# producing the patch file
git diff -w -p upstream-trunk > ~/FEATURE.patch
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h2><a name="Committing_to_svn"></a>Committing to svn</h2>
<p>As for the patch, the work is complete and you want to commmit to svn (assuming you have rights)</p>
-<div>
-<div>
-<pre class="source"># getting the latest svn
+<div class="source">
+<div class="source"><pre class="prettyprint"># getting the latest svn
git checkout upstream-trunk
git svn rebase
git checkout FEATURE
@@ -361,12 +348,12 @@ git svn dcommit --username=goofy --no-re
#
# if in EU wait 10 seconds and give a `git svn rebase` to properly
# align your upstream later on.
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h2><a name="References"></a>References</h2>
-<ul>
+<ul>
+
<li><a class="externalLink" href="https://wiki.apache.org/general/GitAtApache">https://wiki.apache.org/general/GitAtApache</a></li>
</ul></div>
</div>
Modified: jackrabbit/site/live/oak/docs/diagnostic-builds.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/diagnostic-builds.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/diagnostic-builds.html (original)
+++ jackrabbit/site/live/oak/docs/diagnostic-builds.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Cutting diagnostic builds</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,8 +240,7 @@
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>Cutting diagnostic builds</h1>
+ --><h1>Cutting diagnostic builds</h1>
<p>The cutting of a diagnostic build, is the process where you want to deliver one or more oak bundles, let’s say <tt>oak-core</tt> into a specific environment in order to assess whether it actually solves the issues.</p>
<p>What you are aiming is to eventually produce a bundle in the format of, for example, <tt>oak-core-1.0.22-R2707077</tt>.</p>
<p>Let’s see it through an example.</p>
@@ -253,17 +249,14 @@
<h2><a name="What_version_shall_I_use"></a>What version shall I use?</h2>
<p>Open the svn directory where the 1.0 branch is and issue a</p>
-<div>
-<div>
-<pre class="source">$ svn up
+<div class="source">
+<div class="source"><pre class="prettyprint">$ svn up
$ svn info
</pre></div></div>
-
<p>you will see something like</p>
-<div>
-<div>
-<pre class="source">Working Copy Root Path: /apache/oak-svn-1.0
+<div class="source">
+<div class="source"><pre class="prettyprint">Working Copy Root Path: /apache/oak-svn-1.0
URL: https://svn.apache.org/repos/asf/jackrabbit/oak/branches/1.0
Repository Root: https://svn.apache.org/repos/asf
Repository UUID: 13f79535-47bb-0310-9956-ffa450edef68
@@ -274,46 +267,38 @@ Last Changed Author: chetanm
Last Changed Rev: 1708547
Last Changed Date: 2015-10-14 06:56:40 +0100 (Wed, 14 Oct 2015)
</pre></div></div>
-
<p>what you’re interested is the revision number. In our case: <tt>1708581</tt>.</p>
<p>This means you’ll produce a bundle with a version of <tt>1.0.22-R2708581</tt>.</p>
-<p><b>Note that the produced version is lower then the official release you’re working on. 1.0.22 vs 1.0.23</b></p>
-<p><b>Note to use the ‘-R’ (uppercase) instead of ‘-r’ (lowercase) as it will be lower than ‘-SNAPSHOT’. Doing otherwise will result in troubles when trying to apply a ‘-SNAPSHOT’ version on top of the internal build</b></p>
+<p><b>Note that the produced version is lower then the official release you’re working on. 1.0.22 vs 1.0.23</b></p>
+<p><b>Note to use the ‘-R’ (uppercase) instead of ‘-r’ (lowercase) as it will be lower than ‘-SNAPSHOT’. Doing otherwise will result in troubles when trying to apply a ‘-SNAPSHOT’ version on top of the internal build</b></p>
<p>If you’re in doubt about what versioning and how OSGi or Maven will behave have a look at the <a class="externalLink" href="http://versionatorr.appspot.com/">Versionatorr App</a>. You want your diagnostic build to be <b>always less than</b> the oak version where your fix is going to be released.</p></div>
<div class="section">
<h2><a name="Changing_the_version_in_all_the_poms."></a>Changing the version in all the poms.</h2>
<p>Now that you know you want to produce <tt>1.0.22-R2708581</tt> you have to change all the poms accordingly.</p>
<p>Go into <tt>oak-parent</tt> and issue the following maven command.</p>
-<div>
-<div>
-<pre class="source">oak-parent$ mvn versions:set -DnewVersion=1.0.22-R2708581
+<div class="source">
+<div class="source"><pre class="prettyprint">oak-parent$ mvn versions:set -DnewVersion=1.0.22-R2708581
</pre></div></div>
-
<p>you may encounter the following exception. Simply ignore it. Nothing went wrong.</p>
-<div>
-<div>
-<pre class="source">java.io.FileNotFoundException: /oak-svn-1.0/oak-parent/oak-parent (No such file or directory)
-</pre></div></div>
-</div>
+<div class="source">
+<div class="source"><pre class="prettyprint">java.io.FileNotFoundException: /oak-svn-1.0/oak-parent/oak-parent (No such file or directory)
+</pre></div></div></div>
<div class="section">
<h2><a name="Building_the_release"></a>Building the release</h2>
<p>Now you can build the release as usual</p>
-<div>
-<div>
-<pre class="source">jackrabbit-oak$ mvn clean install
+<div class="source">
+<div class="source"><pre class="prettyprint">jackrabbit-oak$ mvn clean install
</pre></div></div>
-
<p>and you’ll have a full oak build with the version <tt>1.0.22-R2708581</tt>. Go into <tt>oak-core/target</tt> and take the produced jar.</p></div>
<div class="section">
<h2><a name="Re-setting_the_svn_branch"></a>Re-setting the svn branch</h2>
<p>You don’t want to commit the changes back to svn so we reset the branch as the original state</p>
-<div>
-<div>
-<pre class="source">jackrabbit-oak$ mvn versions:revert
+<div class="source">
+<div class="source"><pre class="prettyprint">jackrabbit-oak$ mvn versions:revert
</pre></div></div></div>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/differences.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences.html (original)
+++ jackrabbit/site/live/oak/docs/differences.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-17
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180817" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Backward compatibility</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-17<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,7 +155,6 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
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=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dos_and_donts.html (original)
+++ jackrabbit/site/live/oak/docs/dos_and_donts.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Session refresh behavior</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,8 +240,7 @@
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">
+ --><div class="section">
<h2><a name="Session_refresh_behavior"></a>Session refresh behavior</h2>
<p>Oak is based on the MVCC model where each session starts with a snapshot view of the repository. Concurrent changes from other sessions <i>are not visible</i> to a session until it gets refreshed. A session can be refreshed either explicitly by calling the <tt>refresh()</tt> method or implicitly by direct-to-workspace methods or by the auto-refresh mode. Also observation event delivery causes a session to be refreshed.</p>
<p>By default the auto-refresh mode automatically refreshes all sessions that have been idle for more than one second, and it’s also possible to explicitly set the auto-refresh parameters. A typical approach would be for long-lived admin sessions to set the auto-refresh mode to keep the session always up to date with latest changes from the repository.</p>
@@ -271,7 +267,7 @@
<p>If the file has no need to be referenceable it is recommended to use the node type <tt>oak:Resource</tt> instead and add the mixin type <tt>mix:referenceble</tt> only upon demand (see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-4567">OAK-4567</a>)</p></div>
<div class="section">
<h3><a name="Dont_use_Thread.interrupt"></a>Don’t use Thread.interrupt()</h3>
-<p><tt>Thread.interrupt()</tt> can severely impact or even stop the repository. The reason for this is that Oak internally uses various classes from the <tt>nio</tt> package that implement <tt>InterruptibleChannel</tt>, which are <a class="externalLink" href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/InterruptibleChannel.html">asynchronously closed</a> when receiving an <tt>InterruptedException</tt> while blocked on IO. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2609">OAK-2609</a>.</p></div></div>
+<p><tt>Thread.interrupt()</tt> can severely impact or even stop the repository. The reason for this is that Oak internally uses various classes from the <tt>nio</tt> package that implement <tt>InterruptibleChannel</tt>, which are <a class="externalLink" href="http://docs.oracle.com/javase/7/docs/api/java/nio/channels/InterruptibleChannel.html">asynchronously closed</a> when receiving an <tt>InterruptedException</tt> while blocked on IO. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2609">OAK-2609</a>. </p></div></div>
</div>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/downloads.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/downloads.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/downloads.html (original)
+++ jackrabbit/site/live/oak/docs/downloads.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Downloads</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -157,14 +156,12 @@
<li><a href="architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,9 +240,8 @@
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>Downloads</h1>
-<p>The latest Oak sources are available for checkout from [svn] (<a class="externalLink" href="https://svn.apache.org/repos/asf/jackrabbit/oak/trunk">https://svn.apache.org/repos/asf/jackrabbit/oak/trunk</a>), or you can [fork them] (<a class="externalLink" href="https://github.com/apache/jackrabbit-oak">https://github.com/apache/jackrabbit-oak</a>) on GitHub.</p>
+ --><h1>Downloads</h1>
+<p>The latest Oak sources are available for checkout from <a class="externalLink" href="https://svn.apache.org/repos/asf/jackrabbit/oak/trunk">svn</a>, or you can <a class="externalLink" href="https://github.com/apache/jackrabbit-oak">fork them</a> on GitHub.</p>
<p>See also our <a class="externalLink" href="http://jackrabbit.apache.org/downloads.html">frequent releases</a> on the Jackrabbit download page for slightly more stable versions of the codebase.</p>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/features/atomic-counter.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/features/atomic-counter.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/atomic-counter.html (original)
+++ jackrabbit/site/live/oak/docs/features/atomic-counter.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Atomic Counter</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="../nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="../nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="../nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="../nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,8 +240,7 @@
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">
+ --><div class="section">
<h2><a name="Atomic_Counter"></a>Atomic Counter</h2>
<p><tt>@since 1.3.0 (stand-alone) , 1.3.14 (full cluster support)</tt></p>
<div class="section">
@@ -271,19 +267,16 @@
<div class="section">
<h5><a name="Stand-alone"></a>Stand-alone</h5>
-<div>
-<div>
-<pre class="source">NodeStore store = ... //store instantiation
+<div class="source">
+<div class="source"><pre class="prettyprint">NodeStore store = ... //store instantiation
Jcr jcr = new Jcr(store).withAtomicCounter();
Repository repo = jcr.createContentRepository();
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h5><a name="Clustered"></a>Clustered</h5>
-<div>
-<div>
-<pre class="source">NodeStore store = ... //store instantiation
+<div class="source">
+<div class="source"><pre class="prettyprint">NodeStore store = ... //store instantiation
// DocumentNodeStore implements such aspect therefore it could be
// something like: `(Clusterable) store`. Casting the store into
@@ -301,16 +294,14 @@ Jcr jcr = new Jcr(store)
.withAtomicCounter();
Repository repo = jcr.createContentRepository();
-</pre></div></div>
-</div></div>
+</pre></div></div></div></div>
<div class="section">
<h4><a name="OSGi"></a>OSGi</h4>
<div class="section">
<h5><a name="Stand-alone_and_Clustered"></a>Stand-alone and Clustered</h5>
-<div>
-<div>
-<pre class="source">@Reference(target = "(type=atomicCounter)")
+<div class="source">
+<div class="source"><pre class="prettyprint">@Reference(target = "(type=atomicCounter)")
private EditorProvider atomicCounter;
...
@@ -321,14 +312,12 @@ jcr.with(atomicCounter);
...
</pre></div></div>
-
<p>When running on clustered environment the <tt>EditorProvider</tt> expect to find a service of type <tt>org.apache.jackrabbit.oak.spi.state.Clusterable</tt> and <tt>org.apache.jackrabbit.oak.spi.state.NodeStore</tt>. <tt>DocumentNodeStore</tt> already register itself as <tt>Clusterable</tt>. If one of the two won’t be available it will fall back to synchronous behaviour.</p></div></div></div>
<div class="section">
<h3><a name="Usage"></a>Usage</h3>
-<div>
-<div>
-<pre class="source">Session session = ...
+<div class="source">
+<div class="source"><pre class="prettyprint">Session session = ...
// creating a counter node
Node counter = session.getRootNode().addNode("mycounter");
@@ -353,8 +342,7 @@ session.save();
System.out.println("counter now: " + counter.getProperty("oak:counter").getLong());
session.logout();
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h3><a name="Debug"></a>Debug</h3>
<p>If you’re experiencing any problems with the counter you can start analysing the situation by setting to <tt>DEBUG</tt> log appender <tt>org.apache.jackrabbit.oak.plugins.atomic</tt>.</p>
Modified: jackrabbit/site/live/oak/docs/features/oak-run-nodestore-connection-options.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/features/oak-run-nodestore-connection-options.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/oak-run-nodestore-connection-options.html (original)
+++ jackrabbit/site/live/oak/docs/features/oak-run-nodestore-connection-options.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Oak Run NodeStore Connection</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="../nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="../nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="../nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="../nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -242,22 +239,24 @@
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>Oak Run NodeStore Connection</h1>
+ --><h1>Oak Run NodeStore Connection</h1>
<p><tt>@since Oak 1.7.6</tt></p>
<p>This page provide details around various options supported by some of the oak-run commands to connect to NodeStore repository. By default most of these commands (unless documented) would connect in read only mode.</p>
<p>These options are supported by following command (See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-6210">OAK-6210</a>)</p>
-<ul>
+<ul>
+
<li>console</li>
+
<li>index</li>
+
<li>tika</li>
</ul>
-<p>Depending on your setup you would need to configure the NodeStore and BlobStore in use for commands to work. Some commands may not require the BlobStore details. Check the specific oak-run command help to see if access to BlobStore is required or not.</p>
+<p>Depending on your setup you would need to configure the NodeStore and BlobStore in use for commands to work. Some commands may not require the BlobStore details. Check the specific oak-run command help to see if access to BlobStore is required or not. </p>
<div class="section">
<h2><a name="Read_Write_Mode"></a>Read Write Mode</h2>
<p>By default most commands would connect to NodeStore in read only mode. This ensure that oak-run commands can be safely used with productions setup and does not cause any side effect.</p>
-<p>For some operations read-write access would be required. This can be done by passing <tt>--read-write</tt> option. In read-write mode it should be ensured that Oak version from oak-run is matching with Oak version used by application to create the repository.</p>
+<p>For some operations read-write access would be required. This can be done by passing <tt>--read-write</tt> option. In read-write mode it should be ensured that Oak version from oak-run is matching with Oak version used by application to create the repository. </p>
<p>A newer version of oak-run can read repository created by older version of Oak (as Oak is backward compatible) However if writes are done by newer version of oak-run (which is more recent than Oak version used by repository application) then it may cause issues due to change in storage format.</p></div>
<div class="section">
<h2><a name="NodeStore"></a>NodeStore</h2>
@@ -265,21 +264,17 @@
<h3><a name="SegmentNodeStore"></a>SegmentNodeStore</h3>
<p>To connect to SegmentNodeStore just specify the path to folder used by SegmentNodeStore for storing the repository content</p>
-<div>
-<div>
-<pre class="source">java -jar oak-run <command> /path/to/segmentstore
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-run <command> /path/to/segmentstore
</pre></div></div>
-
<p>If <tt>--read-write</tt> option is enabled then it must be ensured that target repository is not in use. Otherwise oak-run would not be able access the NodeStore.</p></div>
<div class="section">
<h3><a name="DocumentNodeStore_-_Mongo"></a>DocumentNodeStore - Mongo</h3>
<p>To connect to Mongo specify the MongoURI</p>
-<div>
-<div>
-<pre class="source">java -jar oak-run <command> mongodb://server:port
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-run <command> mongodb://server:port
</pre></div></div>
-
<p>It support some other options like cache size, cache distribution etc. Refer to help output via <tt>-h</tt> to see supported options</p></div>
<div class="section">
<h3><a name="DocumentNodeStore_-_RDB"></a>DocumentNodeStore - RDB</h3>
@@ -290,21 +285,17 @@
<h3><a name="FileDataStore"></a>FileDataStore</h3>
<p>Specify the path to directory used by <tt>FileDataStore</tt> via <tt>--fds-path</tt> option</p>
-<div>
-<div>
-<pre class="source">java -jar oak-run <command> /path/to/segmentstore --fds-path=/path/to/fds
-</pre></div></div>
-</div>
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-run <command> /path/to/segmentstore --fds-path=/path/to/fds
+</pre></div></div></div>
<div class="section">
<h3><a name="S3DataStore"></a>S3DataStore</h3>
<p>Specify the path to config file which contains connection details related to S3 bucket to be used via <tt>-s3ds</tt> option</p>
-<div>
-<div>
-<pre class="source">java -jar oak-run <command> /path/to/segmentstore --s3ds=/path/to/S3DataStore.config
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-run <command> /path/to/segmentstore --s3ds=/path/to/S3DataStore.config
</pre></div></div>
-
-<p>The file should be a valid config file as configured S3DataStore in OSGi setup for pid <tt>org.apache.jackrabbit.oak.plugins.blob.datastore.S3DataStore.config</tt>.</p>
+<p>The file should be a valid config file as configured S3DataStore in OSGi setup for pid <tt>org.apache.jackrabbit.oak.plugins.blob.datastore.S3DataStore.config</tt>. </p>
<p>Do change the <tt>path</tt> property to location based on system from where command is being used. If you are running the command on the setup where the Oak application is running then ensure that <tt>path</tt> is set to a different location.</p></div></div>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/features/observation.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/features/observation.html?rev=1838538&r1=1838537&r2=1838538&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/observation.html (original)
+++ jackrabbit/site/live/oak/docs/features/observation.html Tue Aug 21 10:31:37 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-10
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-02-21
| Rendered using Apache Maven Fluido Skin 1.6
-->
<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="20180810" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Observation</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -52,7 +52,6 @@
<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="https://jackrabbit.apache.org/jcr/jcr-api.html" title="Jackrabbit API">Jackrabbit API</a></li>
<li><a href="../oak_api/overview.html" title="Oak API">Oak API</a></li>
</ul>
</li>
@@ -137,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-08-10<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-02-21<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -156,14 +155,12 @@
<li><a href="../architecture/nodestate.html" title="The Node State Model"><span class="none"></span>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"><span class="none"></span>JCR API</a> </li>
- <li><a href="https://jackrabbit.apache.org/jcr/jcr-api.html" class="externalLink" title="Jackrabbit API"><span class="none"></span>Jackrabbit API</a> </li>
<li><a href="../oak_api/overview.html" title="Oak API"><span class="none"></span>Oak API</a> </li>
<li class="nav-header">Features and Plugins</li>
<li><a href="../nodestore/overview.html" title="Node Storage"><span class="icon-chevron-down"></span>Node Storage</a>
<ul class="nav nav-list">
<li><a href="../nodestore/documentmk.html" title="Document NodeStore"><span class="icon-chevron-down"></span>Document NodeStore</a>
<ul class="nav nav-list">
- <li><a href="../nodestore/document/mongo-document-store.html" title="MongoDB DocumentStore"><span class="none"></span>MongoDB DocumentStore</a> </li>
<li><a href="../nodestore/document/node-bundling.html" title="Node Bundling"><span class="none"></span>Node Bundling</a> </li>
<li><a href="../nodestore/document/secondary-store.html" title="Secondary Store"><span class="none"></span>Secondary Store</a> </li>
<li><a href="../nodestore/persistent-cache.html" title="Persistent Cache"><span class="none"></span>Persistent Cache</a> </li>
@@ -243,14 +240,16 @@
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>Observation</h1>
-<p>Jackrabbit Oak as part of JCR implementation provides support for observing content changes via <a class="externalLink" href="https://docs.adobe.com/docs/en/spec/javax.jcr/javadocs/jcr-2.0/javax/jcr/observation/EventListener.html">EventListener</a>. Event listeners are notified asynchronously, and see events after they occur and the transaction is committed. <tt>EventListener</tt> can provide a filtering criteria for the type of events they are interested.</p>
+ --><h1>Observation</h1>
+<p>Jackrabbit Oak as part of JCR implementation provides support for observing content changes via <a class="externalLink" href="https://docs.adobe.com/docs/en/spec/javax.jcr/javadocs/jcr-2.0/javax/jcr/observation/EventListener.html">EventListener</a>. Event listeners are notified asynchronously, and see events after they occur and the transaction is committed. <tt>EventListener</tt> can provide a filtering criteria for the type of events they are interested. </p>
<p>Event processing consume system resources hence its important that <tt>EventListener</tt> can tell Oak precisely which type of event changes they are interested in. The filtering criteria can be specified in following way</p>
-<ul>
+<ul>
+
<li>Via <a class="externalLink" href="https://docs.adobe.com/docs/en/spec/javax.jcr/javadocs/jcr-2.0/javax/jcr/observation/ObservationManager.html">ObservationManager#addEventListener</a> registration call.</li>
+
<li>Via Jackrabbit extension <a class="externalLink" href="https://jackrabbit.apache.org/api/2.14/org/apache/jackrabbit/api/observation/JackrabbitEventFilter.html">JackrabbitEventFilter</a></li>
+
<li>Via Jackrabbit Oak extension <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/jcr/observation/filter/OakEventFilter.html">OakEventFilter</a> (new in Oak 1.6)</li>
</ul>
<div class="section">
@@ -259,9 +258,8 @@
<p><tt>@since Oak 1.6</tt></p>
<p>To make use of new filtering capability use following approach</p>
-<div>
-<div>
-<pre class="source">import org.apache.jackrabbit.api.observation.JackrabbitEvent;
+<div class="source">
+<div class="source"><pre class="prettyprint">import org.apache.jackrabbit.api.observation.JackrabbitEvent;
import org.apache.jackrabbit.api.observation.JackrabbitEventFilter;
import org.apache.jackrabbit.api.observation.JackrabbitObservationManager;
import org.apache.jackrabbit.oak.jcr.observation.filter.FilterFactory;
@@ -286,11 +284,10 @@ oakFilter.withIncludeSubtreeOnRemove();
jrom.addEventListener(listener, oakFilter);
</pre></div></div>
-
<p>Refer to <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/jcr/observation/filter/OakEventFilter.html">OakEventFilter</a> javadocs for more details on what filtering criteria are supported</p></div>
<div class="section">
<h3><a name="Benefits_of_Filter_approach"></a>Benefits of Filter approach</h3>
-<p>In Jackrabbit Oak JCR <tt>EventListener</tt> are implemented as Oak <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/commit/Observer.html">Observer</a> which are backed by an in memory queue. Upon any save call done at JCR layer NodeStore in Oak pushes repository root node in this queue which is later used to compute diff from older root and then generate the JCR Events.</p>
+<p>In Jackrabbit Oak JCR <tt>EventListener</tt> are implemented as Oak <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/commit/Observer.html">Observer</a> which are backed by an in memory queue. Upon any save call done at JCR layer NodeStore in Oak pushes repository root node in this queue which is later used to compute diff from older root and then generate the JCR Events. </p>
<p>For events to work properly it needs to be ensure that this in memory queue does not get filled up. Having a precise filter helps Oak in <i>prefiltering</i> changes before they are added to queue. For e.g. if filter stats that its only interested in changes under ‘/content’ then Oak can check if changes under that path have happened for given change, if not then such a change is not queued.</p></div>
<div class="section">
<h3><a name="Observation_queue_overflow"></a>Observation queue overflow</h3></div></div>