You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by mr...@apache.org on 2018/07/09 08:53:19 UTC
svn commit: r1835390 [2/23] - in /jackrabbit/site/live/oak/docs: ./
architecture/ coldstandby/ features/ nodestore/ nodestore/document/
nodestore/segment/ oak-mongo-js/ oak_api/ plugins/ query/ security/
security/accesscontrol/ security/authentication/...
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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/developing-with-git.html (original)
+++ jackrabbit/site/live/oak/docs/developing-with-git.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<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" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,15 +241,17 @@
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 class="source">
-<div class="source"><pre class="prettyprint"># clone your fork (as origin) into ./jackrabbit-oak
+<div>
+<div>
+<pre class="source"># clone your fork (as origin) into ./jackrabbit-oak
git clone https://github.com/YOUR_USER/jackrabbit-oak.git
cd jackrabbit-oak
@@ -269,13 +271,15 @@ 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 class="source">
-<div class="source"><pre class="prettyprint"># Ensure you're in upstream-trunk
+<div>
+<div>
+<pre class="source"># Ensure you're in upstream-trunk
git checkout upstream-trunk
# align with svn
@@ -286,13 +290,15 @@ 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 class="source">
-<div class="source"><pre class="prettyprint"># Merge the latest trunk from svn
+<div>
+<div>
+<pre class="source"># Merge the latest trunk from svn
git checkout upstream-trunk
git svn rebase
git checkout FEATURE
@@ -302,13 +308,15 @@ 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 class="source">
-<div class="source"><pre class="prettyprint">git checkout upstream-trunk
+<div>
+<div>
+<pre class="source">git checkout upstream-trunk
git svn rebase
git checkout FEATURE
git merge upstream-trunk
@@ -319,13 +327,15 @@ 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 class="source">
-<div class="source"><pre class="prettyprint"># getting the latest svn
+<div>
+<div>
+<pre class="source"># getting the latest svn
git checkout upstream-trunk
git svn rebase
git checkout FEATURE
@@ -349,12 +359,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>
-
+
<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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/diagnostic-builds.html (original)
+++ jackrabbit/site/live/oak/docs/diagnostic-builds.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<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" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,7 +241,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>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>
@@ -250,14 +251,17 @@
<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 class="source">
-<div class="source"><pre class="prettyprint">$ svn up
+<div>
+<div>
+<pre class="source">$ svn up
$ svn info
</pre></div></div>
+
<p>you will see something like</p>
-<div class="source">
-<div class="source"><pre class="prettyprint">Working Copy Root Path: /apache/oak-svn-1.0
+<div>
+<div>
+<pre class="source">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
@@ -268,38 +272,46 @@ 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 class="source">
-<div class="source"><pre class="prettyprint">oak-parent$ mvn versions:set -DnewVersion=1.0.22-R2708581
+<div>
+<div>
+<pre class="source">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 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>
+<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="section">
<h2><a name="Building_the_release"></a>Building the release</h2>
<p>Now you can build the release as usual</p>
-<div class="source">
-<div class="source"><pre class="prettyprint">jackrabbit-oak$ mvn clean install
+<div>
+<div>
+<pre class="source">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 class="source">
-<div class="source"><pre class="prettyprint">jackrabbit-oak$ mvn versions:revert
+<div>
+<div>
+<pre class="source">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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences.html (original)
+++ jackrabbit/site/live/oak/docs/differences.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<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" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,21 +241,22 @@
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>Backward compatibility</h1>
+ -->
+<h1>Backward compatibility</h1>
<p>Oak implements the JCR API and we expect most applications to work out of the box. However, the Oak code base is very young and not yet on par with Jackrabbit 2. Some of the more obscure parts of JCR are not (yet) implemented. If you encounter a problem running your application on Oak, please cross check against Jackrabbit 2 before reporting an issue against Oak.</p>
<h1>Reporting issues</h1>
-<p>If you encounter a problem where functionality is missing or Oak does not behave as expected please check whether this is a <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">known change in behaviour</a> or a <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">known issue</a>. If in doubt ask on the <a class="externalLink" href="http://oak.markmail.org/">Oak dev list</a>. Otherwise create a <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">new issue</a>.</p>
+<p>If you encounter a problem where functionality is missing or Oak does not behave as expected please check whether this is a <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">known change in behaviour</a> or a <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">known issue</a>. If in doubt ask on the [Oak dev list] (<a class="externalLink" href="http://oak.markmail.org/">http://oak.markmail.org/</a>). Otherwise create a <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">new issue</a>.</p>
<h1>Notable changes</h1>
<p>This section gives a brief overview of the most notable changes in Oak with respect to Jackrabbit 2. These changes are generally caused by overall design decisions carefully considering the benefits versus the potential backward compatibility issues.</p>
<div class="section">
<h2><a name="Session_state_and_refresh_behaviour"></a>Session state and refresh behaviour</h2>
-<p>In Jackrabbit 2 sessions always reflects the latest state of the repository. With Oak a session reflects a stable view of the repository from the time the session was acquired (<a class="externalLink" href="http://en.wikipedia.org/wiki/MVCC">MVCC model</a>). This is a fundamental design aspect for achieving the distributed nature of an Oak repository. A rarely encountered side effect of this is that sessions expose <a href="architecture/transactional-model.html">write skew</a>.</p>
+<p>In Jackrabbit 2 sessions always reflects the latest state of the repository. With Oak a session reflects a stable view of the repository from the time the session was acquired ([MVCC model] (<a class="externalLink" href="http://en.wikipedia.org/wiki/MVCC">http://en.wikipedia.org/wiki/MVCC</a>)). This is a fundamental design aspect for achieving the distributed nature of an Oak repository. A rarely encountered side effect of this is that sessions expose <a href="architecture/transactional-model.html">write skew</a>.</p>
<p>This change can cause subtle differences in behavior when two sessions perform modifications relying on one session seeing the other session’s changes. Oak requires explicit calls to <tt>Session.refresh()</tt>in this case.</p>
-
<blockquote>
+
<p><i>Note</i>: To ease migration to Oak, sessions being idle for more than one minute will log a warning to the log file. Furthermore sessions are automatically synchronised to reflect the same state across accesses within a single thread. That is, an older session will see the changes done through a newer session given both sessions are accessed from within the same thread.</p>
<p>Automatic session synchronisation is a transient feature and will most probably be removed in future versions of Oak. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-803">OAK-803</a> for further details regarding session backwards compatibility and <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-960">OAK-960</a> regarding in thread session synchronisation.</p>
-<p>The <tt>SessionMBean</tt> provides further information on when a session is refreshed and wheter a refresh will happen on the next access. </p>
+<p>The <tt>SessionMBean</tt> provides further information on when a session is refreshed and wheter a refresh will happen on the next access.</p>
</blockquote>
<p>On Oak <tt>Item.refresh()</tt> is deprecated and will always cause an <tt>Session.refresh()</tt>. The former call will result in a warning written to the log in order to facilitate locating trouble spots.</p>
<p>On Oak <tt>Item.save()</tt> is deprecated and will per default log a warning and fall back to <tt>Session.save()</tt>. This behaviour can be tweaked with <tt>-Ditem-save-does-session-save=false</tt> in which case no fall back to <tt>Session#save()</tt> will happen but an <tt>UnsupportedRepositoryException</tt> is thrown if the sub-tree rooted at the respective item does not contain all transient changes. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-993">OAK-993</a> for details.</p></div>
@@ -266,79 +267,79 @@
<p>In Oak, the method <tt>QueryManager.createQuery</tt> does not return an object of type <tt>QueryObjectModel</tt>.</p></div>
<div class="section">
<h2><a name="Observation"></a>Observation</h2>
-
<ul>
-
+
<li>
-<p><tt>Event.getInfo()</tt> contains the primary and mixin node types of the associated parent node of the event. The key <tt>jcr:primaryType</tt> maps to the primary type and the key <tt>jcr:mixinTypes</tt> maps to an array containing the mixin types.</p></li>
-
+
+<p><tt>Event.getInfo()</tt> contains the primary and mixin node types of the associated parent node of the event. The key <tt>jcr:primaryType</tt> maps to the primary type and the key <tt>jcr:mixinTypes</tt> maps to an array containing the mixin types.</p>
+</li>
<li>
-<p><tt>Event.getUserId()</tt>, <tt>Event.getUserData()</tt>and <tt>Event.getDate()</tt> will only be available for locally generated events (i.e. on the same cluster node). To help identifying potential trouble spots, calling any of these methods without a previous call to <tt>JackrabbitEvent#isExternal()</tt> will write a warning to the log file.</p></li>
-
+
+<p><tt>Event.getUserId()</tt>, <tt>Event.getUserData()</tt>and <tt>Event.getDate()</tt> will only be available for locally generated events (i.e. on the same cluster node). To help identifying potential trouble spots, calling any of these methods without a previous call to <tt>JackrabbitEvent#isExternal()</tt> will write a warning to the log file.</p>
+</li>
<li>
-<p>Push notification mechanisms like JCR observation weight heavy on distributed systems. Therefore, if an application requirement is not actually an “eventing problem” consider using different means like query and custom indexes. <a class="externalLink" href="http://sling.apache.org">Apache Sling</a> identified and classified common <a class="externalLink" href="https://cwiki.apache.org/confluence/display/SLING/Observation+usage+patterns">usage patterns</a> of observation and recommendations on alternative solutions where applicable.</p></li>
-
+
+<p>Push notification mechanisms like JCR observation weight heavy on distributed systems. Therefore, if an application requirement is not actually an “eventing problem” consider using different means like query and custom indexes. <a class="externalLink" href="http://sling.apache.org">Apache Sling</a> identified and classified common [usage patterns] (<a class="externalLink" href="https://cwiki.apache.org/confluence/display/SLING/Observation+usage+patterns">https://cwiki.apache.org/confluence/display/SLING/Observation+usage+patterns</a>) of observation and recommendations on alternative solutions where applicable.</p>
+</li>
<li>
-<p>Event generation is done by looking at the difference between two revisions of the persisted content trees. Items not present in a previous revision but present in the current revision are reported as <tt>Event.NODE_ADDED</tt> and <tt>Event.PROPERTY_ADDED</tt>, respectively. Items present in a previous revision but not present in the current revision are reported as <tt>Event.NODE_REMOVED</tt> and <tt>Event.PROPERTY_REMOVED</tt>, respectively. Properties that changed in between the previous revision and the current revision are reported as <tt>PROPERTY_CHANGED</tt>. As a consequence operations that cancelled each others in between the previous revision and the current revision are not reported. Furthermore the order of the events depends on the underlying implementation and is not specified. In particular there are some interesting consequences:</p>
-
-<ul>
-
-<li>Touched properties: Jackrabbit 2 used to generate a <tt>PROPERTY_CHANGED</tt> event when touching a property (i.e. setting a property to its current value). Oak keeps closer to the specification and <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-948">omits such events</a>. More generally removing a subtree and replacing it with the same subtree will not generate any event.</li>
- </ul>
-
-<ul>
-
-<li>Removing a referenceable node and adding it again will result in a <tt>PROPERTY_CHANGED</tt> event for <tt>jcr:uuid</tt>; the same applies for other built-in protected and mandatory properties such as e.g. jcr:versionHistory if the corresponding versionable node was removed and a versionable node with the same name is being created.</li>
- </ul>
-
-<ul>
-
-<li>Limited support for <tt>Event.NODE_MOVED</tt>:</li>
- </ul>
-
-<ul>
-
-<li>A node that is added and subsequently moved will not generate a <tt>Event.NODE_MOVED</tt> but a <tt>Event.NODE_ADDED</tt> for its final location.</li>
- </ul>
-
-<ul>
-
-<li>A node that is moved and subsequently removed will not generate a <tt>Event.NODE_MOVED</tt> but a <tt>Event.NODE_REMOVED</tt> for its initial location.</li>
- </ul>
-
-<ul>
-
-<li>A node that is moved and subsequently moved again will only generate a single <tt>Event.NODE_MOVED</tt> reporting its initial location as <tt>srcAbsPath</tt> and its final location as <tt>destAbsPath</tt>.</li>
- </ul>
-
-<ul>
-
-<li>A node whose parent was moved and that moved itself subsequently reports its initial location as <tt>srcAbsPath</tt> instead of the location it had under the moved parent.</li>
- </ul>
-
-<ul>
-
-<li>A node that was moved and subsequently its parent is moved will report its final location as <tt>destAbsPath</tt> instead of the location it had before its parent moved.</li>
- </ul>
-
-<ul>
-
-<li>Removing a node and adding a node with the same name at the same parent will be reported as <tt>NODE_MOVED</tt> event as if it where caused by <tt>Node.orderBefore()</tt> if the parent node is orderable and the sequence of operations caused a change in the order of the child nodes.</li>
- </ul>
-
+
+<p>Event generation is done by looking at the difference between two revisions of the persisted content trees. Items not present in a previous revision but present in the current revision are reported as <tt>Event.NODE_ADDED</tt> and <tt>Event.PROPERTY_ADDED</tt>, respectively. Items present in a previous revision but not present in the current revision are reported as <tt>Event.NODE_REMOVED</tt> and <tt>Event.PROPERTY_REMOVED</tt>, respectively. Properties that changed in between the previous revision and the current revision are reported as <tt>PROPERTY_CHANGED</tt>. As a consequence operations that cancelled each others in between the previous revision and the current revision are not reported. Furthermore the order of the events depends on the underlying implementation and is not specified. In particular there are some interesting consequences:</p>
<ul>
-
-<li>The exact sequence of <tt>Node.orderBefore()</tt> will not be reflected through <tt>NODE_MOVED</tt> events: given two child nodes <tt>a</tt> and <tt>b</tt>, ordering <tt>a</tt> after <tt>b</tt> may be reported as ordering <tt>b</tt> before <tt>a</tt>.</li>
- </ul></li>
-
+
+<li>
+
+<p>Touched properties: Jackrabbit 2 used to generate a <tt>PROPERTY_CHANGED</tt> event when touching a property (i.e. setting a property to its current value). Oak keeps closer to the specification and <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-948">omits such events</a>. More generally removing a subtree and replacing it with the same subtree will not generate any event.</p>
+</li>
+<li>
+
+<p>Removing a referenceable node and adding it again will result in a <tt>PROPERTY_CHANGED</tt> event for <tt>jcr:uuid</tt>; the same applies for other built-in protected and mandatory properties such as e.g. jcr:versionHistory if the corresponding versionable node was removed and a versionable node with the same name is being created.</p>
+</li>
<li>
-<p>The sequence of differences Oak generates observation events from is guaranteed to contain the before and after states of all cluster local changes. This guarantee does not hold for cluster external changes. That is, cancelling operations from cluster external events might not be reported event though they stem from separate commits (<tt>Session.save()</tt>).</p></li>
-
+
+<p>Limited support for <tt>Event.NODE_MOVED</tt>:</p>
+</li>
<li>
-<p>Unregistering an observation listener blocks for no more than one second. If a pending <tt>onEvent()</tt> call does not complete by then a warning is logged and the listener will be unregistered without further waiting for the pending <tt>onEvent()</tt> call to complete. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1290">OAK-1290</a> and <a class="externalLink" href="https://java.net/jira/browse/JSR_333-74">JSR_333-74</a> for further information.</p></li>
-
+
+<p>A node that is added and subsequently moved will not generate a <tt>Event.NODE_MOVED</tt> but a <tt>Event.NODE_ADDED</tt> for its final location.</p>
+</li>
<li>
-<p>See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1459">OAK-1459</a> introduced some differences in what events are dispatch for bulk operations (moving and deleting sub-trees):</p></li>
+
+<p>A node that is moved and subsequently removed will not generate a <tt>Event.NODE_MOVED</tt> but a <tt>Event.NODE_REMOVED</tt> for its initial location.</p>
+</li>
+<li>
+
+<p>A node that is moved and subsequently moved again will only generate a single <tt>Event.NODE_MOVED</tt> reporting its initial location as <tt>srcAbsPath</tt> and its final location as <tt>destAbsPath</tt>.</p>
+</li>
+<li>
+
+<p>A node whose parent was moved and that moved itself subsequently reports its initial location as <tt>srcAbsPath</tt> instead of the location it had under the moved parent.</p>
+</li>
+<li>
+
+<p>A node that was moved and subsequently its parent is moved will report its final location as <tt>destAbsPath</tt> instead of the location it had before its parent moved.</p>
+</li>
+<li>
+
+<p>Removing a node and adding a node with the same name at the same parent will be reported as <tt>NODE_MOVED</tt> event as if it where caused by <tt>Node.orderBefore()</tt> if the parent node is orderable and the sequence of operations caused a change in the order of the child nodes.</p>
+</li>
+<li>
+
+<p>The exact sequence of <tt>Node.orderBefore()</tt> will not be reflected through <tt>NODE_MOVED</tt> events: given two child nodes <tt>a</tt> and <tt>b</tt>, ordering <tt>a</tt> after <tt>b</tt> may be reported as ordering <tt>b</tt> before <tt>a</tt>.</p>
+</li>
+</ul>
+</li>
+<li>
+
+<p>The sequence of differences Oak generates observation events from is guaranteed to contain the before and after states of all cluster local changes. This guarantee does not hold for cluster external changes. That is, cancelling operations from cluster external events might not be reported event though they stem from separate commits (<tt>Session.save()</tt>).</p>
+</li>
+<li>
+
+<p>Unregistering an observation listener blocks for no more than one second. If a pending <tt>onEvent()</tt> call does not complete by then a warning is logged and the listener will be unregistered without further waiting for the pending <tt>onEvent()</tt> call to complete. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1290">OAK-1290</a> and <a class="externalLink" href="https://java.net/jira/browse/JSR_333-74">JSR_333-74</a> for further information.</p>
+</li>
+<li>
+
+<p>See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1459">OAK-1459</a> introduced some differences in what events are dispatch for bulk operations (moving and deleting sub-trees):</p>
+</li>
</ul>
<table border="0" class="table table-striped">
@@ -380,7 +381,8 @@
<td>NODE_MOVED event, NODE_ADDED event for the root of the sub-tree only,
NODE_REMOVED event for the root of the sub-tree only</td>
</tr>
-</table></div>
+</table>
+</div>
<div class="section">
<h2><a name="Binary_streams"></a>Binary streams</h2>
<p>In Jackrabbit 2 binary values were often (though not always) stored in or spooled into a file in the local file system, and methods like <tt>Value.getStream()</tt> would thus be backed by <tt>FileInputStream</tt> instances. As a result the <tt>available()</tt> method of the stream would typically return the full count of remaining bytes, regardless of whether the next <tt>read()</tt> call would block to wait for disk IO.</p>
@@ -397,11 +399,9 @@
<div class="section">
<h2><a name="XML_Import"></a>XML Import</h2>
<p>The import behavior for <a class="externalLink" href="http://www.day.com/maven/jsr170/javadocs/jcr-2.0/javax/jcr/ImportUUIDBehavior.html#IMPORT_UUID_CREATE_NEW"><tt>IMPORT_UUID_CREATE_NEW</tt></a> in Oak is implemented slightly different compared to Jackrabbit. Jackrabbit 2.x only creates a new UUID when it detects an existing conflicting node with the same UUID. Oak always creates a new UUID, even if there is no conflicting node. The are mainly two reasons why this is done in Oak:</p>
-
<ul>
-
+
<li>The implementation in Oak is closer to what the JCR specification says: <i>Incoming nodes are assigned newly created identifiers upon addition to the workspace. As a result, identifier collisions never occur.</i></li>
-
<li>Oak uses a MVCC model where a session operates on a snapshot of the repository. It is therefore very difficult to ensure new UUIDs only in case of a conflict. Based on the snapshot view of a session, an existing node with a conflicting UUID may not be visible until commit.</li>
</ul></div>
<div class="section">
@@ -413,33 +413,30 @@
<p>JCR namespace support is mostly compatible with Jackrabbit 2.x. However, Oak does not support remapping an existing namespace URI to a different prefix in the namespace registry. Once registered, such a repository wide namespace prefix to namespace URI mapping cannot be changed through the namespace registry anymore. The mapping <i>can</i> be changed on a per session level, but this remapping is only visible to the current session and bound to the session lifetime. See <a class="externalLink" href="https://docs.adobe.com/content/docs/en/spec/jsr170/javadocs/jcr-2.0/javax/jcr/Session.html#setNamespacePrefix(java.lang.String,%20java.lang.String)"><tt>Session.setNamespacePrefix(String, String)</tt></a>.</p></div>
<div class="section">
<h2><a name="Versioning"></a>Versioning</h2>
-
<ul>
-
+
<li>
-<p>Because of the different identifier implementation in Oak, the value of a <tt>jcr:frozenUuid</tt> property on a frozen node will not always be a UUID (see also section about Identifiers). The property reflects the value returned by <tt>Node.getIdentifier()</tt> when a node is copied into the version storage as a frozen node. This also means a node restored from a frozen node will only have a <tt>jcr:uuid</tt> when it is actually referenceable.</p></li>
-
+
+<p>Because of the different identifier implementation in Oak, the value of a <tt>jcr:frozenUuid</tt> property on a frozen node will not always be a UUID (see also section about Identifiers). The property reflects the value returned by <tt>Node.getIdentifier()</tt> when a node is copied into the version storage as a frozen node. This also means a node restored from a frozen node will only have a <tt>jcr:uuid</tt> when it is actually referenceable.</p>
+</li>
<li>
-<p>Oak does currently not implement activities (<tt>OPTION_ACTIVITIES_SUPPORTED</tt>), configurations and baselines (<tt>OPTION_BASELINES_SUPPORTED</tt>).</p></li>
-
+
+<p>Oak does currently not implement activities (<tt>OPTION_ACTIVITIES_SUPPORTED</tt>), configurations and baselines (<tt>OPTION_BASELINES_SUPPORTED</tt>).</p>
+</li>
<li>
-<p>Oak does currently not implement the various variants of <tt>VersionManager.merge</tt> but throws an <tt>UnsupportedRepositoryOperationException</tt> if such a method is called.</p></li>
+
+<p>Oak does currently not implement the various variants of <tt>VersionManager.merge</tt> but throws an <tt>UnsupportedRepositoryOperationException</tt> if such a method is called.</p>
+</li>
</ul></div>
<div class="section">
<h2><a name="Security"></a>Security</h2>
-
<ul>
-
+
<li><a href="security/authentication/differences.html">Authentication</a></li>
-
<li><a href="security/accesscontrol/differences.html">Access Control Management</a></li>
-
<li><a href="security/permission/differences.html">Permission Evaluation</a></li>
-
<li><a href="security/privilege/differences.html">Privilege Management</a></li>
-
<li><a href="security/principal/differences.html">Principal Management</a></li>
-
<li><a href="security/user/differences.html">User Management</a></li>
</ul></div>
<div class="section">
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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dos_and_donts.html (original)
+++ jackrabbit/site/live/oak/docs/dos_and_donts.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<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" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,7 +241,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.
- --><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>
@@ -268,7 +269,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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/downloads.html (original)
+++ jackrabbit/site/live/oak/docs/downloads.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Downloads</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,8 +241,9 @@
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 <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>
+ -->
+<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>
<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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/atomic-counter.html (original)
+++ jackrabbit/site/live/oak/docs/features/atomic-counter.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<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" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,7 +241,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.
- --><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">
@@ -268,16 +269,19 @@
<div class="section">
<h5><a name="Stand-alone"></a>Stand-alone</h5>
-<div class="source">
-<div class="source"><pre class="prettyprint">NodeStore store = ... //store instantiation
+<div>
+<div>
+<pre class="source">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 class="source">
-<div class="source"><pre class="prettyprint">NodeStore store = ... //store instantiation
+<div>
+<div>
+<pre class="source">NodeStore store = ... //store instantiation
// DocumentNodeStore implements such aspect therefore it could be
// something like: `(Clusterable) store`. Casting the store into
@@ -295,14 +299,16 @@ 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 class="source">
-<div class="source"><pre class="prettyprint">@Reference(target = "(type=atomicCounter)")
+<div>
+<div>
+<pre class="source">@Reference(target = "(type=atomicCounter)")
private EditorProvider atomicCounter;
...
@@ -313,12 +319,14 @@ 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 class="source">
-<div class="source"><pre class="prettyprint">Session session = ...
+<div>
+<div>
+<pre class="source">Session session = ...
// creating a counter node
Node counter = session.getRootNode().addNode("mycounter");
@@ -343,7 +351,8 @@ 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=1835390&r1=1835389&r2=1835390&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 Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<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" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -240,24 +240,22 @@
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>
-
+
<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,17 +263,21 @@
<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 class="source">
-<div class="source"><pre class="prettyprint">java -jar oak-run <command> /path/to/segmentstore
+<div>
+<div>
+<pre class="source">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 class="source">
-<div class="source"><pre class="prettyprint">java -jar oak-run <command> mongodb://server:port
+<div>
+<div>
+<pre class="source">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>
@@ -286,17 +288,21 @@
<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 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>
+<div>
+<pre class="source">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 class="source">
-<div class="source"><pre class="prettyprint">java -jar oak-run <command> /path/to/segmentstore --s3ds=/path/to/S3DataStore.config
+<div>
+<div>
+<pre class="source">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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/observation.html (original)
+++ jackrabbit/site/live/oak/docs/features/observation.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Observation</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,16 +241,14 @@
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>
-
+
<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,8 +257,9 @@
<p><tt>@since Oak 1.6</tt></p>
<p>To make use of new filtering capability use following approach</p>
-<div class="source">
-<div class="source"><pre class="prettyprint">import org.apache.jackrabbit.api.observation.JackrabbitEvent;
+<div>
+<div>
+<pre class="source">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;
@@ -285,10 +284,11 @@ 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>
Modified: jackrabbit/site/live/oak/docs/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/index.html?rev=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/index.html (original)
+++ jackrabbit/site/live/oak/docs/index.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Jackrabbit Oak - the next generation content repository</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,7 +241,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>Jackrabbit Oak - the next generation content repository</h1>
+ -->
+<h1>Jackrabbit Oak - the next generation content repository</h1>
<p>Jackrabbit Oak is an effort to implement a scalable and performant hierarchical content repository for use as the foundation of modern world-class web sites and other demanding content applications. The Oak effort is a part of the <a class="externalLink" href="http://jackrabbit.apache.org/">Apache Jackrabbit project</a>. Apache Jackrabbit is a project of the <a class="externalLink" href="http://www.apache.org/">Apache Software Foundation</a>.</p>
<div class="section">
<h2><a name="Why_Oak"></a>Why Oak</h2>
Modified: jackrabbit/site/live/oak/docs/jsop-diff.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/jsop-diff.html?rev=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/jsop-diff.html (original)
+++ jackrabbit/site/live/oak/docs/jsop-diff.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – </title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -240,28 +240,35 @@
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.
---><p><i>Note:</i> Below algorithms turns out to be not sufficient. The edit script for the following case is incomplete. Given S constructed from an empty tree</p>
+-->
+<p><i>Note:</i> Below algorithms turns out to be not sufficient. The edit script for the following case is incomplete. Given S constructed from an empty tree</p>
-<div class="source">
-<div class="source"><pre class="prettyprint">S = +/s:{} +/t:{}
+<div>
+<div>
+<pre class="source">S = +/s:{} +/t:{}
</pre></div></div>
+
<p>obtain T from S by</p>
-<div class="source">
-<div class="source"><pre class="prettyprint">T = S +/s/a:{} >/s:/t/s
+<div>
+<div>
+<pre class="source">T = S +/s/a:{} >/s:/t/s
</pre></div></div>
+
<p>Running below algorithm on S and T will result in an edit script which, when applied to S, will not create child node a. I.e. it will result in</p>
-<div class="source">
-<div class="source"><pre class="prettyprint">S >/s:/t/s
+<div>
+<div>
+<pre class="source">S >/s:/t/s
</pre></div></div>
<hr />
<p>An algorithm for creating edit scripts (in JSOP format) from two trees. See <a class="externalLink" href="https://github.com/mduerig/json-diff">this GitHub repository</a> for a proof of concept implementation and <a class="externalLink" href="http://markmail.org/message/lbc3rx2p3sssvqj5">the related discussion on oak-dev@</a></p>
-<div class="source">
-<div class="source"><pre class="prettyprint">// Global variable holding the JSOP journal after the diffTree below returns.
+<div>
+<div>
+<pre class="source">// Global variable holding the JSOP journal after the diffTree below returns.
jsop = ""
-
+
/*
Create a JSOP journal, which when applied to tree S will transform
it to tree T.
Modified: jackrabbit/site/live/oak/docs/known_issues.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/known_issues.html?rev=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/known_issues.html (original)
+++ jackrabbit/site/live/oak/docs/known_issues.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Known issues</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,36 +241,36 @@
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>Known issues</h1>
-<p>All known issues are listed in the Apache <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">JIRA</a>. Changes with respect to Jackrabbit-core are collected in <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">OAK-14</a> and its sub-tasks.</p>
-
+ -->
+<h1>Known issues</h1>
+<p>All known issues are listed in the Apache <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK">JIRA</a>. Changes with respect to Jackrabbit-core are collected in [OAK-14] (<a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">https://issues.apache.org/jira/browse/OAK-14</a>) and its sub-tasks.</p>
<ul>
-
+
<li>
+
<p>Workspace Operations:</p>
-
<ul>
-
-<li>Cross workspace operations are not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
-
-<li>Workspace Management (creating/deleting workspaces) is not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
- </ul></li>
-
+
+<li>Cross workspace operations are not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
+<li>Workspace Management (creating/deleting workspaces) is not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-118">OAK-118</a></li>
+</ul>
+</li>
<li>
+
<p>Observation queues handling</p>
-
<ul>
-
-<li>With an excessively large commit rate, the observation queues can fill up and if not prevented and the queue hits a certain threshold and/or the limit then it would result in Local events reported as external event <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2683">OAK-2683</a>​</li>
- </ul></li>
-
+
+<li>With an excessively large commit rate, the observation queues can fill up and if not prevented and the queue hits a certain threshold and/or the limit then it would result in Local events reported as external event <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-2683">OAK-2683</a>​</li>
+</ul>
+</li>
<li>
+
<p>Changing an observation listener’s filter:</p>
-
<ul>
-
-<li>Prefiltering of observation queues means that if an observation listener’s filter is changed, that new filter will only fully be applied to newly added changes to the observation queues. Those changes that potentially were still in the queue will have gone through both the old prefilter and the new (post-)filter. <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-5208">OAK-5208</a></li>
- </ul></li>
+
+<li>Prefiltering of observation queues means that if an observation listener’s filter is changed, that new filter will only fully be applied to newly added changes to the observation queues. Those changes that potentially were still in the queue will have gone through both the old prefilter and the new (post-)filter. <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-5208">OAK-5208</a></li>
+</ul>
+</li>
</ul>
</div>
</div>
Modified: jackrabbit/site/live/oak/docs/license.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/license.html?rev=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/license.html (original)
+++ jackrabbit/site/live/oak/docs/license.html Mon Jul 9 08:53:17 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09
| 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="20180524" />
+ <meta name="Date-Revision-yyyymmdd" content="20180709" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – License</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
@@ -241,7 +241,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>License</h1>
+ -->
+<h1>License</h1>
<p>Jackrabbit Oak and any of its parts are licensed according to the terms listed in the <a class="externalLink" href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache License, Version 2.0</a>.</p>
<p>For further information regarding licensing of Apache Software refer to The Apache Software Foundation <a class="externalLink" href="http://www.apache.org/licenses/">licensing information</a>.</p>
</div>