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/11/09 09:44:20 UTC
svn commit: r1846222 [3/22] - 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/features/atomic-counter.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/features/atomic-counter.html?rev=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/atomic-counter.html (original)
+++ jackrabbit/site/live/oak/docs/features/atomic-counter.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <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>
@@ -67,12 +66,7 @@
<li><a href="../nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="../plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="../features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="../plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="../query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -161,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>
@@ -179,11 +171,7 @@
<li><a href="../nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="../plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="../features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="../plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="../query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="../query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -252,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">
@@ -280,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
@@ -310,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;
...
@@ -330,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");
@@ -362,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/direct-binary-access.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/features/direct-binary-access.html?rev=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/direct-binary-access.html (original)
+++ jackrabbit/site/live/oak/docs/features/direct-binary-access.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-08-30
| 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="20180919" />
+ <meta name="Date-Revision-yyyymmdd" content="20180830" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Direct Binary Access</title>
<link rel="stylesheet" href="../css/apache-maven-fluido-1.6.min.css" />
@@ -142,7 +142,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<span class="divider">|</span>
+ <li id="publishDate">Last Published: 2018-08-30<span class="divider">|</span>
</li>
<li id="projectVersion">Version: 1.10-SNAPSHOT</li>
</ul>
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=1846222&r1=1846221&r2=1846222&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 Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <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>
@@ -67,12 +66,7 @@
<li><a href="../nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="../plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="../features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="../plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="../query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -161,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>
@@ -179,11 +171,7 @@
<li><a href="../nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="../plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="../features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="../plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="../query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="../query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -251,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>
@@ -274,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>
@@ -299,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=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/features/observation.html (original)
+++ jackrabbit/site/live/oak/docs/features/observation.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <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>
@@ -67,12 +66,7 @@
<li><a href="../nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="../plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="../features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="../plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="../query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -161,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>
@@ -179,11 +171,7 @@
<li><a href="../nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="../plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="../features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="../plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="../query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="../query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -252,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">
@@ -268,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;
@@ -295,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>
Modified: jackrabbit/site/live/oak/docs/index.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/index.html?rev=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/index.html (original)
+++ jackrabbit/site/live/oak/docs/index.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<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" />
@@ -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>
@@ -67,12 +66,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -162,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>
@@ -180,11 +172,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -252,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>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=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/jsop-diff.html (original)
+++ jackrabbit/site/live/oak/docs/jsop-diff.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – </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>
@@ -67,12 +66,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -161,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>
@@ -179,11 +171,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -251,35 +239,28 @@
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>
-<div>
-<pre class="source">S = +/s:{} +/t:{}
+<div class="source">
+<div class="source"><pre class="prettyprint">S = +/s:{} +/t:{}
</pre></div></div>
-
<p>obtain T from S by</p>
-<div>
-<div>
-<pre class="source">T = S +/s/a:{} >/s:/t/s
+<div class="source">
+<div class="source"><pre class="prettyprint">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>
-<div>
-<pre class="source">S >/s:/t/s
+<div class="source">
+<div class="source"><pre class="prettyprint">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>
-<div>
-<pre class="source">// Global variable holding the JSOP journal after the diffTree below returns.
+<div class="source">
+<div class="source"><pre class="prettyprint">// 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=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/known_issues.html (original)
+++ jackrabbit/site/live/oak/docs/known_issues.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<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" />
@@ -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>
@@ -67,12 +66,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -161,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>
@@ -179,11 +171,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -252,36 +240,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 [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>
+ --><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>
+<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=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/license.html (original)
+++ jackrabbit/site/live/oak/docs/license.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – License</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>
@@ -67,12 +66,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -162,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>
@@ -180,11 +172,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -252,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>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>
Modified: jackrabbit/site/live/oak/docs/migration.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/migration.html?rev=1846222&r1=1846221&r2=1846222&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/migration.html (original)
+++ jackrabbit/site/live/oak/docs/migration.html Fri Nov 9 09:44:19 2018
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-09-19
+ | 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="20180919" />
+ <meta name="Date-Revision-yyyymmdd" content="20180221" />
<meta http-equiv="Content-Language" content="en" />
<title>Jackrabbit Oak – Repository migration</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>
@@ -67,12 +66,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore">Composite NodeStore</a></li>
</ul>
</li>
- <li class="dropdown-submenu">
-<a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a>
- <ul class="dropdown-menu">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access">Direct Binary Access</a></li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage">Blob Storage</a></li>
<li class="dropdown-submenu">
<a href="query/query.html" title="Query">Query</a>
<ul class="dropdown-menu">
@@ -142,7 +136,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2018-09-19<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>
@@ -161,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>
@@ -179,11 +171,7 @@
<li><a href="nodestore/compositens.html" title="Composite NodeStore"><span class="none"></span>Composite NodeStore</a> </li>
</ul>
</li>
- <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="icon-chevron-down"></span>Blob Storage</a>
- <ul class="nav nav-list">
- <li><a href="features/direct-binary-access.html" title="Direct Binary Access"><span class="none"></span>Direct Binary Access</a> </li>
- </ul>
- </li>
+ <li><a href="plugins/blobstore.html" title="Blob Storage"><span class="none"></span>Blob Storage</a> </li>
<li><a href="query/query.html" title="Query"><span class="icon-chevron-down"></span>Query</a>
<ul class="nav nav-list">
<li><a href="query/query-engine.html" title="Query Engine"><span class="none"></span>Query Engine</a> </li>
@@ -252,47 +240,52 @@
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 migration</h1>
+ --><h1>Repository migration</h1>
<p>Oak offers a few tools which can be used to migrate the old, Jackrabbit 2 repository and also to copy content between Oak instances. <tt>oak-upgrade</tt> is a Swiss army knife for copying content between virtually any repositories. On the other hand, the <tt>SplitBlobStore</tt> allows to copy the binaries gradually, from one blob store to another, without having a long repository downtime.</p>
<div class="section">
<h2><a name="Offline_migration_using_oak-upgrade"></a>Offline migration using oak-upgrade</h2>
<p><img src="img/migration-general.png" alt="oak-upgrade chart" /></p>
<p>The <tt>oak-upgrade</tt> module allows to do an upgrade from the classic Jackrabbit 2.0 repository to the Oak node store and also to sidegrade from one nodestore type to another. Besides from that it has a number of features that can be useful in everyday system maintenance:</p>
-<ul>
+<ul>
+
<li>copying only a selcted subtree from one repository to another,</li>
+
<li>precise control over version histories migration,</li>
+
<li>migrating binaries from one blobstore to another.</li>
</ul>
<div class="section">
<h3><a name="Sidegrade"></a>Sidegrade</h3>
<p><tt>oak-upgrade</tt> module creates an executable jar file. It can be invoked like this:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar [options] source destination
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar [options] source destination
</pre></div></div>
-
<p>The <tt>source</tt> and <tt>destination</tt> are the node store paths/URIs. Following node stores are supported:</p>
-<ul>
+<ul>
+
<li><tt>SegmentNodeStore</tt> - use a path to the <tt>repository</tt> directory,</li>
+
<li>old <tt>SegmentNodeStore</tt> (Oak < 1.6) - use the <tt>segment-old:</tt> prefix and the path to the <tt>repository</tt> directory,</li>
+
<li><tt>DocumentNodeStore</tt> with MongoDB - <tt>mongodb://host:port/database</tt>,</li>
+
<li><tt>DocumentNodeStore</tt> with a RDB - <tt>jdbc:...</tt>. It requires passing user and password with separate parameters.</li>
</ul>
<p>Following parameters should be used for the JDBC node store:</p>
-<ul>
+<ul>
+
<li>Source database: <tt>--src-password=... --src-user=...</tt></li>
+
<li>Desination database: <tt>--user=... --password=...</tt></li>
</ul>
<p>Examples:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
path/to/the/repository \
mongodb://localhost:27017/oak
@@ -300,15 +293,13 @@ java -jar oak-upgrade-*.jar \
--user=sa --password=sa \
mongodb://localhost:27017/oak \
jdbc:h2:path/to/repo
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h3><a name="Upgrade"></a>Upgrade</h3>
<p>In order to upgrade Jackrabbit 2 repository to the new node store, pass the path to the <tt>repository</tt> directory as the <tt>source</tt> parameter. Optionally, you may also pass the path to the <tt>repository.xml</tt> file as a separate parameter. Examples:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
path/to/the/jr2/repository \
path/to/repository.xml \
path/to/the/new/repository
@@ -316,93 +307,144 @@ java -jar oak-upgrade-*.jar \
java -jar oak-upgrade-*.jar \
path/to/the/jr2/repository \
mongodb://localhost:27017/oak
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h3><a name="Migrating_blob_store"></a>Migrating blob store</h3>
<p>By default, the <tt>oak-upgrade</tt> only copies the binary references, so you need to reuse the same blob/data store in the new repository. However, it’s also possible to migrate binaries as well using the <tt>--copy-binaries</tt> parameter. Following migration paths are possible for the binaries. The <i>internal</i> means that the binaries are stored inside the segment or document node store:</p>
-<table border="0" class="table table-striped">
-<thead>
+<table border="0" class="table table-striped">
+ <thead>
+
<tr class="a">
-<th align="center"> From ↓ To → </th>
-<th align="center"> Internal </th>
-<th align="center"> FileBlobStore </th>
-<th align="center"> FileDataStore </th>
-<th align="center"> S3 </th></tr>
-</thead><tbody>
-
+
+<th align="center">From ↓ To → </th>
+
+<th align="center">Internal </th>
+
+<th align="center">FileBlobStore </th>
+
+<th align="center">FileDataStore </th>
+
+<th align="center">S3 </th>
+ </tr>
+ </thead>
+ <tbody>
+
<tr class="b">
-<td align="center"> Internal </td>
-<td align="center"> Yes² </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td></tr>
+
+<td align="center">Internal </td>
+
+<td align="center">Yes² </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+ </tr>
+
<tr class="a">
-<td align="center"> FileBlobStore </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes² </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td></tr>
+
+<td align="center">FileBlobStore </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes² </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+ </tr>
+
<tr class="b">
-<td align="center"> FileDataStore </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes² </td>
-<td align="center"> Yes (not recommended)¹ </td></tr>
+
+<td align="center">FileDataStore </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes² </td>
+
+<td align="center">Yes (not recommended)¹ </td>
+ </tr>
+
<tr class="a">
-<td align="center"> S3 </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes </td>
-<td align="center"> Yes² </td></tr>
-</tbody>
+
+<td align="center">S3 </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes </td>
+
+<td align="center">Yes² </td>
+ </tr>
+ </tbody>
</table>
<p>¹ The S3DataStore will take care of this migration automatically, no need to use oak-upgrade <br /> ² The storage might be simple cloned without using oak2oak</p>
<p>Following parameters can be used to define the source and the destination blob stores:</p>
-<table border="0" class="table table-striped">
-<thead>
+<table border="0" class="table table-striped">
+ <thead>
+
<tr class="a">
-<th align="center"> Blob store type </th>
-<th align="center"> Source parameter </th>
-<th align="center"> Destination </th></tr>
-</thead><tbody>
-
+
+<th align="center">Blob store type </th>
+
+<th align="center">Source parameter </th>
+
+<th align="center">Destination </th>
+ </tr>
+ </thead>
+ <tbody>
+
<tr class="b">
-<td align="center"> FileBlobStore </td>
-<td align="center"> <tt>--src-fileblobstore=...</tt> </td>
-<td align="center"> <tt>--fileblobstore=...</tt> </td></tr>
+
+<td align="center">FileBlobStore </td>
+
+<td align="center"><tt>--src-fileblobstore=...</tt> </td>
+
+<td align="center"><tt>--fileblobstore=...</tt> </td>
+ </tr>
+
<tr class="a">
-<td align="center"> FileDataStore </td>
-<td align="center"> <tt>--src-datastore=...</tt> </td>
-<td align="center"> <tt>--datastore=...</tt> </td></tr>
+
+<td align="center">FileDataStore </td>
+
+<td align="center"><tt>--src-datastore=...</tt> </td>
+
+<td align="center"><tt>--datastore=...</tt> </td>
+ </tr>
+
<tr class="b">
-<td align="center"> S3 </td>
-<td align="center"> <tt>--src-s3config=... --src-s3datastore=...</tt> </td>
-<td align="center"> <tt>--s3config=... --s3datastore=...</tt> </td></tr>
-</tbody>
+
+<td align="center">S3 </td>
+
+<td align="center"><tt>--src-s3config=... --src-s3datastore=...</tt> </td>
+
+<td align="center"><tt>--s3config=... --s3datastore=...</tt> </td>
+ </tr>
+ </tbody>
</table>
<p>Use the <tt>--copy-binaries</tt> parameter to instruct the <tt>oak-upgrade</tt> to copy binaries.</p>
<p>Example:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--copy-binaries \
--src-datastore=/old/repository/datastore \
--fileblobstore=/new/repository/datastore \
/old/repository \
/new/repository
</pre></div></div>
-
<div class="section">
<h4><a name="S3_configuration"></a>S3 configuration</h4>
<p>Using S3DataStore as a source or destination for binaries requires passing two arguments: <tt>s3datastore</tt> and <tt>s3config</tt>. The first one should point to the datastore directory (eg. <tt>crx-quickstart/repository/datastore</tt>). The second should be used to define the <tt>org.apache.jackrabbit.oak.plugins.blob.datastore.S3DataStore.cfg</tt> configuration file path. File should have following format:</p>
-<div>
-<div>
-<pre class="source">accessKey=...
+<div class="source">
+<div class="source"><pre class="prettyprint">accessKey=...
secretKey=...
s3Bucket=...
s3Region=eu-west-1
@@ -414,43 +456,36 @@ maxConnections=40
writeThreads=30
maxErrorRetry=10
</pre></div></div>
-
<p>For the region and endpoints please visit the <a class="externalLink" href="http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Amazon documentation</a>.</p>
-<p>Alternativly the <tt>*.config</tt> file format, described on the <a class="externalLink" href="https://sling.apache.org/documentation/bundles/configuration-installer-factory.html#configuration-files">Apache Sling website</a>, can be used as it may be convenient for re-using existing OSGi configuration files.</p></div></div>
+<p>Alternativly the <tt>*.config</tt> file format, described on the <a class="externalLink" href="https://sling.apache.org/documentation/bundles/configuration-installer-factory.html#configuration-files">Apache Sling website</a>, can be used as it may be convenient for re-using existing OSGi configuration files. </p></div></div>
<div class="section">
<h3><a name="Migrating_a_subtree"></a>Migrating a subtree</h3>
-<p><img src="img/migration-paths.png" alt="include-paths chart" /></p>
+<p><img src="img/migration-paths.png" alt="–include-paths chart" /></p>
<p>It’s possible to define a list of content subtrees to include or exclude during the migration. By default, the whole repository gets copied. In order to copy only a subtree, use the <tt>--include-paths</tt>. For example, the following command will copy only the <tt>/content/site</tt> and <tt>/content/other_site</tt> subtrees:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--include-paths=/content/site,/content/other_site \
/old/repository \
/new/repository
</pre></div></div>
-
<p>You may also exclude specific paths from being copied. Following command will copy the whole content without the <tt>/content/redundant_site</tt>:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--exclude-paths=/content/redundant_site \
/old/repository \
/new/repository
</pre></div></div>
-
<p>By default, the source repository replaces the destination repository (if there’s one). For instance, in the first example if the <tt>/content/site</tt> node already exists in the destination repository, it’ll be removed and replaced by the source node. It’s also possible to merge content from the source repository with <tt>--merge-paths</tt>:</p>
-<div>
-<div>
-<pre class="source">java -jar oak-upgrade-*.jar \
+<div class="source">
+<div class="source"><pre class="prettyprint">java -jar oak-upgrade-*.jar \
--include-paths=/content/site \
--merge-paths=/content/site \
/old/repository \
/new/repository
</pre></div></div>
-
<p>Please notice that in the last example it’s necessary to narrow the migration scope using <tt>--include-paths</tt> parameter.</p></div>
<div class="section">
<h3><a name="Version_history_copying"></a>Version history copying</h3>
@@ -458,9 +493,8 @@ maxErrorRetry=10
<p>By default, the whole version storage is migrated. This includes referenced version histories (their versionable node still exists in the repository) and orphaned ones (their versionable node no longer exists). <tt>oak-upgrade</tt> allows to skip the orphaned version histories to make the migration faster and the destination repository smaller. It’s also possible to define a maximum age for the version histories (both referenced and orphaned) to be copied.</p>
<p>There are two parameters: <tt>--copy-orphaned-versions</tt> and <tt>--copy-versions</tt>. Both accepts boolean values or a <tt>YYYY-MM-DD</tt> date. Examples:</p>
-<div>
-<div>
-<pre class="source"># only copy referenced versions
+<div class="source">
+<div class="source"><pre class="prettyprint"># only copy referenced versions
java -jar oak-upgrade-*.jar \
--copy-orphaned-versions=false \
/old/repository /new/repository
@@ -476,15 +510,17 @@ java -jar oak-upgrade-*.jar \
--copy-versions=2010-01-01 \
--copy-orphaned-versions=2011-01-01 \
/old/repository /new/repository
-</pre></div></div>
-</div>
+</pre></div></div></div>
<div class="section">
<h3><a name="Incremental_migration"></a>Incremental migration</h3>
<p>If an existing repository is passed as the destination, then only a diff between source and destination will be migrated. It allows to migrate the content in a few iterations. For instance, following case is possible:</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>migrate a large repository a week before go-live</li>
+
<li>run the migration again every night (only the recent changes are copied)</li>
+
<li>run the migration one final time before go-live</li>
</ol></div>
<div class="section">
@@ -495,18 +531,14 @@ java -jar oak-upgrade-*.jar \
<p>It’s possible to inject custom logic into the upgrade process, by implementing <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/lifecycle/RepositoryInitializer.html"><tt>RepositoryInitializer</tt></a> or <a class="externalLink" href="https://jackrabbit.apache.org/oak/docs/apidocs/org/apache/jackrabbit/oak/spi/commit/CommitHook.html"><tt>CommitHook</tt></a>.</p>
<p>In order to do that, create a new Maven project, with appropriate implementation. Then create following file:</p>
-<div>
-<div>
-<pre class="source">src/main/resources/META-INF/services/org.apache.jackrabbit.oak.spi.commit.CommitHook
+<div class="source">
+<div class="source"><pre class="prettyprint">src/main/resources/META-INF/services/org.apache.jackrabbit.oak.spi.commit.CommitHook
</pre></div></div>
-
<p>The file should contain just one line - the name of the class with the <tt>CoomitHook</tt> implementation. Build the project and attach the JAR to the oak-upgrade class path:</p>
-<div>
-<div>
-<pre class="source">java -cp my-commit-hook.jar:oak-upgrade-*.jar org.apache.jackrabbit.oak.upgrade.cli.OakUpgrade [normal oak-upgrade parameters]
+<div class="source">
+<div class="source"><pre class="prettyprint">java -cp my-commit-hook.jar:oak-upgrade-*.jar org.apache.jackrabbit.oak.upgrade.cli.OakUpgrade [normal oak-upgrade parameters]
</pre></div></div>
-
<p>A custom <tt>RepositoryInitializer</tt> can be injected in a similar way.</p></div>
<div class="section">
<h3><a name="Other_parameters"></a>Other parameters</h3>
@@ -514,20 +546,20 @@ java -jar oak-upgrade-*.jar \
<div class="section">
<h3><a name="Checkpoints_migration"></a>Checkpoints migration</h3>
<p>When migrating an old SegmentMK repository (pre-Oak 1.6) to the new SegmentMK (Oak >= 1.6), the checkpoints are migrated as well. This allows to avoid reindexing when the Oak is being run for the first time on the new repository. However, the checkpoints won’t be migrated in following cases:</p>
-<ul>
+<ul>
+
<li>custom include-, exclude- or merge- paths are specified or</li>
+
<li>the binaries are copied by references, no source datastore is specified and two different checkpoints contains different binary under the same path.</li>
</ul>
<p>In the second case oak-upgrade emits following warning and breaks:</p>
-<div>
-<div>
-<pre class="source">Checkpoints won't be copied, because no external datastore has been specified. This will result in the full repository reindexing on the first start. Use --skip-checkpoints to force the migration or see https://jackrabbit.apache.org/oak/docs/migration.html#Checkpoints_migration for more info.
+<div class="source">
+<div class="source"><pre class="prettyprint">Checkpoints won't be copied, because no external datastore has been specified. This will result in the full repository reindexing on the first start. Use --skip-checkpoints to force the migration or see https://jackrabbit.apache.org/oak/docs/migration.html#Checkpoints_migration for more info.
</pre></div></div>
-
<p>The easiest way to fix this issue is specifying the source datastore in the command line options (eg. <tt>--src-datastore</tt> or <tt>--src-s3datastore</tt>).</p>
-<p>The warning may also be ignored, but in this case the repository will be fully reindexed on the first startup. It may be a long process, especially for the big instance. Repository won’t be usable until the reindexing process is done. Use <tt>--skip-checkpoints</tt> option to suppress the warning.</p></div></div>
+<p>The warning may also be ignored, but in this case the repository will be fully reindexed on the first startup. It may be a long process, especially for the big instance. Repository won’t be usable until the reindexing process is done. Use <tt>--skip-checkpoints</tt> option to suppress the warning. </p></div></div>
<div class="section">
<h2><a name="Online_blob_migration_with_SplitBlobStore"></a>Online blob migration with SplitBlobStore</h2>
<p>Oak offers one more way to migrate blob store, without turning off the instance (a few restarts might be required, but the migration process is done during normal repository operation).</p>
@@ -536,54 +568,60 @@ java -jar oak-upgrade-*.jar \
<div class="section">
<div class="section">
<h4><a name="Requirements"></a>Requirements</h4>
-<ul>
+<ul>
+
<li>An OSGi-based Oak installation (eg. Sling or AEM).</li>
</ul></div>
<div class="section">
<h4><a name="Enabling_SplitBlobStore_-_external_blob_store_case"></a>Enabling SplitBlobStore - external blob store case</h4>
<p>These steps should be followed for migration from <tt>FileBlobStore</tt>, <tt>FileDataStore</tt> or <tt>S3DataStore</tt>.</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Add <tt>split.blobstore=old</tt> OSGi property to the source blob store.</li>
+
<li>Configure the destination blob store and add <tt>split.blobstore=new</tt> property to its OSGi configuration.</li>
-<li>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.
-
-<div>
-<div>
-<pre class="source">split.old.blobstore.type=INTERNAL
+
+<li>
+<p>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint">split.old.blobstore.type=INTERNAL
# optional:
repository.home=crx-quickstart/repository
</pre></div></div>
-
+
<ul>
-
+
<li>The directory is used to save the <tt>migrated_blobs.txt</tt> file.</li>
-</ul>
-</li>
+ </ul></li>
+
<li>Restart the instance</li>
</ol></div>
<div class="section">
<h4><a name="Enabling_SplitBlobStore_-_internal_blob_store_case"></a>Enabling SplitBlobStore - internal blob store case</h4>
<p>These steps should be followed for migration from <tt>MongoBlobStore</tt> or for blobs embedded in the <tt>SegmentNodeStore</tt>.</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Configure the destination blob store and add <tt>split.blobstore=new</tt> property to its OSGi configuration.</li>
-<li>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.
-
-<div>
-<div>
-<pre class="source"># use DOCUMENT or SEGMENT, depending on the NodeStore type:
+
+<li>
+<p>Create a configuration for the <tt>org.apache.jackrabbit.oak.spi.blob.osgi.SplitBlobStoreService</tt>.</p>
+
+<div class="source">
+<div class="source"><pre class="prettyprint"># use DOCUMENT or SEGMENT, depending on the NodeStore type:
split.old.blobstore.type=SEGMENT
# optional:
repository.home=crx-quickstart/repository
</pre></div></div>
-
+
<ul>
-
+
<li>The directory is used to save the migrated_blobs.txt file.</li>
-</ul>
-</li>
+ </ul></li>
+
<li>Restart the instance</li>
</ol>
<p>After starting the instance, the <tt>SplitBlobStoreService</tt> will wait until blob stores with <tt>split.blobstore</tt> properties (the <tt>old</tt> and the <tt>new</tt>) are available. They will be bound and the <tt>SplitBlobStore</tt> will be registered in the OSGi. On the other hand, the <tt>NodeStoreService</tt> will ignore blob stores configured with the <tt>split.blobstore</tt> property and will wait until the <tt>SplitBlobStore</tt> is available.</p>
@@ -591,25 +629,33 @@ repository.home=crx-quickstart/repositor
<p>The <tt>split.blobstore</tt> property support was added to <tt>FileBlobStore</tt>, <tt>AbstractDataStoreService</tt> (handling all Jackrabbit data stores), <tt>DocumentNodeStoreService</tt> and <tt>SegmentNodeStoreService</tt>.</p></div>
<div class="section">
<h4><a name="Migration"></a>Migration</h4>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Find <tt>BlobMigration</tt> JMX bean in the Felix console.</li>
+
<li>Run <tt>startBlobMigration(false)</tt> operation</li>
</ol>
<p>The migration can be stopped using <tt>stopBlobMigration()</tt> and then resumed with <tt>startBlobMigration(true)</tt>. The current stats are available via the JMX as well:</p>
-<ul>
+<ul>
+
<li>last processed path,</li>
+
<li>number of migrated nodes.</li>
</ul></div>
<div class="section">
<h4><a name="Switching_to_the_new_blob_store"></a>Switching to the new blob store</h4>
<p>When the migration is finished, it’s possible to completely switch to the new blob store:</p>
-<ol style="list-style-type: decimal">
+<ol style="list-style-type: decimal">
+
<li>Remove the configuration for the old blob store.</li>
+
<li>Remove the configuration for the <tt>SplitBlobStoreService</tt></li>
+
<li>Remove the <tt>split.blobstore=new</tt> OSGi property from the new blob store, so it can be find by the <tt>NodeStoreService</tt>.</li>
+
<li>Restart the instance, so there are no JCR sessions bound to the old NodeState.</li>
</ol>
<p>Migration is now complete!</p></div></div></div>