You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by ju...@apache.org on 2013/10/15 18:21:54 UTC
svn commit: r1532415 [2/11] - in /jackrabbit/site/live/oak/docs: ./
META-INF/ css/ js/
Modified: jackrabbit/site/live/oak/docs/dev_getting_started.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/dev_getting_started.html?rev=1532415&r1=1532414&r2=1532415&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/dev_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/dev_getting_started.html Tue Oct 15 16:21:53 2013
@@ -1,436 +1,436 @@
-<!DOCTYPE html>
-<!--
- | Generated by Apache Maven Doxia at 2013-10-15
- | Rendered using Apache Maven Fluido Skin 1.3.0
--->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20131015" />
- <meta http-equiv="Content-Language" content="en" />
- <title>Jackrabbit Oak - </title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
- <link rel="stylesheet" href="./css/site.css" />
- <link rel="stylesheet" href="./css/print.css" media="print" />
-
-
- <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
-
-
- </head>
- <body class="topBarEnabled">
-
-
-
-
-
-
- <a href="http://github.com/apache/jackrabbit-oak">
- <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
- src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
- alt="Fork me on GitHub">
- </a>
-
-
-
-
-
- <div id="topbar" class="navbar navbar-fixed-top ">
- <div class="navbar-inner">
- <div class="container-fluid">
- <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </a>
-
- <ul class="nav">
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="index.html" title="Jackrabbit Oak">Jackrabbit Oak</a>
-</li>
-
- <li> <a href="license.html" title="License">License</a>
-</li>
-
- <li> <a href="downloads.html" title="Downloads">Downloads</a>
-</li>
-
- <li> <a href="from_here.html" title="From here">From here</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="overview.html" title="Overview">Overview</a>
-</li>
-
- <li> <a href="nodestate.html" title="Understanding the node state model">Understanding the node state model</a>
-</li>
-
- <li> <a href="microkernel.html" title="Microkernel">Microkernel</a>
-</li>
-
- <li> <a href="query.html" title="Query">Query</a>
-</li>
-
- <li> <a href="blobstore.html" title="BlobStore">BlobStore</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
-</li>
-
- <li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
-</li>
-
- <li> <a href="dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
-</li>
-
- <li> <a href="when_things_go_wrong.html" title="When things go wrong">When things go wrong</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="dev_getting_started.html" title="Getting Started">Getting Started</a>
-</li>
-
- <li> <a href="participating.html" title="Participating">Participating</a>
-</li>
-
- <li> <a href="apidocs/index.html" title="API docs">API docs</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="http://jackrabbit.apache.org/oak" title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
-</li>
-
- <li> <a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a>
-</li>
- </ul>
- </li>
- </ul>
-
-
-
-
- </div>
-
- </div>
- </div>
- </div>
-
- <div class="container-fluid">
- <div id="banner">
- <div class="pull-left">
- <div id="bannerLeft">
- <h2>Oak Documentation</h2>
- </div>
- </div>
- <div class="pull-right"> </div>
- <div class="clear"><hr/></div>
- </div>
-
- <div id="breadcrumbs">
- <ul class="breadcrumb">
-
-
- <li id="publishDate">Last Published: 2013-10-15</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.11-SNAPSHOT</li>
-
-
-
-
- </ul>
- </div>
-
-
- <div class="row-fluid">
- <div id="leftColumn" class="span3">
- <div class="well sidebar-nav">
-
-
- <ul class="nav nav-list">
- <li class="nav-header">Overview</li>
-
- <li>
-
- <a href="index.html" title="Jackrabbit Oak">
- <i class="none"></i>
- Jackrabbit Oak</a>
- </li>
-
- <li>
-
- <a href="license.html" title="License">
- <i class="none"></i>
- License</a>
- </li>
-
- <li>
-
- <a href="downloads.html" title="Downloads">
- <i class="none"></i>
- Downloads</a>
- </li>
-
- <li>
-
- <a href="from_here.html" title="From here">
- <i class="none"></i>
- From here</a>
- </li>
- <li class="nav-header">Concepts and architecture</li>
-
- <li>
-
- <a href="overview.html" title="Overview">
- <i class="none"></i>
- Overview</a>
- </li>
-
- <li>
-
- <a href="nodestate.html" title="Understanding the node state model">
- <i class="none"></i>
- Understanding the node state model</a>
- </li>
-
- <li>
-
- <a href="microkernel.html" title="Microkernel">
- <i class="none"></i>
- Microkernel</a>
- </li>
-
- <li>
-
- <a href="query.html" title="Query">
- <i class="none"></i>
- Query</a>
- </li>
-
- <li>
-
- <a href="blobstore.html" title="BlobStore">
- <i class="none"></i>
- BlobStore</a>
- </li>
- <li class="nav-header">Using Oak</li>
-
- <li>
-
- <a href="use_getting_started.html" title="Getting Started">
- <i class="none"></i>
- Getting Started</a>
- </li>
-
- <li>
-
- <a href="differences.html" title="Differences to Jackrabbit 2">
- <i class="none"></i>
- Differences to Jackrabbit 2</a>
- </li>
-
- <li>
-
- <a href="dos_and_donts.html" title="Dos and don'ts">
- <i class="none"></i>
- Dos and don'ts</a>
- </li>
-
- <li>
-
- <a href="when_things_go_wrong.html" title="When things go wrong">
- <i class="none"></i>
- When things go wrong</a>
- </li>
- <li class="nav-header">Developing Oak</li>
-
- <li class="active">
-
- <a href="#"><i class="none"></i>Getting Started</a>
- </li>
-
- <li>
-
- <a href="participating.html" title="Participating">
- <i class="none"></i>
- Participating</a>
- </li>
-
- <li>
-
- <a href="apidocs/index.html" title="API docs">
- <i class="none"></i>
- API docs</a>
- </li>
- <li class="nav-header">Links</li>
-
- <li>
-
- <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
- <i class="none"></i>
- Apache Jackrabbit Oak</a>
- </li>
-
- <li>
-
- <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
- <i class="none"></i>
- Apache Jackrabbit</a>
- </li>
- </ul>
-
-
-
- <hr class="divider" />
-
- <div id="poweredBy">
-
- <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
-
-
- <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-doc/" data-size="tall" ></div>
-
- <div class="clear"></div>
- <div class="clear"></div>
- <div class="clear"></div>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
- </a>
- </div>
- </div>
- </div>
-
-
- <div id="bodyColumn" class="span9" >
-
- <!-- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. --><div class="section">
-<h2>Getting Started<a name="Getting_Started"></a></h2>
-<p>Many parts of Oak are still under construction, so it may be a bit difficult to find your way around the codebase. The <a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/README.md">README files</a>, the <a class="externalLink" href="http://wiki.apache.org/jackrabbit/Jackrabbit%203">Jackrabbit 3 wiki page</a>, and the <a class="externalLink" href="http://oak.markmail.org/">Oak mailing list</a> archives are good places to start learning about Oak.</p>
-<p>To get started developing Oak, build the latest sources with Maven 3 and Java 6 (or higher) like this:</p>
-
-<div class="source">
-<pre>mvn clean install
-</pre></div>
-<p>To enable all integration tests, including the JCR TCK, use:</p>
-
-<div class="source">
-<pre>mvn clean install -PintegrationTesting
-</pre></div>
-<p>Before committing changes or submitting a patch, please make sure that the above integration testing build passes without errors. If you like, you can enable integration tests by default by setting the <tt>OAK_INTEGRATION_TESTING</tt> environment variable.</p></div>
-<div class="section">
-<h2>MongoDB integration<a name="MongoDB_integration"></a></h2>
-<p>Parts of the Oak build expects a MongoDB instance to be available for testing. By default a MongoDB instance running on localhost is expected, and the relevant tests are simply skipped if such an instance is not found. You can also configure the build to use custom MongoDB settings with the following properties (shown with their default values):</p>
-
-<div class="source">
-<pre>-Dmongo.host=127.0.0.1
--Dmongo.port=27017
--Dmongo.db=MongoMKDB
--Dmongo.db2=MongoMKDB2
-</pre></div>
-<p>Note that the configured test databases will be <i>dropped</i> by the test cases.</p></div>
-<div class="section">
-<h2>Components<a name="Components"></a></h2>
-<p>The build consists of the following main components:</p>
-
-<ul>
-
-<li>oak-parent - parent POM</li>
-
-<li>oak-doc - Oak documentation</li>
-
-<li>oak-commons - shared utility code</li>
-
-<li>oak-mk-api - MicroKernel API</li>
-
-<li>oak-mk - default MicroKernel implementation</li>
-
-<li>oak-mk-remote - MicroKernel remoting</li>
-
-<li><a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md">oak-core</a> - Oak repository API and implementation</li>
-
-<li>oak-jcr - JCR binding for the Oak repository</li>
-
-<li>oak-sling - integration with Apache Sling</li>
-
-<li>oak-solr-core - Apache Solr indexing and search</li>
-
-<li>oak-solr-embedded - Apache Solr on an embedded Solr instance</li>
-
-<li>oak-solr-remote - Apache Solr on an remote (HTTP) Solr instance</li>
-
-<li>oak-http - HTTP binding for Oak</li>
-
-<li>oak-lucene - Lucene-based query index</li>
-
-<li>oak-run - runnable jar packaging</li>
-
-<li>oak-upgrade - tooling for upgrading Jackrabbit repositories to Oak</li>
-
-<li>oak-it - integration tests
-
-<ul>
-
-<li>oak-it/mk - integration tests for MicroKernel</li>
-
-<li>oak-it/osgi - integration tests for OSGi</li>
- </ul></li>
-</ul>
-<p>TODO: Link to additional readmes (benchmark runner, …)</p></div>
- </div>
- </div>
- </div>
-
- <hr/>
-
- <footer>
- <div class="container-fluid">
- <div class="row span12">Copyright © 2012-2013
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All Rights Reserved.
-
- </div>
-
-
-
-
-
-
- <div id="ohloh" class="pull-right">
- <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
- </div>
- </div>
- </footer>
- </body>
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2013-10-15
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20131015" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Jackrabbit Oak - </title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit-oak">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="index.html" title="Jackrabbit Oak">Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="license.html" title="License">License</a>
+</li>
+
+ <li> <a href="downloads.html" title="Downloads">Downloads</a>
+</li>
+
+ <li> <a href="from_here.html" title="From here">From here</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="nodestate.html" title="Understanding the node state model">Understanding the node state model</a>
+</li>
+
+ <li> <a href="microkernel.html" title="Microkernel">Microkernel</a>
+</li>
+
+ <li> <a href="query.html" title="Query">Query</a>
+</li>
+
+ <li> <a href="blobstore.html" title="BlobStore">BlobStore</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+
+ <li> <a href="dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+</li>
+
+ <li> <a href="when_things_go_wrong.html" title="When things go wrong">When things go wrong</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="dev_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="participating.html" title="Participating">Participating</a>
+</li>
+
+ <li> <a href="apidocs/index.html" title="API docs">API docs</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://jackrabbit.apache.org/oak" title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Oak Documentation</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2013-10-15</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.11-SNAPSHOT</li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+
+ <li>
+
+ <a href="index.html" title="Jackrabbit Oak">
+ <i class="none"></i>
+ Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="license.html" title="License">
+ <i class="none"></i>
+ License</a>
+ </li>
+
+ <li>
+
+ <a href="downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+
+ <li>
+
+ <a href="from_here.html" title="From here">
+ <i class="none"></i>
+ From here</a>
+ </li>
+ <li class="nav-header">Concepts and architecture</li>
+
+ <li>
+
+ <a href="overview.html" title="Overview">
+ <i class="none"></i>
+ Overview</a>
+ </li>
+
+ <li>
+
+ <a href="nodestate.html" title="Understanding the node state model">
+ <i class="none"></i>
+ Understanding the node state model</a>
+ </li>
+
+ <li>
+
+ <a href="microkernel.html" title="Microkernel">
+ <i class="none"></i>
+ Microkernel</a>
+ </li>
+
+ <li>
+
+ <a href="query.html" title="Query">
+ <i class="none"></i>
+ Query</a>
+ </li>
+
+ <li>
+
+ <a href="blobstore.html" title="BlobStore">
+ <i class="none"></i>
+ BlobStore</a>
+ </li>
+ <li class="nav-header">Using Oak</li>
+
+ <li>
+
+ <a href="use_getting_started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="differences.html" title="Differences to Jackrabbit 2">
+ <i class="none"></i>
+ Differences to Jackrabbit 2</a>
+ </li>
+
+ <li>
+
+ <a href="dos_and_donts.html" title="Dos and don'ts">
+ <i class="none"></i>
+ Dos and don'ts</a>
+ </li>
+
+ <li>
+
+ <a href="when_things_go_wrong.html" title="When things go wrong">
+ <i class="none"></i>
+ When things go wrong</a>
+ </li>
+ <li class="nav-header">Developing Oak</li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="participating.html" title="Participating">
+ <i class="none"></i>
+ Participating</a>
+ </li>
+
+ <li>
+
+ <a href="apidocs/index.html" title="API docs">
+ <i class="none"></i>
+ API docs</a>
+ </li>
+ <li class="nav-header">Links</li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
+ <i class="none"></i>
+ Apache Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
+ <i class="none"></i>
+ Apache Jackrabbit</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-doc/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. --><div class="section">
+<h2>Getting Started<a name="Getting_Started"></a></h2>
+<p>Many parts of Oak are still under construction, so it may be a bit difficult to find your way around the codebase. The <a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/README.md">README files</a>, the <a class="externalLink" href="http://wiki.apache.org/jackrabbit/Jackrabbit%203">Jackrabbit 3 wiki page</a>, and the <a class="externalLink" href="http://oak.markmail.org/">Oak mailing list</a> archives are good places to start learning about Oak.</p>
+<p>To get started developing Oak, build the latest sources with Maven 3 and Java 6 (or higher) like this:</p>
+
+<div class="source">
+<pre>mvn clean install
+</pre></div>
+<p>To enable all integration tests, including the JCR TCK, use:</p>
+
+<div class="source">
+<pre>mvn clean install -PintegrationTesting
+</pre></div>
+<p>Before committing changes or submitting a patch, please make sure that the above integration testing build passes without errors. If you like, you can enable integration tests by default by setting the <tt>OAK_INTEGRATION_TESTING</tt> environment variable.</p></div>
+<div class="section">
+<h2>MongoDB integration<a name="MongoDB_integration"></a></h2>
+<p>Parts of the Oak build expects a MongoDB instance to be available for testing. By default a MongoDB instance running on localhost is expected, and the relevant tests are simply skipped if such an instance is not found. You can also configure the build to use custom MongoDB settings with the following properties (shown with their default values):</p>
+
+<div class="source">
+<pre>-Dmongo.host=127.0.0.1
+-Dmongo.port=27017
+-Dmongo.db=MongoMKDB
+-Dmongo.db2=MongoMKDB2
+</pre></div>
+<p>Note that the configured test databases will be <i>dropped</i> by the test cases.</p></div>
+<div class="section">
+<h2>Components<a name="Components"></a></h2>
+<p>The build consists of the following main components:</p>
+
+<ul>
+
+<li>oak-parent - parent POM</li>
+
+<li>oak-doc - Oak documentation</li>
+
+<li>oak-commons - shared utility code</li>
+
+<li>oak-mk-api - MicroKernel API</li>
+
+<li>oak-mk - default MicroKernel implementation</li>
+
+<li>oak-mk-remote - MicroKernel remoting</li>
+
+<li><a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-core/README.md">oak-core</a> - Oak repository API and implementation</li>
+
+<li>oak-jcr - JCR binding for the Oak repository</li>
+
+<li>oak-sling - integration with Apache Sling</li>
+
+<li>oak-solr-core - Apache Solr indexing and search</li>
+
+<li>oak-solr-embedded - Apache Solr on an embedded Solr instance</li>
+
+<li>oak-solr-remote - Apache Solr on an remote (HTTP) Solr instance</li>
+
+<li>oak-http - HTTP binding for Oak</li>
+
+<li>oak-lucene - Lucene-based query index</li>
+
+<li>oak-run - runnable jar packaging</li>
+
+<li>oak-upgrade - tooling for upgrading Jackrabbit repositories to Oak</li>
+
+<li>oak-it - integration tests
+
+<ul>
+
+<li>oak-it/mk - integration tests for MicroKernel</li>
+
+<li>oak-it/osgi - integration tests for OSGi</li>
+ </ul></li>
+</ul>
+<p>TODO: Link to additional readmes (benchmark runner, …)</p></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2012-2013
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
</html>
\ No newline at end of file
Modified: jackrabbit/site/live/oak/docs/differences.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/differences.html?rev=1532415&r1=1532414&r2=1532415&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/differences.html (original)
+++ jackrabbit/site/live/oak/docs/differences.html Tue Oct 15 16:21:53 2013
@@ -1,526 +1,526 @@
-<!DOCTYPE html>
-<!--
- | Generated by Apache Maven Doxia at 2013-10-15
- | Rendered using Apache Maven Fluido Skin 1.3.0
--->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20131015" />
- <meta http-equiv="Content-Language" content="en" />
- <title>Jackrabbit Oak - </title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
- <link rel="stylesheet" href="./css/site.css" />
- <link rel="stylesheet" href="./css/print.css" media="print" />
-
-
- <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
-
-
- </head>
- <body class="topBarEnabled">
-
-
-
-
-
-
- <a href="http://github.com/apache/jackrabbit-oak">
- <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
- src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
- alt="Fork me on GitHub">
- </a>
-
-
-
-
-
- <div id="topbar" class="navbar navbar-fixed-top ">
- <div class="navbar-inner">
- <div class="container-fluid">
- <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </a>
-
- <ul class="nav">
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="index.html" title="Jackrabbit Oak">Jackrabbit Oak</a>
-</li>
-
- <li> <a href="license.html" title="License">License</a>
-</li>
-
- <li> <a href="downloads.html" title="Downloads">Downloads</a>
-</li>
-
- <li> <a href="from_here.html" title="From here">From here</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="overview.html" title="Overview">Overview</a>
-</li>
-
- <li> <a href="nodestate.html" title="Understanding the node state model">Understanding the node state model</a>
-</li>
-
- <li> <a href="microkernel.html" title="Microkernel">Microkernel</a>
-</li>
-
- <li> <a href="query.html" title="Query">Query</a>
-</li>
-
- <li> <a href="blobstore.html" title="BlobStore">BlobStore</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
-</li>
-
- <li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
-</li>
-
- <li> <a href="dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
-</li>
-
- <li> <a href="when_things_go_wrong.html" title="When things go wrong">When things go wrong</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="dev_getting_started.html" title="Getting Started">Getting Started</a>
-</li>
-
- <li> <a href="participating.html" title="Participating">Participating</a>
-</li>
-
- <li> <a href="apidocs/index.html" title="API docs">API docs</a>
-</li>
- </ul>
- </li>
- <li class="dropdown">
- <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
- <li> <a href="http://jackrabbit.apache.org/oak" title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
-</li>
-
- <li> <a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a>
-</li>
- </ul>
- </li>
- </ul>
-
-
-
-
- </div>
-
- </div>
- </div>
- </div>
-
- <div class="container-fluid">
- <div id="banner">
- <div class="pull-left">
- <div id="bannerLeft">
- <h2>Oak Documentation</h2>
- </div>
- </div>
- <div class="pull-right"> </div>
- <div class="clear"><hr/></div>
- </div>
-
- <div id="breadcrumbs">
- <ul class="breadcrumb">
-
-
- <li id="publishDate">Last Published: 2013-10-15</li>
- <li class="divider">|</li> <li id="projectVersion">Version: 0.11-SNAPSHOT</li>
-
-
-
-
- </ul>
- </div>
-
-
- <div class="row-fluid">
- <div id="leftColumn" class="span3">
- <div class="well sidebar-nav">
-
-
- <ul class="nav nav-list">
- <li class="nav-header">Overview</li>
-
- <li>
-
- <a href="index.html" title="Jackrabbit Oak">
- <i class="none"></i>
- Jackrabbit Oak</a>
- </li>
-
- <li>
-
- <a href="license.html" title="License">
- <i class="none"></i>
- License</a>
- </li>
-
- <li>
-
- <a href="downloads.html" title="Downloads">
- <i class="none"></i>
- Downloads</a>
- </li>
-
- <li>
-
- <a href="from_here.html" title="From here">
- <i class="none"></i>
- From here</a>
- </li>
- <li class="nav-header">Concepts and architecture</li>
-
- <li>
-
- <a href="overview.html" title="Overview">
- <i class="none"></i>
- Overview</a>
- </li>
-
- <li>
-
- <a href="nodestate.html" title="Understanding the node state model">
- <i class="none"></i>
- Understanding the node state model</a>
- </li>
-
- <li>
-
- <a href="microkernel.html" title="Microkernel">
- <i class="none"></i>
- Microkernel</a>
- </li>
-
- <li>
-
- <a href="query.html" title="Query">
- <i class="none"></i>
- Query</a>
- </li>
-
- <li>
-
- <a href="blobstore.html" title="BlobStore">
- <i class="none"></i>
- BlobStore</a>
- </li>
- <li class="nav-header">Using Oak</li>
-
- <li>
-
- <a href="use_getting_started.html" title="Getting Started">
- <i class="none"></i>
- Getting Started</a>
- </li>
-
- <li class="active">
-
- <a href="#"><i class="none"></i>Differences to Jackrabbit 2</a>
- </li>
-
- <li>
-
- <a href="dos_and_donts.html" title="Dos and don'ts">
- <i class="none"></i>
- Dos and don'ts</a>
- </li>
-
- <li>
-
- <a href="when_things_go_wrong.html" title="When things go wrong">
- <i class="none"></i>
- When things go wrong</a>
- </li>
- <li class="nav-header">Developing Oak</li>
-
- <li>
-
- <a href="dev_getting_started.html" title="Getting Started">
- <i class="none"></i>
- Getting Started</a>
- </li>
-
- <li>
-
- <a href="participating.html" title="Participating">
- <i class="none"></i>
- Participating</a>
- </li>
-
- <li>
-
- <a href="apidocs/index.html" title="API docs">
- <i class="none"></i>
- API docs</a>
- </li>
- <li class="nav-header">Links</li>
-
- <li>
-
- <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
- <i class="none"></i>
- Apache Jackrabbit Oak</a>
- </li>
-
- <li>
-
- <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
- <i class="none"></i>
- Apache Jackrabbit</a>
- </li>
- </ul>
-
-
-
- <hr class="divider" />
-
- <div id="poweredBy">
-
- <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
-
-
- <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-doc/" data-size="tall" ></div>
-
- <div class="clear"></div>
- <div class="clear"></div>
- <div class="clear"></div>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
- </a>
- </div>
- </div>
- </div>
-
-
- <div id="bodyColumn" class="span9" >
-
- <!-- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License. --><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>
-<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>Session state and refresh behaviour<a name="Session_state_and_refresh_behaviour"></a></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.</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>
-</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>
-<div class="section">
-<h2>Query<a name="Query"></a></h2>
-<p>Oak does not index content by default as does Jackrabbit 2. You need to create custom indexes when necessary, much like in traditional RDBMSs. If there is no index for a specific query then the repository will be traversed. That is, the query will still work but probably be very slow.</p>
-<p>See the <a href="query.html">query overview page</a> for how to create a custom index.</p></div>
-<div class="section">
-<h2>Observation<a name="Observation"></a></h2>
-<p>Regarding observation listeners:</p>
-
-<ul>
-
-<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>
-
-<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>.</p></li>
-
-<li>
-<p><tt>Event.NODE_MOVED</tt> is not supported. Instead <tt>Event.NODE_ADDED</tt> and <tt>Event.Node_REMOVED</tt> events are reported as long as they don’t cancel each other (e.g. in case of reordering of nodes).</p></li>
-</ul></div>
-<div class="section">
-<h2>Same name siblings<a name="Same_name_siblings"></a></h2>
-<p>Same name siblings (SNS) are deprecated in Oak. We figured that the actual benefit supporting same name siblings as mandated by JCR is dwarfed by the additional implementation complexity. Instead there are ideas to implement a feature for automatic <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-129">disambiguation of node names</a>.</p>
-<p>In the meanwhile we have <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-203">basic support</a> for same name siblings but that might not cover all cases.</p></div>
-<div class="section">
-<h2>Authentication<a name="Authentication"></a></h2>
-<p>Please refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-793">OAK-793</a> for a general overview of changes with respect to Jackrabbit 2.</p></div>
-<div class="section">
-<h2>Access Control Management<a name="Access_Control_Management"></a></h2>
-<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-792">OAK-792</a> for a general overview of changes with respect to Jackrabbit 2.</p>
-<p>The following modification are most likely to have an effect on existing applications:</p>
-
-<ul>
-
-<li><tt>AccessControlManager#hasPrivilege()</tt> and <tt>AccessControlManager#getPrivileges()</tt> will throw a <tt>PathNotFoundException</tt> if the node for the specified path is not accessible. The Jackrabbit 2 implementation is wrong and we fixed that in OAK (<a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-886">OAK-886</a>). If the new behaviour turns out to be a problem with existing applications we might consider adding backward compatible behaviour.</li>
-</ul></div>
-<div class="section">
-<h2>Permissions<a name="Permissions"></a></h2>
-<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-942">OAK-942</a> for a general overview of changes with respect to Jackrabbit 2.</p>
-
-<ul>
-
-<li>
-<p>As of Oak <tt>Node#remove()</tt> only requires sufficient permissions to remove the target node. In contrast to jackrabbit the validation will not traverse the tree and verify remove permission on all child nodes/properties. There exists a configuration flag that aims to produce best effort backwards compatibility but this flag is currently not enabled by default. Please let us know if you suspect this causes wrong behavior in your application.</p></li>
-
-<li>
-<p>By default user management operations require the specific user mgt related permission that has been introduced with OAK-1.0. This behavior can be turned off by setting the corresponding configuration flag.</p></li>
-
-<li>
-<p>As of OAK reading and writing items in the version store does not follow the regular permission evaluation but depends on access rights present on the corresponding versionable node <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-444">OAK-444</a>.</p></li>
-</ul></div>
-<div class="section">
-<h2>Privilege Management<a name="Privilege_Management"></a></h2>
-<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-910">OAK-910</a> for a general overview of changes with respect to Jackrabbit 2.</p></div>
-<div class="section">
-<h2>User Management<a name="User_Management"></a></h2>
-<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-791">OAK-791</a> for a general overview of changes with respect to Jackrabbit 2.</p></div>
-<div class="section">
-<h2>Principal Management<a name="Principal_Management"></a></h2>
-<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-909">OAK-909</a> for a general overview of changes with respect to Jackrabbit 2.</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 <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">OAK-14</a> and its sub-tasks.</p>
-
-<ul>
-
-<li>Locking:
-
-<ul>
-
-<li>Locking and unlocking of nodes is not implemented yet. You will not see an exception as long as the <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-193">TODO</a>-flag prevents the implementation from throwing UnsupportedOperationException, but the node <i>will not</i> be locked. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-150">OAK-150</a></li>
- </ul></li>
-</ul>
-
-<ul>
-
-<li>Versioning <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-168">OAK-168</a>:
-
-<ul>
-
-<li><tt>VersionHistory#removeVersion()</tt> is not implemented yet</li>
-
-<li><tt>VersionManager#merge()</tt> is not implemented yet</li>
-
-<li><tt>VersionManager#restore()</tt> with version-array is not implemented yet</li>
-
-<li>Activities are not implemented</li>
-
-<li>Configurations are not implemented</li>
- </ul></li>
-</ul>
-
-<ul>
-
-<li>Query:
-
-<ul>
-
-<li>Known issue with OR statements in full text queries See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-902">OAK-902</a></li>
- </ul></li>
-</ul>
-
-<ul>
-
-<li>Workspace Operations:
-
-<ul>
-
-<li>Cross workspace operations are not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-916">OAK-916</a></li>
-
-<li>Workspace Management (creating/deleting workspaces) is not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-916">OAK-916</a></li>
-
-<li><tt>Workspace#copy()</tt> is not properly implemented See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-917">OAK-917</a> and sub tasks
-
-<ul>
-
-<li>copy of versionable nodes does not create new version history See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-918">OAK-918</a></li>
-
-<li>copy of locked nodes does not remove the lock See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-919">OAK-919</a></li>
-
-<li>copy of trees with limited read access See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-920">OAK-920</a></li>
- </ul></li>
- </ul></li>
-</ul>
-
-<ul>
-
-<li>Access Control Management and Permissions:
-
-<ul>
-
-<li>Move operations are not properly handled wrt. permissions See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-710">OAK-710</a></li>
- </ul></li>
-</ul>
-
-<ul>
-
-<li>User Management:
-
-<ul>
-
-<li>Group membership stored in tree structure is not yet implemented See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-482">OAK-482</a></li>
- </ul></li>
-</ul>
-<p>In some cases Oak throws Runtime exceptions instead of a properly typed exception. We are working on correcting this. Please do not work around this by adapting catch clauses in your application.</p></div>
- </div>
- </div>
- </div>
-
- <hr/>
-
- <footer>
- <div class="container-fluid">
- <div class="row span12">Copyright © 2012-2013
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All Rights Reserved.
-
- </div>
-
-
-
-
-
-
- <div id="ohloh" class="pull-right">
- <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
- </div>
- </div>
- </footer>
- </body>
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2013-10-15
+ | Rendered using Apache Maven Fluido Skin 1.3.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="Date-Revision-yyyymmdd" content="20131015" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Jackrabbit Oak - </title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
+ <link rel="stylesheet" href="./css/site.css" />
+ <link rel="stylesheet" href="./css/print.css" media="print" />
+
+
+ <script type="text/javascript" src="./js/apache-maven-fluido-1.3.0.min.js"></script>
+
+
+ </head>
+ <body class="topBarEnabled">
+
+
+
+
+
+
+ <a href="http://github.com/apache/jackrabbit-oak">
+ <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+ src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+ alt="Fork me on GitHub">
+ </a>
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container-fluid">
+ <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="index.html" title="Jackrabbit Oak">Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="license.html" title="License">License</a>
+</li>
+
+ <li> <a href="downloads.html" title="Downloads">Downloads</a>
+</li>
+
+ <li> <a href="from_here.html" title="From here">From here</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="nodestate.html" title="Understanding the node state model">Understanding the node state model</a>
+</li>
+
+ <li> <a href="microkernel.html" title="Microkernel">Microkernel</a>
+</li>
+
+ <li> <a href="query.html" title="Query">Query</a>
+</li>
+
+ <li> <a href="blobstore.html" title="BlobStore">BlobStore</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="use_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="differences.html" title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+
+ <li> <a href="dos_and_donts.html" title="Dos and don'ts">Dos and don'ts</a>
+</li>
+
+ <li> <a href="when_things_go_wrong.html" title="When things go wrong">When things go wrong</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="dev_getting_started.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="participating.html" title="Participating">Participating</a>
+</li>
+
+ <li> <a href="apidocs/index.html" title="API docs">API docs</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://jackrabbit.apache.org/oak" title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
+</li>
+
+ <li> <a href="http://jackrabbit.apache.org/" title="Apache Jackrabbit">Apache Jackrabbit</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <div id="bannerLeft">
+ <h2>Oak Documentation</h2>
+ </div>
+ </div>
+ <div class="pull-right"> </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li id="publishDate">Last Published: 2013-10-15</li>
+ <li class="divider">|</li> <li id="projectVersion">Version: 0.11-SNAPSHOT</li>
+
+
+
+
+ </ul>
+ </div>
+
+
+ <div class="row-fluid">
+ <div id="leftColumn" class="span3">
+ <div class="well sidebar-nav">
+
+
+ <ul class="nav nav-list">
+ <li class="nav-header">Overview</li>
+
+ <li>
+
+ <a href="index.html" title="Jackrabbit Oak">
+ <i class="none"></i>
+ Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="license.html" title="License">
+ <i class="none"></i>
+ License</a>
+ </li>
+
+ <li>
+
+ <a href="downloads.html" title="Downloads">
+ <i class="none"></i>
+ Downloads</a>
+ </li>
+
+ <li>
+
+ <a href="from_here.html" title="From here">
+ <i class="none"></i>
+ From here</a>
+ </li>
+ <li class="nav-header">Concepts and architecture</li>
+
+ <li>
+
+ <a href="overview.html" title="Overview">
+ <i class="none"></i>
+ Overview</a>
+ </li>
+
+ <li>
+
+ <a href="nodestate.html" title="Understanding the node state model">
+ <i class="none"></i>
+ Understanding the node state model</a>
+ </li>
+
+ <li>
+
+ <a href="microkernel.html" title="Microkernel">
+ <i class="none"></i>
+ Microkernel</a>
+ </li>
+
+ <li>
+
+ <a href="query.html" title="Query">
+ <i class="none"></i>
+ Query</a>
+ </li>
+
+ <li>
+
+ <a href="blobstore.html" title="BlobStore">
+ <i class="none"></i>
+ BlobStore</a>
+ </li>
+ <li class="nav-header">Using Oak</li>
+
+ <li>
+
+ <a href="use_getting_started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li class="active">
+
+ <a href="#"><i class="none"></i>Differences to Jackrabbit 2</a>
+ </li>
+
+ <li>
+
+ <a href="dos_and_donts.html" title="Dos and don'ts">
+ <i class="none"></i>
+ Dos and don'ts</a>
+ </li>
+
+ <li>
+
+ <a href="when_things_go_wrong.html" title="When things go wrong">
+ <i class="none"></i>
+ When things go wrong</a>
+ </li>
+ <li class="nav-header">Developing Oak</li>
+
+ <li>
+
+ <a href="dev_getting_started.html" title="Getting Started">
+ <i class="none"></i>
+ Getting Started</a>
+ </li>
+
+ <li>
+
+ <a href="participating.html" title="Participating">
+ <i class="none"></i>
+ Participating</a>
+ </li>
+
+ <li>
+
+ <a href="apidocs/index.html" title="API docs">
+ <i class="none"></i>
+ API docs</a>
+ </li>
+ <li class="nav-header">Links</li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
+ <i class="none"></i>
+ Apache Jackrabbit Oak</a>
+ </li>
+
+ <li>
+
+ <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
+ <i class="none"></i>
+ Apache Jackrabbit</a>
+ </li>
+ </ul>
+
+
+
+ <hr class="divider" />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-doc/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <div class="clear"></div>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
+ </a>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span9" >
+
+ <!-- Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. --><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>
+<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>Session state and refresh behaviour<a name="Session_state_and_refresh_behaviour"></a></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.</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>
+</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>
+<div class="section">
+<h2>Query<a name="Query"></a></h2>
+<p>Oak does not index content by default as does Jackrabbit 2. You need to create custom indexes when necessary, much like in traditional RDBMSs. If there is no index for a specific query then the repository will be traversed. That is, the query will still work but probably be very slow.</p>
+<p>See the <a href="query.html">query overview page</a> for how to create a custom index.</p></div>
+<div class="section">
+<h2>Observation<a name="Observation"></a></h2>
+<p>Regarding observation listeners:</p>
+
+<ul>
+
+<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>
+
+<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>.</p></li>
+
+<li>
+<p><tt>Event.NODE_MOVED</tt> is not supported. Instead <tt>Event.NODE_ADDED</tt> and <tt>Event.Node_REMOVED</tt> events are reported as long as they don’t cancel each other (e.g. in case of reordering of nodes).</p></li>
+</ul></div>
+<div class="section">
+<h2>Same name siblings<a name="Same_name_siblings"></a></h2>
+<p>Same name siblings (SNS) are deprecated in Oak. We figured that the actual benefit supporting same name siblings as mandated by JCR is dwarfed by the additional implementation complexity. Instead there are ideas to implement a feature for automatic <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-129">disambiguation of node names</a>.</p>
+<p>In the meanwhile we have <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-203">basic support</a> for same name siblings but that might not cover all cases.</p></div>
+<div class="section">
+<h2>Authentication<a name="Authentication"></a></h2>
+<p>Please refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-793">OAK-793</a> for a general overview of changes with respect to Jackrabbit 2.</p></div>
+<div class="section">
+<h2>Access Control Management<a name="Access_Control_Management"></a></h2>
+<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-792">OAK-792</a> for a general overview of changes with respect to Jackrabbit 2.</p>
+<p>The following modification are most likely to have an effect on existing applications:</p>
+
+<ul>
+
+<li><tt>AccessControlManager#hasPrivilege()</tt> and <tt>AccessControlManager#getPrivileges()</tt> will throw a <tt>PathNotFoundException</tt> if the node for the specified path is not accessible. The Jackrabbit 2 implementation is wrong and we fixed that in OAK (<a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-886">OAK-886</a>). If the new behaviour turns out to be a problem with existing applications we might consider adding backward compatible behaviour.</li>
+</ul></div>
+<div class="section">
+<h2>Permissions<a name="Permissions"></a></h2>
+<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-942">OAK-942</a> for a general overview of changes with respect to Jackrabbit 2.</p>
+
+<ul>
+
+<li>
+<p>As of Oak <tt>Node#remove()</tt> only requires sufficient permissions to remove the target node. In contrast to jackrabbit the validation will not traverse the tree and verify remove permission on all child nodes/properties. There exists a configuration flag that aims to produce best effort backwards compatibility but this flag is currently not enabled by default. Please let us know if you suspect this causes wrong behavior in your application.</p></li>
+
+<li>
+<p>By default user management operations require the specific user mgt related permission that has been introduced with OAK-1.0. This behavior can be turned off by setting the corresponding configuration flag.</p></li>
+
+<li>
+<p>As of OAK reading and writing items in the version store does not follow the regular permission evaluation but depends on access rights present on the corresponding versionable node <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-444">OAK-444</a>.</p></li>
+</ul></div>
+<div class="section">
+<h2>Privilege Management<a name="Privilege_Management"></a></h2>
+<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-910">OAK-910</a> for a general overview of changes with respect to Jackrabbit 2.</p></div>
+<div class="section">
+<h2>User Management<a name="User_Management"></a></h2>
+<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-791">OAK-791</a> for a general overview of changes with respect to Jackrabbit 2.</p></div>
+<div class="section">
+<h2>Principal Management<a name="Principal_Management"></a></h2>
+<p>Refer to <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-909">OAK-909</a> for a general overview of changes with respect to Jackrabbit 2.</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 <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-14">OAK-14</a> and its sub-tasks.</p>
+
+<ul>
+
+<li>Locking:
+
+<ul>
+
+<li>Locking and unlocking of nodes is not implemented yet. You will not see an exception as long as the <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-193">TODO</a>-flag prevents the implementation from throwing UnsupportedOperationException, but the node <i>will not</i> be locked. See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-150">OAK-150</a></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>Versioning <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-168">OAK-168</a>:
+
+<ul>
+
+<li><tt>VersionHistory#removeVersion()</tt> is not implemented yet</li>
+
+<li><tt>VersionManager#merge()</tt> is not implemented yet</li>
+
+<li><tt>VersionManager#restore()</tt> with version-array is not implemented yet</li>
+
+<li>Activities are not implemented</li>
+
+<li>Configurations are not implemented</li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>Query:
+
+<ul>
+
+<li>Known issue with OR statements in full text queries See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-902">OAK-902</a></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>Workspace Operations:
+
+<ul>
+
+<li>Cross workspace operations are not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-916">OAK-916</a></li>
+
+<li>Workspace Management (creating/deleting workspaces) is not implemented yet See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-916">OAK-916</a></li>
+
+<li><tt>Workspace#copy()</tt> is not properly implemented See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-917">OAK-917</a> and sub tasks
+
+<ul>
+
+<li>copy of versionable nodes does not create new version history See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-918">OAK-918</a></li>
+
+<li>copy of locked nodes does not remove the lock See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-919">OAK-919</a></li>
+
+<li>copy of trees with limited read access See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-920">OAK-920</a></li>
+ </ul></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>Access Control Management and Permissions:
+
+<ul>
+
+<li>Move operations are not properly handled wrt. permissions See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-710">OAK-710</a></li>
+ </ul></li>
+</ul>
+
+<ul>
+
+<li>User Management:
+
+<ul>
+
+<li>Group membership stored in tree structure is not yet implemented See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-482">OAK-482</a></li>
+ </ul></li>
+</ul>
+<p>In some cases Oak throws Runtime exceptions instead of a properly typed exception. We are working on correcting this. Please do not work around this by adapting catch clauses in your application.</p></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row span12">Copyright © 2012-2013
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All Rights Reserved.
+
+ </div>
+
+
+
+
+
+
+ <div id="ohloh" class="pull-right">
+ <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
+ </div>
+ </div>
+ </footer>
+ </body>
</html>
\ No newline at end of file