jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mdue...@apache.org
Subject svn commit: r1594576 [8/8] - in /jackrabbit/site/live/oak/docs: ./ security/ security/accesscontrol/ security/authentication/ security/permission/ security/principal/ security/privilege/ security/user/
Date Wed, 14 May 2014 13:30:14 GMT
Added: jackrabbit/site/live/oak/docs/security/user/differences.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/security/user/differences.html?rev=1594576&view=auto
==============================================================================
--- jackrabbit/site/live/oak/docs/security/user/differences.html (added)
+++ jackrabbit/site/live/oak/docs/security/user/differences.html Wed May 14 13:30:13 2014
@@ -0,0 +1,538 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-05-14
+ | 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="20140514" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Jackrabbit Oak - User Management : Differences to Jackrabbit 2.x</title>
+    <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
+    <link rel="stylesheet" href="../../css/site.css" />
+    <link rel="stylesheet" href="../../css/print.css" media="print" />
+
+      
+    <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+    
+            </head>
+        <body class="topBarEnabled">
+          
+    
+    
+            
+    
+    
+    <a href="http://github.com/apache/jackrabbit-oak">
+      <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+        src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+        alt="Fork me on GitHub">
+    </a>
+  
+                
+                    
+                
+
+    <div id="topbar" class="navbar navbar-fixed-top ">
+      <div class="navbar-inner">
+                <div class="container-fluid">
+        <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </a>
+                
+                                <ul class="nav">
+                          <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../index.html"  title="Jackrabbit Oak">Jackrabbit Oak</a>
+</li>
+                  
+                      <li>      <a href="../../license.html"  title="License">License</a>
+</li>
+                  
+                      <li>      <a href="../../downloads.html"  title="Downloads">Downloads</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../overview.html"  title="Overview">Overview</a>
+</li>
+                  
+                      <li>      <a href="../../nodestate.html"  title="The node state model">The node state model</a>
+</li>
+                  
+                      <li>      <a href="../../microkernel.html"  title="NodeStore and MicroKernel">NodeStore and MicroKernel</a>
+</li>
+                  
+                      <li>      <a href="../../query.html"  title="Query">Query</a>
+</li>
+                  
+                      <li>      <a href="../../blobstore.html"  title="BlobStore">BlobStore</a>
+</li>
+                  
+                      <li>      <a href="../../security/overview.html"  title="Security">Security</a>
+</li>
+                  
+                      <li>      <a href="../../clustering.html"  title="Clustering">Clustering</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../use_getting_started.html"  title="Getting Started">Getting Started</a>
+</li>
+                  
+                      <li>      <a href="../../construct.html"  title="Repository construction">Repository construction</a>
+</li>
+                  
+                      <li>      <a href="../../osgi_config.html"  title="Configuring Oak">Configuring Oak</a>
+</li>
+                  
+                      <li>      <a href="../../differences.html"  title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+                  
+                      <li>      <a href="../../known_issues.html"  title="Known Issues">Known Issues</a>
+</li>
+                  
+                      <li>      <a href="../../dos_and_donts.html"  title="Dos and don'ts">Dos and don'ts</a>
+</li>
+                  
+                      <li>      <a href="../../FAQ.html"  title="FAQ">FAQ</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../dev_getting_started.html"  title="Getting Started">Getting Started</a>
+</li>
+                  
+                      <li>      <a href="../../participating.html"  title="Participating">Participating</a>
+</li>
+                  
+                      <li>      <a href="../../apidocs/index.html"  title="API docs">API docs</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="http://jackrabbit.apache.org/oak"  title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
+</li>
+                  
+                      <li>      <a href="http://jackrabbit.apache.org/"  title="Apache Jackrabbit">Apache Jackrabbit</a>
+</li>
+                          </ul>
+      </li>
+                  </ul>
+          
+          
+          
+                   
+                      </div>
+          
+        </div>
+      </div>
+    </div>
+    
+        <div class="container-fluid">
+          <div id="banner">
+        <div class="pull-left">
+                                <div id="bannerLeft">
+                <h2>Oak Documentation</h2>
+                </div>
+                      </div>
+        <div class="pull-right">  </div>
+        <div class="clear"><hr/></div>
+      </div>
+
+      <div id="breadcrumbs">
+        <ul class="breadcrumb">
+                
+                    
+                  <li id="publishDate">Last Published: 2014-05-14</li>
+                  <li class="divider">|</li> <li id="projectVersion">Version: 0.20-SNAPSHOT</li>
+                      
+                
+                    
+      
+                            </ul>
+      </div>
+
+            
+      <div class="row-fluid">
+        <div id="leftColumn" class="span3">
+          <div class="well sidebar-nav">
+                
+                    
+                <ul class="nav nav-list">
+                    <li class="nav-header">Overview</li>
+                                
+      <li>
+    
+                          <a href="../../index.html" title="Jackrabbit Oak">
+          <i class="none"></i>
+        Jackrabbit Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../license.html" title="License">
+          <i class="none"></i>
+        License</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../downloads.html" title="Downloads">
+          <i class="none"></i>
+        Downloads</a>
+            </li>
+                              <li class="nav-header">Concepts and architecture</li>
+                                
+      <li>
+    
+                          <a href="../../overview.html" title="Overview">
+          <i class="none"></i>
+        Overview</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../nodestate.html" title="The node state model">
+          <i class="none"></i>
+        The node state model</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../microkernel.html" title="NodeStore and MicroKernel">
+          <i class="none"></i>
+        NodeStore and 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>
+    
+                          <a href="../../security/overview.html" title="Security">
+          <i class="none"></i>
+        Security</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../clustering.html" title="Clustering">
+          <i class="none"></i>
+        Clustering</a>
+            </li>
+                              <li class="nav-header">Using Oak</li>
+                                
+      <li>
+    
+                          <a href="../../use_getting_started.html" title="Getting Started">
+          <i class="none"></i>
+        Getting Started</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../construct.html" title="Repository construction">
+          <i class="none"></i>
+        Repository construction</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../osgi_config.html" title="Configuring Oak">
+          <i class="none"></i>
+        Configuring Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../differences.html" title="Differences to Jackrabbit 2">
+          <i class="none"></i>
+        Differences to Jackrabbit 2</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../known_issues.html" title="Known Issues">
+          <i class="none"></i>
+        Known Issues</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../dos_and_donts.html" title="Dos and don'ts">
+          <i class="none"></i>
+        Dos and don'ts</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../FAQ.html" title="FAQ">
+          <i class="none"></i>
+        FAQ</a>
+            </li>
+                              <li class="nav-header">Developing Oak</li>
+                                
+      <li>
+    
+                          <a href="../../dev_getting_started.html" title="Getting Started">
+          <i class="none"></i>
+        Getting Started</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../participating.html" title="Participating">
+          <i class="none"></i>
+        Participating</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../apidocs/index.html" title="API docs">
+          <i class="none"></i>
+        API docs</a>
+            </li>
+                              <li class="nav-header">Links</li>
+                                
+      <li>
+    
+                          <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
+          <i class="none"></i>
+        Apache Jackrabbit Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
+          <i class="none"></i>
+        Apache Jackrabbit</a>
+            </li>
+            </ul>
+                
+                    
+                
+          <hr class="divider" />
+
+           <div id="poweredBy">
+                   
+    <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+    
+    <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-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">
+<div class="section">
+<h3>User Management : Differences to Jackrabbit 2.x<a name="User_Management_:_Differences_to_Jackrabbit_2.x"></a></h3>
+<p>The default user management implementation present has the following characteristics that differ from the default behavior in Jackrabbit 2.x</p>
+<div class="section">
+<h4>General<a name="General"></a></h4>
+
+<ul>
+  
+<li>changes made to the user management API are always transient and require <tt>Session#save()</tt> to be persisted.</li>
+  
+<li>In case of a failure <tt>Session#refresh</tt> is no longer called in order to prevent reverting other changes unrelated to the user management operation. Consequently it&#x2019;s the responsibility of the API consumer to specifically revert pending or invalid transient modifications.</li>
+</ul></div>
+<div class="section">
+<h4>UserManager<a name="UserManager"></a></h4>
+
+<ul>
+  
+<li>stores user/group information in the workspace associated with the editing Session</li>
+  
+<li>the autosave feature is no longer supported by default; configuration option  <tt>PARAM_SUPPORT_AUTOSAVE</tt> can be used to obtain backwards compatible behavior.</li>
+</ul></div>
+<div class="section">
+<h4>Authorizable<a name="Authorizable"></a></h4>
+
+<ul>
+  
+<li>Equality and HashCode : the implementation of <tt>Object#equals()</tt> and <tt>Object#hashCode()</tt> for  authorizables differs from Jackrabbit 2.x. It no longer relies on the <i>sameness</i> of  the underlaying JCR node but only compares IDs and the user manager instance.</li>
+  
+<li>Authorizable ID: the ID of authorizables is stored separately in a <tt>rep:authorizableId</tt> property.  This value is returned upon <tt>Authorizable#getID</tt>. For backwards compatibility  it falls back on the node name in case the ID property is missing.</li>
+  
+<li>Node Name: The name of the authorizable node is generated based on a configurable implementation  of the <tt>AuthorizableNodeName</tt> interface. Default: ID as name hint.</li>
+</ul></div>
+<div class="section">
+<h4>User<a name="User"></a></h4>
+
+<ul>
+  
+<li>Creation: The password is no longer mandatory upon user creation.</li>
+</ul></div>
+<div class="section">
+<h4>Group<a name="Group"></a></h4>
+
+<ul>
+  
+<li>Creation: <tt>createGroup(Principal)</tt> will no longer generate a groupID in case the principal  name collides with an existing user or group ID. This has been considered redundant  as the Jackrabbit API in the mean time added <tt>UserManager#createGroup(String groupID)</tt>.</li>
+  
+<li>Group Members: The way many group members are stored with a given Group has been redesigned  in Oak 1.0. See section <a href="membership.html">Group Membership</a> for a detailed description.</li>
+</ul></div>
+<div class="section">
+<h4>Query<a name="Query"></a></h4>
+<p>The user query is expected to work as in Jackrabbit 2.x. See section <a href="query.html">Searching Users and Groups</a> for a list of bug fixes.</p></div>
+<div class="section">
+<h4>XML Import<a name="XML_Import"></a></h4>
+
+<ul>
+  
+<li>Importing an authorizable to another tree than the configured user/group node will only failed upon save (-&gt; see <tt>UserValidator</tt> during the <tt>Root#commit</tt>). With Jackrabbit 2.x core it used to fail immediately.</li>
+  
+<li>The <tt>BestEffort</tt> behavior is now also implemented for the import of impersonators (was missing in Jackrabbit /2.x).</li>
+  
+<li>Oak also supports workspace import for authorizables</li>
+</ul></div>
+<div class="section">
+<h4>Builtin Users and the Everyone Group<a name="Builtin_Users_and_the_Everyone_Group"></a></h4>
+
+<ul>
+  
+<li>admin user can be initialized without password (<tt>PARAM_OMIT_ADMIN_PW</tt> config option)</li>
+  
+<li>anonymous user is optional (missing <tt>PARAM_ANONYMOUS_ID</tt> config option)</li>
+  
+<li>anonymous user is always initialized without password.</li>
+  
+<li>the implementation of the everyone group is consistent throughout all group  membership related methods.</li>
+</ul></div>
+<div class="section">
+<h4>Authorizable Actions<a name="Authorizable_Actions"></a></h4>
+<p>The former internal interface <tt>AuthorizableAction</tt> has been slightly adjusted to match OAK requirements and is now part of the public OAK SPI interfaces.</p>
+<p>See the corresponding <a href="authorizableaction.html">section</a> for details.</p></div>
+<div class="section">
+<h4>Node Type Definitions<a name="Node_Type_Definitions"></a></h4>
+<p>The built-in node types related to user management tasks have been modified as follows.</p>
+
+<ul>
+  
+<li><i>rep:Authorizable</i>
+  
+<ul>
+    
+<li>new protected property <tt>rep:authorizableId</tt></li>
+  </ul></li>
+  
+<li><i>rep:Group</i>
+  
+<ul>
+    
+<li>extends from <tt>rep:MemberReferences</tt> which provides the multivalued property <tt>rep:members</tt></li>
+    
+<li>the child node definition <tt>rep:members</tt> has been deprecated and is no longer used</li>
+    
+<li>new child node definition <tt>rep:membersList</tt></li>
+  </ul></li>
+</ul>
+<p>The following node type definitions have been added:</p>
+
+<ul>
+  
+<li><i>rep:MemberReferences</i> : provides the multivalued <tt>rep:members</tt> property.</li>
+  
+<li><i>rep:MemberReferencesList</i></li>
+</ul>
+<p>The following node type definition has been deprecated and will no longer be used:</p>
+
+<ul>
+  
+<li><i>rep:Members</i></li>
+</ul></div>
+<div class="section">
+<h4>Configuration<a name="Configuration"></a></h4>
+<p>The following configuration parameters present with the default implementation in Jackrabbit 2.x are no longer supported and will be ignored:</p>
+
+<ul>
+  
+<li>&#x201c;compatibleJR16&#x201d;</li>
+  
+<li>&#x201c;autoExpandTree&#x201d;</li>
+  
+<li>&#x201c;autoExpandSize&#x201d;</li>
+  
+<li>&#x201c;groupMembershipSplitSize&#x201d;</li>
+</ul>
+<!-- hidden references --></div></div></div>
+                  </div>
+            </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+              <div class="row span12">Copyright &copy;                    2012-2014
+                        <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+            All Rights Reserved.      
+                    
+      </div>
+
+        
+        
+          
+    
+    
+    <div id="ohloh" class="pull-right">
+      <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
+    </div>
+        </div>
+    </footer>
+  </body>
+</html>
\ No newline at end of file

Added: jackrabbit/site/live/oak/docs/security/user/membership.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/security/user/membership.html?rev=1594576&view=auto
==============================================================================
--- jackrabbit/site/live/oak/docs/security/user/membership.html (added)
+++ jackrabbit/site/live/oak/docs/security/user/membership.html Wed May 14 13:30:13 2014
@@ -0,0 +1,525 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-05-14
+ | 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="20140514" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Jackrabbit Oak - Group Membership</title>
+    <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
+    <link rel="stylesheet" href="../../css/site.css" />
+    <link rel="stylesheet" href="../../css/print.css" media="print" />
+
+      
+    <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+    
+            </head>
+        <body class="topBarEnabled">
+          
+    
+    
+            
+    
+    
+    <a href="http://github.com/apache/jackrabbit-oak">
+      <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+        src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+        alt="Fork me on GitHub">
+    </a>
+  
+                
+                    
+                
+
+    <div id="topbar" class="navbar navbar-fixed-top ">
+      <div class="navbar-inner">
+                <div class="container-fluid">
+        <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </a>
+                
+                                <ul class="nav">
+                          <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../index.html"  title="Jackrabbit Oak">Jackrabbit Oak</a>
+</li>
+                  
+                      <li>      <a href="../../license.html"  title="License">License</a>
+</li>
+                  
+                      <li>      <a href="../../downloads.html"  title="Downloads">Downloads</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../overview.html"  title="Overview">Overview</a>
+</li>
+                  
+                      <li>      <a href="../../nodestate.html"  title="The node state model">The node state model</a>
+</li>
+                  
+                      <li>      <a href="../../microkernel.html"  title="NodeStore and MicroKernel">NodeStore and MicroKernel</a>
+</li>
+                  
+                      <li>      <a href="../../query.html"  title="Query">Query</a>
+</li>
+                  
+                      <li>      <a href="../../blobstore.html"  title="BlobStore">BlobStore</a>
+</li>
+                  
+                      <li>      <a href="../../security/overview.html"  title="Security">Security</a>
+</li>
+                  
+                      <li>      <a href="../../clustering.html"  title="Clustering">Clustering</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../use_getting_started.html"  title="Getting Started">Getting Started</a>
+</li>
+                  
+                      <li>      <a href="../../construct.html"  title="Repository construction">Repository construction</a>
+</li>
+                  
+                      <li>      <a href="../../osgi_config.html"  title="Configuring Oak">Configuring Oak</a>
+</li>
+                  
+                      <li>      <a href="../../differences.html"  title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+                  
+                      <li>      <a href="../../known_issues.html"  title="Known Issues">Known Issues</a>
+</li>
+                  
+                      <li>      <a href="../../dos_and_donts.html"  title="Dos and don'ts">Dos and don'ts</a>
+</li>
+                  
+                      <li>      <a href="../../FAQ.html"  title="FAQ">FAQ</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../dev_getting_started.html"  title="Getting Started">Getting Started</a>
+</li>
+                  
+                      <li>      <a href="../../participating.html"  title="Participating">Participating</a>
+</li>
+                  
+                      <li>      <a href="../../apidocs/index.html"  title="API docs">API docs</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="http://jackrabbit.apache.org/oak"  title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
+</li>
+                  
+                      <li>      <a href="http://jackrabbit.apache.org/"  title="Apache Jackrabbit">Apache Jackrabbit</a>
+</li>
+                          </ul>
+      </li>
+                  </ul>
+          
+          
+          
+                   
+                      </div>
+          
+        </div>
+      </div>
+    </div>
+    
+        <div class="container-fluid">
+          <div id="banner">
+        <div class="pull-left">
+                                <div id="bannerLeft">
+                <h2>Oak Documentation</h2>
+                </div>
+                      </div>
+        <div class="pull-right">  </div>
+        <div class="clear"><hr/></div>
+      </div>
+
+      <div id="breadcrumbs">
+        <ul class="breadcrumb">
+                
+                    
+                  <li id="publishDate">Last Published: 2014-05-14</li>
+                  <li class="divider">|</li> <li id="projectVersion">Version: 0.20-SNAPSHOT</li>
+                      
+                
+                    
+      
+                            </ul>
+      </div>
+
+            
+      <div class="row-fluid">
+        <div id="leftColumn" class="span3">
+          <div class="well sidebar-nav">
+                
+                    
+                <ul class="nav nav-list">
+                    <li class="nav-header">Overview</li>
+                                
+      <li>
+    
+                          <a href="../../index.html" title="Jackrabbit Oak">
+          <i class="none"></i>
+        Jackrabbit Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../license.html" title="License">
+          <i class="none"></i>
+        License</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../downloads.html" title="Downloads">
+          <i class="none"></i>
+        Downloads</a>
+            </li>
+                              <li class="nav-header">Concepts and architecture</li>
+                                
+      <li>
+    
+                          <a href="../../overview.html" title="Overview">
+          <i class="none"></i>
+        Overview</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../nodestate.html" title="The node state model">
+          <i class="none"></i>
+        The node state model</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../microkernel.html" title="NodeStore and MicroKernel">
+          <i class="none"></i>
+        NodeStore and 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>
+    
+                          <a href="../../security/overview.html" title="Security">
+          <i class="none"></i>
+        Security</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../clustering.html" title="Clustering">
+          <i class="none"></i>
+        Clustering</a>
+            </li>
+                              <li class="nav-header">Using Oak</li>
+                                
+      <li>
+    
+                          <a href="../../use_getting_started.html" title="Getting Started">
+          <i class="none"></i>
+        Getting Started</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../construct.html" title="Repository construction">
+          <i class="none"></i>
+        Repository construction</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../osgi_config.html" title="Configuring Oak">
+          <i class="none"></i>
+        Configuring Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../differences.html" title="Differences to Jackrabbit 2">
+          <i class="none"></i>
+        Differences to Jackrabbit 2</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../known_issues.html" title="Known Issues">
+          <i class="none"></i>
+        Known Issues</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../dos_and_donts.html" title="Dos and don'ts">
+          <i class="none"></i>
+        Dos and don'ts</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../FAQ.html" title="FAQ">
+          <i class="none"></i>
+        FAQ</a>
+            </li>
+                              <li class="nav-header">Developing Oak</li>
+                                
+      <li>
+    
+                          <a href="../../dev_getting_started.html" title="Getting Started">
+          <i class="none"></i>
+        Getting Started</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../participating.html" title="Participating">
+          <i class="none"></i>
+        Participating</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../apidocs/index.html" title="API docs">
+          <i class="none"></i>
+        API docs</a>
+            </li>
+                              <li class="nav-header">Links</li>
+                                
+      <li>
+    
+                          <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
+          <i class="none"></i>
+        Apache Jackrabbit Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
+          <i class="none"></i>
+        Apache Jackrabbit</a>
+            </li>
+            </ul>
+                
+                    
+                
+          <hr class="divider" />
+
+           <div id="poweredBy">
+                   
+    <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+    
+    <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-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>Group Membership<a name="Group_Membership"></a></h2>
+<div class="section">
+<h3>Jackrabbit API<a name="Jackrabbit_API"></a></h3>
+<p>The Jackrabbit API extensions provide various methods to edit and explore the member relationship of users and groups:</p>
+
+<ul>
+  
+<li>
+<p><a class="externalLink" href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Group.java">org.apache.jackrabbit.api.security.user.Group</a></p>
+  
+<ul>
+    
+<li><tt>getDeclaredMembers() Iterator&lt;Authorizable&gt;</tt></li>
+    
+<li><tt>getMembers() Iterator&lt;Authorizable&gt;</tt></li>
+    
+<li><tt>isDeclaredMember(Authorizable) boolean</tt></li>
+    
+<li><tt>isMember(Authorizable boolean</tt></li>
+    
+<li><tt>addMember(Authorizable) boolean</tt></li>
+    
+<li><tt>removeMember(Authorizable) boolen</tt></li>
+  </ul></li>
+  
+<li>
+<p><a class="externalLink" href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Authorizable.java">org.apache.jackrabbit.api.security.user.Authorizable</a></p>
+  
+<ul>
+    
+<li><tt>declaredMemberOf() Iterator&lt;Group&gt;</tt></li>
+    
+<li><tt>memberOf() Iterator&lt;Group&gt;</tt></li>
+  </ul></li>
+</ul></div>
+<div class="section">
+<h3>Characteristics of the Default Implementation<a name="Characteristics_of_the_Default_Implementation"></a></h3>
+<div class="section">
+<h4>Member Representation in the Repository<a name="Member_Representation_in_the_Repository"></a></h4>
+<div class="section">
+<h5>Behavior in Jackrabbit 2.x<a name="Behavior_in_Jackrabbit_2.x"></a></h5>
+<p>With the default configuration Jackrabbit 2.x stores the group members as <i>weak references</i> in a <tt>rep:members</tt> multi value property in the group node. If the <tt>groupMembershipSplitSize</tt> configuration parameter is set and valid, the group memberships are collected in a node structure below <tt>rep:members</tt> instead of the default multi valued property. Its value determines the maximum number of member properties until additional intermediate nodes are inserted. Valid parameter values are integers &gt; 4. The node structure is a balanced b-tree where only the leave nodes carry the actual values in residual properties which name is the principal name of the member.</p></div>
+<div class="section">
+<h5>Behavior as of OAK 1.0<a name="Behavior_as_of_OAK_1.0"></a></h5>
+<p>As of Oak the user manager automatically chooses an appropriate storage structure depending on the number of group members. If the number of members is low they are stored as <i>weak references</i> in a <tt>rep:members</tt> multi value property. This is similar to Jackrabbit 2.x. If the number of members is high the user manager will limit the size of the multi value properties and create overflow <tt>rep:MemberReferences</tt> nodes below a <tt>rep:membersList</tt> node to hold the extra members.</p></div>
+<div class="section">
+<h5>Relevant new and modified node types<a name="Relevant_new_and_modified_node_types"></a></h5>
+
+<div class="source">
+<pre>[rep:Group] &gt; rep:Authorizable, rep:MemberReferences
+  + rep:members (rep:Members) = rep:Members multiple protected VERSION /* @deprecated */
+  + rep:membersList (rep:MemberReferencesList) = rep:MemberReferencesList protected COPY
+
+[rep:MemberReferences]
+  - rep:members (WEAKREFERENCE) protected multiple &lt; 'rep:Authorizable'
+
+[rep:MemberReferencesList]
+  + * (rep:MemberReferences) = rep:MemberReferences protected COPY
+</pre></div></div>
+<div class="section">
+<h5>Example Group with few members<a name="Example_Group_with_few_members"></a></h5>
+<p><i>(irrelevant properties excluded)</i></p>
+
+<div class="source">
+<pre>{
+    &quot;jcr:primaryType&quot;: &quot;rep:Group&quot;,
+    &quot;rep:principalName&quot;: &quot;contributor&quot;,
+    &quot;rep:members&quot;: [
+        &quot;429bbd5b-46a6-3c3d-808b-5fd4219d5c4d&quot;,
+        &quot;ca58c408-fe06-357e-953c-2d23ffe1e096&quot;,
+        &quot;3ebb1c04-76dd-317e-a9ee-5164182bc390&quot;,
+        &quot;d3c827d3-4db2-30cc-9c41-0ed8117dbaff&quot;,
+        &quot;f5777a0b-a933-3b4d-9405-613d8bc39cc7&quot;,
+        &quot;fdd1547a-b19a-3154-90da-1eae8c2c3504&quot;,
+        &quot;65c3084e-abfc-3719-8223-72c6cb9a3d6f&quot;
+    ]
+}
+</pre></div></div>
+<div class="section">
+<h5>Example Group with many members<a name="Example_Group_with_many_members"></a></h5>
+<p><i>(irrelevant properties excluded)</i></p>
+
+<div class="source">
+<pre>{
+    &quot;jcr:primaryType&quot;: &quot;rep:Group&quot;,
+    &quot;rep:principalName&quot;: &quot;employees&quot;,
+    &quot;rep:membersList&quot;: {
+        &quot;jcr:primaryType&quot;: &quot;rep:MemberReferencesList&quot;,
+        &quot;0&quot;: {
+            &quot;jcr:primaryType&quot;: &quot;rep:MemberReferences&quot;,
+            &quot;rep:members&quot;: [
+                &quot;429bbd5b-46a6-3c3d-808b-5fd4219d5c4d&quot;,
+                &quot;ca58c408-fe06-357e-953c-2d23ffe1e096&quot;,
+                ...
+            ]
+        },
+        ...
+        &quot;341&quot;: {
+            &quot;jcr:primaryType&quot;: &quot;rep:MemberReferences&quot;,
+            &quot;rep:members&quot;: [
+                &quot;fdd1547a-b19a-3154-90da-1eae8c2c3504&quot;,
+                &quot;65c3084e-abfc-3719-8223-72c6cb9a3d6f&quot;,
+                ...
+            ]
+        }
+    }
+}
+</pre></div>
+<p><i>Note</i>: The exact threshold value that determines the storage strategy is an implementation detail and might even vary depending on the underlying persistence layer. In Oak 1.0 the threshold value is set to 100.</p></div></div>
+<div class="section">
+<h4>Upgrading Groups from Jackrabbit 2.x to Oak content structure<a name="Upgrading_Groups_from_Jackrabbit_2.x_to_Oak_content_structure"></a></h4>
+<p>Upon upgrade from a Jackrabbit 2.x repository to OAK the group member lists that adjusted to reflect the new content structure as created by the OAK user management implementation; this means that the group member node structure will be changed by the migration process. Applications that rely on these implementation details of Jackrabbit 2.x user management instead of use the corresponding API calls will need to be modified accordingly.</p></div>
+<div class="section">
+<h4>XML Import of Group Members<a name="XML_Import_of_Group_Members"></a></h4>
+<p>Importing group members through the import methods in <tt>javax.jcr.Session</tt> or <tt>javax.jcr.Workspace</tt> is storage agnostic and supports both, property based and node based, strategies and is backward compatible to content exported from Jackrabbit 2.x. The group member lists that are modified during an import are internally processed using the normal user manager APIs. This implies that the node structure after the import might not be the same as the one represented in the input.</p></div></div>
+<div class="section">
+<h3>Configuration<a name="Configuration"></a></h3>
+<p>Note that as of Oak 1.0 the implementation is responsible for defining the content structure and will expand the multi-valued <tt>rep:members</tt> property accordingly. Consequently, the following configuration option <tt>groupMembershipSplitSize</tt> present with Jackrabbit 2.x is not supported anymore.</p>
+<!-- hidden references --></div></div>
+                  </div>
+            </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+              <div class="row span12">Copyright &copy;                    2012-2014
+                        <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+            All Rights Reserved.      
+                    
+      </div>
+
+        
+        
+          
+    
+    
+    <div id="ohloh" class="pull-right">
+      <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
+    </div>
+        </div>
+    </footer>
+  </body>
+</html>
\ No newline at end of file

Added: jackrabbit/site/live/oak/docs/security/user/query.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/security/user/query.html?rev=1594576&view=auto
==============================================================================
--- jackrabbit/site/live/oak/docs/security/user/query.html (added)
+++ jackrabbit/site/live/oak/docs/security/user/query.html Wed May 14 13:30:13 2014
@@ -0,0 +1,775 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-05-14
+ | 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="20140514" />
+    <meta http-equiv="Content-Language" content="en" />
+    <title>Jackrabbit Oak - Searching Users and Groups</title>
+    <link rel="stylesheet" href="../../css/apache-maven-fluido-1.3.0.min.css" />
+    <link rel="stylesheet" href="../../css/site.css" />
+    <link rel="stylesheet" href="../../css/print.css" media="print" />
+
+      
+    <script type="text/javascript" src="../../js/apache-maven-fluido-1.3.0.min.js"></script>
+
+    
+            </head>
+        <body class="topBarEnabled">
+          
+    
+    
+            
+    
+    
+    <a href="http://github.com/apache/jackrabbit-oak">
+      <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+        src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png"
+        alt="Fork me on GitHub">
+    </a>
+  
+                
+                    
+                
+
+    <div id="topbar" class="navbar navbar-fixed-top ">
+      <div class="navbar-inner">
+                <div class="container-fluid">
+        <a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+          <span class="icon-bar"></span>
+        </a>
+                
+                                <ul class="nav">
+                          <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../index.html"  title="Jackrabbit Oak">Jackrabbit Oak</a>
+</li>
+                  
+                      <li>      <a href="../../license.html"  title="License">License</a>
+</li>
+                  
+                      <li>      <a href="../../downloads.html"  title="Downloads">Downloads</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Concepts and architecture <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../overview.html"  title="Overview">Overview</a>
+</li>
+                  
+                      <li>      <a href="../../nodestate.html"  title="The node state model">The node state model</a>
+</li>
+                  
+                      <li>      <a href="../../microkernel.html"  title="NodeStore and MicroKernel">NodeStore and MicroKernel</a>
+</li>
+                  
+                      <li>      <a href="../../query.html"  title="Query">Query</a>
+</li>
+                  
+                      <li>      <a href="../../blobstore.html"  title="BlobStore">BlobStore</a>
+</li>
+                  
+                      <li>      <a href="../../security/overview.html"  title="Security">Security</a>
+</li>
+                  
+                      <li>      <a href="../../clustering.html"  title="Clustering">Clustering</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Using Oak <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../use_getting_started.html"  title="Getting Started">Getting Started</a>
+</li>
+                  
+                      <li>      <a href="../../construct.html"  title="Repository construction">Repository construction</a>
+</li>
+                  
+                      <li>      <a href="../../osgi_config.html"  title="Configuring Oak">Configuring Oak</a>
+</li>
+                  
+                      <li>      <a href="../../differences.html"  title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+                  
+                      <li>      <a href="../../known_issues.html"  title="Known Issues">Known Issues</a>
+</li>
+                  
+                      <li>      <a href="../../dos_and_donts.html"  title="Dos and don'ts">Dos and don'ts</a>
+</li>
+                  
+                      <li>      <a href="../../FAQ.html"  title="FAQ">FAQ</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Developing Oak <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="../../dev_getting_started.html"  title="Getting Started">Getting Started</a>
+</li>
+                  
+                      <li>      <a href="../../participating.html"  title="Participating">Participating</a>
+</li>
+                  
+                      <li>      <a href="../../apidocs/index.html"  title="API docs">API docs</a>
+</li>
+                          </ul>
+      </li>
+                <li class="dropdown">
+        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Links <b class="caret"></b></a>
+        <ul class="dropdown-menu">
+        
+                      <li>      <a href="http://jackrabbit.apache.org/oak"  title="Apache Jackrabbit Oak">Apache Jackrabbit Oak</a>
+</li>
+                  
+                      <li>      <a href="http://jackrabbit.apache.org/"  title="Apache Jackrabbit">Apache Jackrabbit</a>
+</li>
+                          </ul>
+      </li>
+                  </ul>
+          
+          
+          
+                   
+                      </div>
+          
+        </div>
+      </div>
+    </div>
+    
+        <div class="container-fluid">
+          <div id="banner">
+        <div class="pull-left">
+                                <div id="bannerLeft">
+                <h2>Oak Documentation</h2>
+                </div>
+                      </div>
+        <div class="pull-right">  </div>
+        <div class="clear"><hr/></div>
+      </div>
+
+      <div id="breadcrumbs">
+        <ul class="breadcrumb">
+                
+                    
+                  <li id="publishDate">Last Published: 2014-05-14</li>
+                  <li class="divider">|</li> <li id="projectVersion">Version: 0.20-SNAPSHOT</li>
+                      
+                
+                    
+      
+                            </ul>
+      </div>
+
+            
+      <div class="row-fluid">
+        <div id="leftColumn" class="span3">
+          <div class="well sidebar-nav">
+                
+                    
+                <ul class="nav nav-list">
+                    <li class="nav-header">Overview</li>
+                                
+      <li>
+    
+                          <a href="../../index.html" title="Jackrabbit Oak">
+          <i class="none"></i>
+        Jackrabbit Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../license.html" title="License">
+          <i class="none"></i>
+        License</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../downloads.html" title="Downloads">
+          <i class="none"></i>
+        Downloads</a>
+            </li>
+                              <li class="nav-header">Concepts and architecture</li>
+                                
+      <li>
+    
+                          <a href="../../overview.html" title="Overview">
+          <i class="none"></i>
+        Overview</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../nodestate.html" title="The node state model">
+          <i class="none"></i>
+        The node state model</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../microkernel.html" title="NodeStore and MicroKernel">
+          <i class="none"></i>
+        NodeStore and 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>
+    
+                          <a href="../../security/overview.html" title="Security">
+          <i class="none"></i>
+        Security</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../clustering.html" title="Clustering">
+          <i class="none"></i>
+        Clustering</a>
+            </li>
+                              <li class="nav-header">Using Oak</li>
+                                
+      <li>
+    
+                          <a href="../../use_getting_started.html" title="Getting Started">
+          <i class="none"></i>
+        Getting Started</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../construct.html" title="Repository construction">
+          <i class="none"></i>
+        Repository construction</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../osgi_config.html" title="Configuring Oak">
+          <i class="none"></i>
+        Configuring Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../differences.html" title="Differences to Jackrabbit 2">
+          <i class="none"></i>
+        Differences to Jackrabbit 2</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../known_issues.html" title="Known Issues">
+          <i class="none"></i>
+        Known Issues</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../dos_and_donts.html" title="Dos and don'ts">
+          <i class="none"></i>
+        Dos and don'ts</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../FAQ.html" title="FAQ">
+          <i class="none"></i>
+        FAQ</a>
+            </li>
+                              <li class="nav-header">Developing Oak</li>
+                                
+      <li>
+    
+                          <a href="../../dev_getting_started.html" title="Getting Started">
+          <i class="none"></i>
+        Getting Started</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../participating.html" title="Participating">
+          <i class="none"></i>
+        Participating</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="../../apidocs/index.html" title="API docs">
+          <i class="none"></i>
+        API docs</a>
+            </li>
+                              <li class="nav-header">Links</li>
+                                
+      <li>
+    
+                          <a href="http://jackrabbit.apache.org/oak" class="externalLink" title="Apache Jackrabbit Oak">
+          <i class="none"></i>
+        Apache Jackrabbit Oak</a>
+            </li>
+                  
+      <li>
+    
+                          <a href="http://jackrabbit.apache.org/" class="externalLink" title="Apache Jackrabbit">
+          <i class="none"></i>
+        Apache Jackrabbit</a>
+            </li>
+            </ul>
+                
+                    
+                
+          <hr class="divider" />
+
+           <div id="poweredBy">
+                   
+    <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+    
+    <div class="g-plusone" data-href="http://jackrabbit.apache.org/oak-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>Searching Users and Groups<a name="Searching_Users_and_Groups"></a></h2>
+<p>The user management API provided with Jackrabbit comes with a dedicated query API that allows for searching authorizables indepedant of the underlying user management implementation.</p>
+<div class="section">
+<h3>Lookup a Single Authorizable<a name="Lookup_a_Single_Authorizable"></a></h3>
+
+<ul>
+  
+<li><tt>UserManager.getAuthorizable(String)</tt> : lookup by id</li>
+  
+<li><tt>UserManager.getAuthorizable(Principal</tt> : lookup by principal</li>
+  
+<li><tt>UserManager.getAuthorizableByPath(String)</tt> : lookup by path</li>
+</ul>
+<div class="section">
+<div class="section">
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>Authorizable a = userMgr.getAuthorizable(&quot;jackrabbit&quot;);
+Authorizable a2 = userManager.getAuthorizableByPath(a.getPath());
+Authorizable everyoneGroup = userManager.getAuthorizable(EveryonePrincipal.getInstance());
+</pre></div></div></div></div></div>
+<div class="section">
+<h3>Searching for Authorizables<a name="Searching_for_Authorizables"></a></h3>
+
+<ul>
+  
+<li><tt>UserManager.findAuthorizables(String relPath, String value)</tt></li>
+  
+<li><tt>UserManager.findAuthorizables(String relPath, String value, int searchType)</tt></li>
+  
+<li><tt>UserManager.findAuthorizables(Query query)</tt></li>
+</ul></div>
+<div class="section">
+<h3>The Query API<a name="The_Query_API"></a></h3>
+
+<ul>
+  
+<li><a class="externalLink" href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/Query.java">Query</a>: The query object passed to the findAuthorizable method. It has a single <tt>build(QueryBuilder)</tt> method.</li>
+  
+<li><a class="externalLink" href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit-api/src/main/java/org/apache/jackrabbit/api/security/user/QueryBuilder.java">QueryBuilder</a>: The query builder as described below.</li>
+</ul>
+<div class="section">
+<h4>QueryBuilder<a name="QueryBuilder"></a></h4>
+<div class="section">
+<h5>Find by Property<a name="Find_by_Property"></a></h5>
+<p>The following conditions can be used to find authorizables by properties:</p>
+
+<ul>
+  
+<li><tt>QueryBuilder.eq(String relPath, Value)</tt>: holds if property at relPath is <i>equal</i> to the specified value.</li>
+  
+<li><tt>QueryBuilder.neq(String relPath, Value)</tt>: holds if property at relPath is <i>not equal</i> to the specified value.</li>
+  
+<li><tt>QueryBuilder.lt(String relPath, Value)</tt>: holds if property at relPath is <i>smaller</i> than the specified value.</li>
+  
+<li><tt>QueryBuilder.le(String relPath, Value)</tt>: holds if property at relPath is <i>smaller or equal</i> than/to the specified value.- QueryBuilder.lt(String relPath, Value) : matches if property value at relPath is <i>smaller</i> than the specified value.</li>
+  
+<li><tt>QueryBuilder.gt(String relPath, Value)</tt>: holds if property at relPath is <i>greater</i> than the specified value.</li>
+  
+<li><tt>QueryBuilder.ge(String relPath, Value)</tt>: holds if property at relPath is <i>greater or equal</i> than/to the specified value.</li>
+  
+<li><tt>QueryBuilder.ge(String relPath, Value)</tt>: holds if property at relPath is <i>greater or equal</i> than/to the specified value.</li>
+  
+<li><tt>QueryBuilder.contains(String relPath, String searchExpr)</tt>: full text search.</li>
+  
+<li><tt>QueryBuilder.exists(String relPath)</tt>: holds if a property at relPath exists.</li>
+</ul>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.eq(&quot;@name&quot;, vf.createValue(&quot;jackrabbit&quot;)));
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.gt(&quot;profile/@weight&quot;, vf.createValue(200.0)));
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.contains(&quot;profile/@color&quot;, &quot;gold&quot;));
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.exists(&quot;@poisonous&quot;));
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Find by Pattern<a name="Find_by_Pattern"></a></h5>
+<p>The following conditions allow to specify a search pattern, where &#x2018;%&#x2019; represents any string of zero or more characters and &#x2018;_&#x2019; represents any single character.</p>
+
+<ul>
+  
+<li><tt>QueryBuilder.like(String relPath, String pattern)</tt>: holds if a property relPath matches the pattern.</li>
+  
+<li><tt>QueryBuilder.like(String relPath, String pattern)</tt>: holds if a property relPath matches the pattern.</li>
+  
+<li><tt>QueryBuilder.nameMatches(String pattern)</tt>: filter by principal name (see below)</li>
+</ul>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+  public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+      builder.setCondition(builder.like(&quot;profile/@food&quot;, &quot;c%&quot;));
+  }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+  public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+      builder.setCondition(builder.like(&quot;profile/@food&quot;, &quot;c_t&quot;));
+  }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Find in Any Property<a name="Find_in_Any_Property"></a></h5>
+<p>Use &#x201c;.&#x201d; to indicate that properties with any name at a given relative path should be included in the search result.</p>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.contains(&quot;.&quot;, &quot;&quot;jackrabbit&quot;&quot;));
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.contains(&quot;profile/.&quot;, &quot;gold&quot;));
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Multiple Conditions<a name="Multiple_Conditions"></a></h5>
+
+<ul>
+  
+<li><tt>QueryBuilder.and(Condition condition1, Condition condition2)</tt>: holds if both sub conditions hold</li>
+  
+<li><tt>QueryBuilder.or(Condition condition1, Condition condition2)</tt>: holds if any of the two sub conditions hold</li>
+  
+<li><tt>QueryBuilder.not(Condition condition)</tt>: holds if the sub condition does not hold.</li>
+</ul>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.and(
+            builder.eq(&quot;profile/@cute&quot;, vf.createValue(true)),
+            builder.eq(&quot;profile/@color&quot;, vf.createValue(&quot;black&quot;))
+        ));
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.or(
+            builder.eq(&quot;profile/@food&quot;, vf.createValue(&quot;mice&quot;)),
+            builder.eq(&quot;profile/@food&quot;, vf.createValue(&quot;nectar&quot;))
+            )
+        );
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.not(builder.exists(&quot;profile/@food&quot;))
+        ));
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.and(
+            builder.eq(&quot;profile/@cute&quot;, vf.createValue(true)),
+            builder.not(builder.eq(&quot;profile/@color&quot;, vf.createValue(&quot;black&quot;)))
+        ));
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Sort Results<a name="Sort_Results"></a></h5>
+
+<ul>
+  
+<li><tt>QueryBuilder.setSortOrder(String propertyName, Direction direction)</tt></li>
+  
+<li><tt>QueryBuilder.setSortOrder(String propertyName, Direction direction, boolean ignoreCase)</tt></li>
+</ul>
+<p>where direction can be either of</p>
+
+<ul>
+  
+<li><tt>Direction.ASCENDING</tt></li>
+  
+<li><tt>Direction.DESCENDING</tt></li>
+</ul>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>final boolean ignoreCase = true;
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.exists(&quot;profile/@weight&quot;));
+        builder.setSortOrder(&quot;profile/@weight&quot;, QueryBuilder.Direction.ASCENDING, ignoreCase);
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Set Limits<a name="Set_Limits"></a></h5>
+
+<ul>
+  
+<li><tt>QueryBuilder.setLimit(long offset, long maxCount)</tt></li>
+  
+<li><tt>QueryBuilder.setLimit(Value bound, long maxCount)</tt> : bound refers to the value of the <tt>setSortOrder(String, Direction)</tt> property. The result is limited to authorizables whose values of the sort order property follow <tt>bound</tt> in the sort direction.</li>
+</ul>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>final long offset = 25;
+final long maxCount = 1000; // -1 for no limit
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setLimit(offset, maxCount);
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.eq(&quot;profile/@cute&quot;, vf.createValue(true)));
+        builder.setSortOrder(&quot;profile/@weight&quot;, QueryBuilder.Direction.ASCENDING, true);
+        builder.setLimit(vf.createValue(1000.0), count);
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Filter by Authorizable Type<a name="Filter_by_Authorizable_Type"></a></h5>
+
+<ul>
+  
+<li><tt>QueryBuilder.setSelector(Class&lt;? extends Authorizable&gt; selector)</tt>: Limit search result to a specific type of authorizables (in the example: groups only)</li>
+</ul>
+<p>The selector may take any of the following values:</p>
+
+<ul>
+  
+<li><tt>Authorizable.class</tt></li>
+  
+<li><tt>Group.class</tt></li>
+  
+<li><tt>User.class</tt></li>
+</ul>
+<div class="section">
+<h6>Example<a name="Example"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setSelector(Group.class);
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Find by Principal Name<a name="Find_by_Principal_Name"></a></h5>
+
+<ul>
+  
+<li><tt>QueryBuilder.nameMatches(String pattern)</tt>: the pattern may include &#x2018;_&#x2019; and &#x2018;%&#x2019; (see above).</li>
+</ul>
+<p>NOTE: the &#x2018;nameMatches&#x2019; condition is a shortcut for a regular search for the principal name, which in the default implementation is stored in <tt>rep:principalName</tt>. It does not take any custom name properties into account nor query <tt>rep:authorizableId</tt>.</p>
+<div class="section">
+<h6>Examples<a name="Examples"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.nameMatches(&quot;j%P&quot;));
+    }
+});
+
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.nameMatches(&quot;c_tP&quot;));
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Find Group Members<a name="Find_Group_Members"></a></h5>
+
+<ul>
+  
+<li><tt>QueryBuilder.setScope(String groupName, boolean declaredOnly)</tt>: will only return members of the group with the specified name.</li>
+</ul>
+<div class="section">
+<h6>Example<a name="Example"></a></h6>
+
+<div class="source">
+<pre>final declaredMembersOnly = false;
+Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setScope(&quot;mammals&quot;, declaredMembersOnly);
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Search for Impersonators<a name="Search_for_Impersonators"></a></h5>
+
+<ul>
+  
+<li>&#x2018;QueryBuilder.impersonates(String principalName)&#x2019;</li>
+</ul>
+<p>NOTE: this condition looks for authorizables that granted impersonation to the authorizable with the specified principal name.</p>
+<div class="section">
+<h6>Example<a name="Example"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) {
+        builder.setCondition(builder.impersonates(&quot;jackrabbitP&quot;));
+    }
+});
+</pre></div></div></div>
+<div class="section">
+<h5>Find All<a name="Find_All"></a></h5>
+<p>Find all authorizables accessible to the editing session</p>
+<div class="section">
+<h6>Example<a name="Example"></a></h6>
+
+<div class="source">
+<pre>Iterator&lt;Authorizable&gt; result = userMgr.findAuthorizables(new Query() {
+    public &lt;T&gt; void build(QueryBuilder&lt;T&gt; builder) { /* any */ }
+});
+</pre></div></div></div></div></div>
+<div class="section">
+<h3>Characteristics of the Default Implementation<a name="Characteristics_of_the_Default_Implementation"></a></h3>
+<div class="section">
+<h4>Changes wrt Jackrabbit 2.x<a name="Changes_wrt_Jackrabbit_2.x"></a></h4>
+<p>The user query is expected to work as in Jackrabbit 2.x with the following notable bug fixes:</p>
+
+<ul>
+  
+<li><tt>QueryBuilder#setScope(String groupID, boolean declaredOnly)</tt> now also works properly  for the everyone group (see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-949">OAK-949</a>)</li>
+  
+<li><tt>QueryBuilder#impersonates(String principalName)</tt> works properly for the admin  principal which are specially treated in the implementation of the <tt>Impersonation</tt>  interface (see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-1183">OAK-1183</a>).</li>
+</ul></div>
+<div class="section">
+<h4>XPathQueryBuilder<a name="XPathQueryBuilder"></a></h4>
+<p>Oak 1.0 comes with a default XPATH based implementation of the <tt>QueryBuilder</tt> inteface which is passed to the query upon calling <tt>UserManager#findAuthorizables(Query)</tt>.</p></div></div>
+<div class="section">
+<h3>Utilities<a name="Utilities"></a></h3>
+<p>See <a class="externalLink" href="http://svn.apache.org/repos/asf/jackrabbit/trunk/jackrabbit-jcr-commons/src/main/java/org/apache/jackrabbit/commons/jackrabbit/user/AuthorizableQueryManager.java">org.apache.jackrabbit.commons.jackrabbit.user.AuthorizableQueryManager</a> for a utility class provided by the jcr-commons module present with Jackrabbit.</p>
+<!-- hidden references --></div></div>
+                  </div>
+            </div>
+          </div>
+
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+              <div class="row span12">Copyright &copy;                    2012-2014
+                        <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+            All Rights Reserved.      
+                    
+      </div>
+
+        
+        
+          
+    
+    
+    <div id="ohloh" class="pull-right">
+      <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit-oak/widgets/project_users_logo.js"></script>
+    </div>
+        </div>
+    </footer>
+  </body>
+</html>
\ No newline at end of file

Modified: jackrabbit/site/live/oak/docs/segmentmk.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/segmentmk.html?rev=1594576&r1=1594575&r2=1594576&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/segmentmk.html (original)
+++ jackrabbit/site/live/oak/docs/segmentmk.html Wed May 14 13:30:13 2014
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2014-05-06
+ | Generated by Apache Maven Doxia at 2014-05-14
  | 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="20140506" />
+    <meta name="Date-Revision-yyyymmdd" content="20140514" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak - SegmentMK design overview</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.0.min.css" />
@@ -58,9 +58,6 @@
                   
                       <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">
@@ -73,7 +70,7 @@
                       <li>      <a href="nodestate.html"  title="The node state model">The node state model</a>
 </li>
                   
-                      <li>      <a href="microkernel.html"  title="NodesStore and MicroKernel">NodesStore and MicroKernel</a>
+                      <li>      <a href="microkernel.html"  title="NodeStore and MicroKernel">NodeStore and MicroKernel</a>
 </li>
                   
                       <li>      <a href="query.html"  title="Query">Query</a>
@@ -96,19 +93,22 @@
                       <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>      <a href="construct.html"  title="Repository construction">Repository construction</a>
 </li>
                   
                       <li>      <a href="osgi_config.html"  title="Configuring Oak">Configuring Oak</a>
 </li>
                   
+                      <li>      <a href="differences.html"  title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+                  
                       <li>      <a href="known_issues.html"  title="Known Issues">Known Issues</a>
 </li>
                   
                       <li>      <a href="dos_and_donts.html"  title="Dos and don'ts">Dos and don'ts</a>
 </li>
                   
-                      <li>      <a href="when_things_go_wrong.html"  title="When things go wrong">When things go wrong</a>
+                      <li>      <a href="FAQ.html"  title="FAQ">FAQ</a>
 </li>
                           </ul>
       </li>
@@ -163,7 +163,7 @@
         <ul class="breadcrumb">
                 
                     
-                  <li id="publishDate">Last Published: 2014-05-06</li>
+                  <li id="publishDate">Last Published: 2014-05-14</li>
                   <li class="divider">|</li> <li id="projectVersion">Version: 0.20-SNAPSHOT</li>
                       
                 
@@ -201,13 +201,6 @@
           <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>
@@ -226,9 +219,9 @@
                   
       <li>
     
-                          <a href="microkernel.html" title="NodesStore and MicroKernel">
+                          <a href="microkernel.html" title="NodeStore and MicroKernel">
           <i class="none"></i>
-        NodesStore and MicroKernel</a>
+        NodeStore and MicroKernel</a>
             </li>
                   
       <li>
@@ -269,9 +262,9 @@
                   
       <li>
     
-                          <a href="differences.html" title="Differences to Jackrabbit 2">
+                          <a href="construct.html" title="Repository construction">
           <i class="none"></i>
-        Differences to Jackrabbit 2</a>
+        Repository construction</a>
             </li>
                   
       <li>
@@ -283,6 +276,13 @@
                   
       <li>
     
+                          <a href="differences.html" title="Differences to Jackrabbit 2">
+          <i class="none"></i>
+        Differences to Jackrabbit 2</a>
+            </li>
+                  
+      <li>
+    
                           <a href="known_issues.html" title="Known Issues">
           <i class="none"></i>
         Known Issues</a>
@@ -297,9 +297,9 @@
                   
       <li>
     
-                          <a href="when_things_go_wrong.html" title="When things go wrong">
+                          <a href="FAQ.html" title="FAQ">
           <i class="none"></i>
-        When things go wrong</a>
+        FAQ</a>
             </li>
                               <li class="nav-header">Developing Oak</li>
                                 

Modified: jackrabbit/site/live/oak/docs/use_getting_started.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/oak/docs/use_getting_started.html?rev=1594576&r1=1594575&r2=1594576&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/use_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/use_getting_started.html Wed May 14 13:30:13 2014
@@ -1,15 +1,15 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia at 2014-05-06
+ | Generated by Apache Maven Doxia at 2014-05-14
  | 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="20140506" />
+    <meta name="Date-Revision-yyyymmdd" content="20140514" />
     <meta http-equiv="Content-Language" content="en" />
-    <title>Jackrabbit Oak - </title>
+    <title>Jackrabbit Oak - Runnable jar</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" />
@@ -58,9 +58,6 @@
                   
                       <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">
@@ -73,7 +70,7 @@
                       <li>      <a href="nodestate.html"  title="The node state model">The node state model</a>
 </li>
                   
-                      <li>      <a href="microkernel.html"  title="NodesStore and MicroKernel">NodesStore and MicroKernel</a>
+                      <li>      <a href="microkernel.html"  title="NodeStore and MicroKernel">NodeStore and MicroKernel</a>
 </li>
                   
                       <li>      <a href="query.html"  title="Query">Query</a>
@@ -96,19 +93,22 @@
                       <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>      <a href="construct.html"  title="Repository construction">Repository construction</a>
 </li>
                   
                       <li>      <a href="osgi_config.html"  title="Configuring Oak">Configuring Oak</a>
 </li>
                   
+                      <li>      <a href="differences.html"  title="Differences to Jackrabbit 2">Differences to Jackrabbit 2</a>
+</li>
+                  
                       <li>      <a href="known_issues.html"  title="Known Issues">Known Issues</a>
 </li>
                   
                       <li>      <a href="dos_and_donts.html"  title="Dos and don'ts">Dos and don'ts</a>
 </li>
                   
-                      <li>      <a href="when_things_go_wrong.html"  title="When things go wrong">When things go wrong</a>
+                      <li>      <a href="FAQ.html"  title="FAQ">FAQ</a>
 </li>
                           </ul>
       </li>
@@ -163,7 +163,7 @@
         <ul class="breadcrumb">
                 
                     
-                  <li id="publishDate">Last Published: 2014-05-06</li>
+                  <li id="publishDate">Last Published: 2014-05-14</li>
                   <li class="divider">|</li> <li id="projectVersion">Version: 0.20-SNAPSHOT</li>
                       
                 
@@ -201,13 +201,6 @@
           <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>
@@ -226,9 +219,9 @@
                   
       <li>
     
-                          <a href="microkernel.html" title="NodesStore and MicroKernel">
+                          <a href="microkernel.html" title="NodeStore and MicroKernel">
           <i class="none"></i>
-        NodesStore and MicroKernel</a>
+        NodeStore and MicroKernel</a>
             </li>
                   
       <li>
@@ -267,9 +260,9 @@
                   
       <li>
     
-                          <a href="differences.html" title="Differences to Jackrabbit 2">
+                          <a href="construct.html" title="Repository construction">
           <i class="none"></i>
-        Differences to Jackrabbit 2</a>
+        Repository construction</a>
             </li>
                   
       <li>
@@ -281,6 +274,13 @@
                   
       <li>
     
+                          <a href="differences.html" title="Differences to Jackrabbit 2">
+          <i class="none"></i>
+        Differences to Jackrabbit 2</a>
+            </li>
+                  
+      <li>
+    
                           <a href="known_issues.html" title="Known Issues">
           <i class="none"></i>
         Known Issues</a>
@@ -295,9 +295,9 @@
                   
       <li>
     
-                          <a href="when_things_go_wrong.html" title="When things go wrong">
+                          <a href="FAQ.html" title="FAQ">
           <i class="none"></i>
-        When things go wrong</a>
+        FAQ</a>
             </li>
                               <li class="nav-header">Developing Oak</li>
                                 
@@ -375,15 +375,30 @@
    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. --><p>TODO: Document how to use Oak:</p>
+   limitations under the License. --><h1>Runnable jar</h1>
+<p>Oak comes with a <a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-run/README.md">runnable jar</a>, which contains everything you need for a simple Oak installation.</p>
+<h1>Using Oak in your project</h1>
+<p>To use Oak in your project simply add a dependency to <tt>org.apache.jackrabbit:oak-jcr:1.0.0</tt> and to <tt>javax.jcr:jcr:2.0</tt>:</p>
+
+<div class="source">
+<pre>&lt;dependency&gt;
+  &lt;groupId&gt;org.apache.jackrabbit&lt;/groupId&gt;
+  &lt;artifactId&gt;oak-jcr&lt;/artifactId&gt;
+  &lt;version&gt;1.0.0&lt;/version&gt;
+&lt;/dependency&gt;
+&lt;dependency&gt;
+  &lt;groupId&gt;javax.jcr&lt;/groupId&gt;
+  &lt;artifactId&gt;jcr&lt;/artifactId&gt;
+  &lt;version&gt;2.0&lt;/version&gt;
+&lt;/dependency&gt;
+</pre></div>
+<p>Oak has simple mechanisms for constructing and configuring content repositories for use in embedded deployments and test cases:</p>
 
 <ul>
   
-<li>Required (Maven) Dependencies</li>
-  
 <li><a href="construct.html">Repository construction</a></li>
   
-<li><a class="externalLink" href="https://github.com/apache/jackrabbit-oak/blob/trunk/oak-run/README.md">Oak runnable jar</a></li>
+<li><a href="osgi_config.html">Configuring Oak</a></li>
 </ul>
                   </div>
             </div>



Mime
View raw message