jackrabbit-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mreut...@apache.org
Subject svn commit: r1835390 [23/23] - in /jackrabbit/site/live/oak/docs: ./ architecture/ coldstandby/ features/ nodestore/ nodestore/document/ nodestore/segment/ oak-mongo-js/ oak_api/ plugins/ query/ security/ security/accesscontrol/ security/authentication...
Date Mon, 09 Jul 2018 08:53:19 GMT
Modified: 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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/security/user/membership.html (original)
+++ jackrabbit/site/live/oak/docs/security/user/membership.html Mon Jul  9 08:53:17 2018
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24 
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09 
  | Rendered using Apache Maven Fluido Skin 1.6
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20180524" />
+    <meta name="Date-Revision-yyyymmdd" content="20180709" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak &#x2013; Group Membership</title>
     <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+        <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
 </li>
           <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
         </ul>
@@ -240,45 +240,38 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-  --><div class="section">
+  -->
+<div class="section">
 <h2><a name="Group_Membership"></a>Group Membership</h2>
 <div class="section">
 <h3><a name="Jackrabbit_API"></a>Jackrabbit API</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>
-    
 <li><tt>addMembers(String...) Set&lt;String&gt;</tt></li>
-    
 <li><tt>removeMembers(String...) Set&lt;String&gt;</tt></li>
-  </ul></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>
+</li>
 </ul></div>
 <div class="section">
 <h3><a name="Characteristics_of_the_Default_Implementation"></a>Characteristics
of the Default Implementation</h3>
@@ -293,8 +286,9 @@
 <div class="section">
 <h5><a name="Relevant_new_and_modified_node_types"></a>Relevant new and
modified node types</h5>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">[rep:Group] &gt; rep:Authorizable,
rep:MemberReferences
+<div>
+<div>
+<pre class="source">[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
 
@@ -303,15 +297,17 @@
 
 [rep:MemberReferencesList]
   + * (rep:MemberReferences) = rep:MemberReferences protected COPY
-</pre></div></div></div>
+</pre></div></div>
+</div>
 <div class="section">
 <h5><a name="Examples"></a>Examples</h5>
 <div class="section">
 <h6><a name="Example_Group_with_few_members"></a>Example Group with few
members</h6>
 <p><i>(irrelevant properties excluded)</i></p>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">{
+<div>
+<div>
+<pre class="source">{
     &quot;jcr:primaryType&quot;: &quot;rep:Group&quot;,
     &quot;rep:principalName&quot;: &quot;contributor&quot;,
     &quot;rep:members&quot;: [
@@ -324,13 +320,15 @@
         &quot;65c3084e-abfc-3719-8223-72c6cb9a3d6f&quot;
     ]
 }
-</pre></div></div></div>
+</pre></div></div>
+</div>
 <div class="section">
 <h6><a name="Example_Group_with_many_members"></a>Example Group with many
members</h6>
 <p><i>(irrelevant properties excluded)</i></p>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">{
+<div>
+<div>
+<pre class="source">{
     &quot;jcr:primaryType&quot;: &quot;rep:Group&quot;,
     &quot;rep:principalName&quot;: &quot;employees&quot;,
     &quot;rep:membersList&quot;: {
@@ -355,6 +353,7 @@
     }
 }
 </pre></div></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>
 <div class="section">
 <h4><a name="Upgrading_Groups_from_Jackrabbit_2.x_to_Oak_content_structure"></a>Upgrading
Groups from Jackrabbit 2.x to Oak content structure</h4>
@@ -365,27 +364,20 @@
 <div class="section">
 <h4><a name="Add_and_Remove_Group_Members_by_Id"></a>Add and Remove Group
Members by Id</h4>
 <p>Since Oak 1.3.4 the default user management implementation also allows to modify
group membership by specifying the member id(s) (see <a class="externalLink" href="https://issues.apache.org/jira/browse/JCR-3880">JCR-3880</a>
and <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-3170">OAK-3170</a>).
The following details are worth mentioning:</p>
-
 <ul>
-  
+
 <li>a <tt>null</tt> or empty String id will immediately fail the operation
with <tt>ConstraintViolationException</tt>; changes already made will not be reverted,</li>
-  
 <li>an attempt to make the same group member of itself will list that id in the return
value but will not fail the operation,</li>
-  
 <li>duplicate ids in the parameter list will be silently ignored,</li>
-  
-<li><s>cyclic membership validation is postponed to the validator called upon
</s><tt><s>Root.commit</s></tt><s>  and will only fail
at that point; the cyclic membership then needs to be manually  resolved by the application</s>
(see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-3170">OAK-3170</a>
and below)</li>
-  
-<li>whether or not a non-existing (or not accessible) authorizable can be added or
 removed depends on the configured <tt>ImportBehavior</tt>:
-  
+<li><s>cyclic membership validation is postponed to the validator called upon
</s><tt><s>Root.commit</s></tt><s> and will only fail
at that point; the cyclic membership then needs to be manually resolved by the application</s>
(see <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-3170">OAK-3170</a>
and below)</li>
+<li>whether or not a non-existing (or not accessible) authorizable can be added or
removed depends on the configured <tt>ImportBehavior</tt>:
 <ul>
-    
-<li>ABORT: each id is resolved to the corresponding authorizable; if it doesn&#x2019;t
 exist <tt>ConstraintViolationException</tt> is thrown immediately; changes already
 made will not be reverted.</li>
-    
-<li>BESTEFFORT: the specified ids are not resolved to the corresponding  authorizables
and are silently added|removed to|from the set of members;  ids that were not successfully
added|removed are listed in the return value.</li>
-    
-<li>IGNORE: each id is resolved to the corresponding authorizable; if it doesn&#x2019;t
 exist it will be returned as <i>failed</i> in the return value.</li>
-  </ul></li>
+
+<li>ABORT: each id is resolved to the corresponding authorizable; if it doesn&#x2019;t
exist <tt>ConstraintViolationException</tt> is thrown immediately; changes already
made will not be reverted.</li>
+<li>BESTEFFORT: the specified ids are not resolved to the corresponding authorizables
and are silently added|removed to|from the set of members; ids that were not successfully
added|removed are listed in the return value.</li>
+<li>IGNORE: each id is resolved to the corresponding authorizable; if it doesn&#x2019;t
exist it will be returned as <i>failed</i> in the return value.</li>
+</ul>
+</li>
 </ul></div>
 <div class="section">
 <h4><a name="Invalid_Membership"></a>Invalid Membership</h4>
@@ -403,11 +395,10 @@
 <h5><a name="Cyclic_Membership"></a>Cyclic Membership</h5>
 <p>Since Oak 1.7.0 the explicit check for cyclic group membership has been moved from
the <tt>Validator</tt> to the <tt>Group</tt> implementation. As before
cyclic membership might not be spotted and the membership resolution will log the cycle upon
collection of all members/groups.</p>
 <p>The following scenarios may leave the cycle unnoticed upon adding members: - <tt>Group.addMember(Authorizable)</tt>
when the editing <tt>Session</tt> cannot read all groups included in the cycle.
- <tt>Group.addMembers(String...)</tt> with <tt>ImportBehavior.BESTEFFORT</tt>
where the member ID is not resolved.</p>
-<p>See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-3170">OAK-3170</a>
for additional information. </p></div></div></div>
+<p>See <a class="externalLink" href="https://issues.apache.org/jira/browse/OAK-3170">OAK-3170</a>
for additional information.</p></div></div></div>
 <div class="section">
 <h3><a name="Configuration"></a>Configuration</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>
+<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>

Modified: 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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/security/user/query.html (original)
+++ jackrabbit/site/live/oak/docs/security/user/query.html Mon Jul  9 08:53:17 2018
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24 
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09 
  | Rendered using Apache Maven Fluido Skin 1.6
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20180524" />
+    <meta name="Date-Revision-yyyymmdd" content="20180709" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak &#x2013; Searching Users and Groups</title>
     <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+        <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
 </li>
           <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
         </ul>
@@ -240,18 +240,16 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-  --><div class="section">
+  -->
+<div class="section">
 <h2><a name="Searching_Users_and_Groups"></a>Searching Users and Groups</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><a name="Lookup_a_Single_Authorizable"></a>Lookup a Single Authorizable</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">
@@ -259,29 +257,26 @@
 <div class="section">
 <h6><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Authorizable a = userMgr.getAuthorizable(&quot;jackrabbit&quot;);
+<div>
+<div>
+<pre class="source">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>
+</pre></div></div>
+</div></div></div></div>
 <div class="section">
 <h3><a name="Searching_for_Authorizables"></a>Searching for Authorizables</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><a name="The_Query_API"></a>The Query API</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">
@@ -289,32 +284,24 @@ Authorizable everyoneGroup = userManager
 <div class="section">
 <h5><a name="Find_by_Property"></a>Find by Property</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><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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;)));
     }
@@ -337,24 +324,23 @@ Iterator&lt;Authorizable&gt; result = us
         builder.setCondition(builder.exists(&quot;@poisonous&quot;));
     }
 });
-</pre></div></div></div></div>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Find_by_Pattern"></a>Find by Pattern</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><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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;));
   }
@@ -365,15 +351,17 @@ Iterator&lt;Authorizable&gt; result = us
       builder.setCondition(builder.like(&quot;profile/@food&quot;, &quot;c_t&quot;));
   }
 });
-</pre></div></div></div></div>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Find_in_Any_Property"></a>Find in Any Property</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><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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;));
     }
@@ -384,23 +372,22 @@ Iterator&lt;Authorizable&gt; result = us
         builder.setCondition(builder.contains(&quot;profile/.&quot;, &quot;gold&quot;));
     }
 });
-</pre></div></div></div></div>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Multiple_Conditions"></a>Multiple Conditions</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><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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)),
@@ -434,50 +421,48 @@ Iterator&lt;Authorizable&gt; result = us
         ));
     }
 });
-</pre></div></div></div></div>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Sort_Results"></a>Sort Results</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><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">final boolean ignoreCase = true;
+<div>
+<div>
+<pre class="source">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>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Set_Limits"></a>Set Limits</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><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">final long offset = 25;
+<div>
+<div>
+<pre class="source">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) {
@@ -492,47 +477,46 @@ Iterator&lt;Authorizable&gt; result = us
         builder.setLimit(vf.createValue(1000.0), count);
     }
 });
-</pre></div></div></div></div>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Filter_by_Authorizable_Type"></a>Filter by Authorizable Type</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><a name="Example"></a>Example</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Find_by_Principal_Name"></a>Find by Principal Name</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><a name="Examples"></a>Examples</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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;));
     }
@@ -543,61 +527,65 @@ Iterator&lt;Authorizable&gt; result = us
         builder.setCondition(builder.nameMatches(&quot;c_tP&quot;));
     }
 });
-</pre></div></div></div></div>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Find_Group_Members"></a>Find Group Members</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><a name="Example"></a>Example</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">final declaredMembersOnly = false;
+<div>
+<div>
+<pre class="source">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>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Search_for_Impersonators"></a>Search for Impersonators</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><a name="Example"></a>Example</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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>
+</pre></div></div>
+</div></div>
 <div class="section">
 <h5><a name="Find_All"></a>Find All</h5>
 <p>Find all authorizables accessible to the editing session</p>
 <div class="section">
 <h6><a name="Example"></a>Example</h6>
 
-<div class="source">
-<div class="source"><pre class="prettyprint">Iterator&lt;Authorizable&gt;
result = userMgr.findAuthorizables(new Query() {
+<div>
+<div>
+<pre class="source">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>
+</pre></div></div>
+</div></div></div></div>
 <div class="section">
 <h3><a name="Characteristics_of_the_Default_Implementation"></a>Characteristics
of the Default Implementation</h3>
 <p>See sections <a href="differences.html#query">Differences to Jackrabbit 2.x</a>
and <a href="default.html#query">The Default Implementation</a> for details.</p></div>
 <div class="section">
 <h3><a name="Utilities"></a>Utilities</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>
+<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>

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=1835390&r1=1835389&r2=1835390&view=diff
==============================================================================
--- jackrabbit/site/live/oak/docs/use_getting_started.html (original)
+++ jackrabbit/site/live/oak/docs/use_getting_started.html Mon Jul  9 08:53:17 2018
@@ -1,13 +1,13 @@
 <!DOCTYPE html>
 <!--
- | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2018-05-24 
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 at 2018-07-09 
  | Rendered using Apache Maven Fluido Skin 1.6
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta name="Date-Revision-yyyymmdd" content="20180524" />
+    <meta name="Date-Revision-yyyymmdd" content="20180709" />
     <meta http-equiv="Content-Language" content="en" />
     <title>Jackrabbit Oak &#x2013; Runnable jar</title>
     <link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
@@ -136,7 +136,7 @@
 
       <div id="breadcrumbs">
         <ul class="breadcrumb">
-        <li id="publishDate">Last Published: 2018-05-24<span class="divider">|</span>
+        <li id="publishDate">Last Published: 2018-07-09<span class="divider">|</span>
 </li>
           <li id="projectVersion">Version: 1.10-SNAPSHOT</li>
         </ul>
@@ -241,13 +241,15 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-  --><h1>Runnable jar</h1>
+  -->
+<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">
-<div class="source"><pre class="prettyprint">&lt;dependency&gt;
+<div>
+<div>
+<pre class="source">&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;
@@ -258,12 +260,11 @@
   &lt;version&gt;2.0&lt;/version&gt;
 &lt;/dependency&gt;
 </pre></div></div>
-<p>Oak has simple mechanisms for constructing and configuring content repositories
for use in embedded deployments and test cases:</p>
 
+<p>Oak has simple mechanisms for constructing and configuring content repositories
for use in embedded deployments and test cases:</p>
 <ul>
-  
+
 <li><a href="construct.html">Repository construction</a></li>
-  
 <li><a href="osgi_config.html">Configuring Oak</a></li>
 </ul>
         </div>



Mime
View raw message