You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by re...@apache.org on 2022/05/12 13:18:22 UTC
svn commit: r1900838 [14/50] - in /jackrabbit/site/live/jcr: ./ components/ css/ images/ js/ ocm/ status/
Modified: jackrabbit/site/live/jcr/index-readers.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/index-readers.html?rev=1900838&r1=1900837&r2=1900838&view=diff
==============================================================================
--- jackrabbit/site/live/jcr/index-readers.html (original)
+++ jackrabbit/site/live/jcr/index-readers.html Thu May 12 13:18:21 2022
@@ -1,452 +1,176 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2020-07-08
- | Rendered using Apache Maven Fluido Skin 1.3.1
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src\site\markdown/index-readers.md at 2022-05-12
+ | Rendered using Apache Maven Fluido Skin 1.9
-->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20200708" />
- <meta http-equiv="Content-Language" content="en" />
- <title>Apache Jackrabbit - Index readers</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
+ <title>Apache Jackrabbit – Index readers</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.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.1.min.js"></script>
-
-
- </head>
- <body class="topBarEnabled">
-
-
-
-
-
-
- <a href="http://github.com/apache/jackrabbit">
+ <script src="./js/apache-maven-fluido-1.9.min.js"></script>
+<!-- Matomo -->
+<script>
+ var _paq = window._paq = window._paq || [];
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+ /* We explicitly disable cookie tracking to avoid privacy issues */
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+ (function() {
+ var u="https://matomo.privacy.apache.org/";
+ _paq.push(['setTrackerUrl', u+'matomo.php']);
+ _paq.push(['setSiteId', '4']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+</script>
+<!-- End Matomo Code -->
+ </head>
+ <body class="topBarEnabled">
+ <a href="https://github.com/apache/jackrabbit">
<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 ">
+ <header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
- <div class="container-fluid">
+ <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>
-
- <a class="brand" href="index.html" title="Apache Jackrabbit">
-
-
- <img src="images/logos/jlogo.gif" alt="Apache Jackrabbit" />
-
- </a>
-
- <ul class="nav">
- <li class="dropdown">
+<a class="brand" href="index.html" title="Apache Jackrabbit"><img src="images/logos/jlogo.gif" alt="Apache Jackrabbit" />
+</a>
+ <ul class="nav">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="index.html" title="Welcome">Welcome</a>
-</li>
-
- <li> <a href="downloads.html" title="Downloads">Downloads</a>
-</li>
-
- <li> <a href="articles.html" title="Articles">Articles</a>
-</li>
-
- <li> <a href="frequently-asked-questions.html" title="FAQ">FAQ</a>
-</li>
-
- <li> <a href="http://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" title="Archived Jackrabbit Wiki">Archived Jackrabbit Wiki</a>
-</li>
-
- <li> <a href="jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a>
-</li>
- </ul>
+ <li><a href="index.html" title="Welcome">Welcome</a></li>
+ <li><a href="downloads.html" title="Downloads">Downloads</a></li>
+ <li><a href="articles.html" title="Articles">Articles</a></li>
+ <li><a href="frequently-asked-questions.html" title="FAQ">FAQ</a></li>
+ <li><a href="https://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" title="Archived Jackrabbit Wiki">Archived Jackrabbit Wiki</a></li>
+ <li><a href="jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a></li>
+ </ul>
</li>
- <li class="dropdown">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a>
-</li>
-
- <li> <a href="standalone-server.html" title="Standalone Server">Standalone Server</a>
-</li>
-
- <li> <a href="jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a>
-</li>
-
- <li> <a href="first-hops.html" title="First Hops">First Hops</a>
-</li>
-
- <li> <a href="jcr-api.html" title="JCR & API">JCR & API</a>
-</li>
-
- <li> <a href="jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a>
-</li>
-
- <li> <a href="deployment-models.html" title="Deployment Models">Deployment Models</a>
-</li>
-
- <li> <a href="jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a>
-</li>
-
- <li> <a href="node-types.html" title="Node Types">Node Types</a>
-</li>
-
- <li> <a href="object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a>
-</li>
- </ul>
+ <li><a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a></li>
+ <li><a href="standalone-server.html" title="Standalone Server">Standalone Server</a></li>
+ <li><a href="jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a></li>
+ <li><a href="first-hops.html" title="First Hops">First Hops</a></li>
+ <li><a href="jcr-api.html" title="JCR & API">JCR & API</a></li>
+ <li><a href="jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a></li>
+ <li><a href="deployment-models.html" title="Deployment Models">Deployment Models</a></li>
+ <li><a href="jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a></li>
+ <li><a href="node-types.html" title="Node Types">Node Types</a></li>
+ <li><a href="object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a></li>
+ </ul>
</li>
- <li class="dropdown">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a>
-</li>
-
- <li> <a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a>
-</li>
-
- <li> <a href="building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a>
-</li>
-
- <li> <a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
-</li>
-
- <li> <a href="issue-tracker.html" title="Issue Tracker">Issue Tracker</a>
-</li>
-
- <li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
-</li>
-
- <li> <a href="continuous-integration.html" title="Continuous Integration">Continuous Integration</a>
-</li>
-
- <li> <a href="website.html" title="Website">Website</a>
-</li>
-
- <li> <a href="creating-releases.html" title="Creating Releases">Creating Releases</a>
-</li>
-
- <li> <a href="supporting-software-attribution.html" title="Attribution">Attribution</a>
-</li>
-
- <li> <a href="privacy-policy.html" title="Privacy">Privacy</a>
-</li>
- </ul>
+ <li><a href="jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a></li>
+ <li><a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a></li>
+ <li><a href="building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a></li>
+ <li><a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li>
+ <li><a href="issue-tracker.html" title="Issue Tracker">Issue Tracker</a></li>
+ <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li>
+ <li><a href="continuous-integration.html" title="Continuous Integration">Continuous Integration</a></li>
+ <li><a href="website.html" title="Website">Website</a></li>
+ <li><a href="creating-releases.html" title="Creating Releases">Creating Releases</a></li>
+ <li><a href="supporting-software-attribution.html" title="Attribution">Attribution</a></li>
+ </ul>
</li>
- <li class="dropdown">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a>
-</li>
- </ul>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a></li>
+ <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" title="Privacy">Privacy</a></li>
+ </ul>
</li>
- </ul>
-
-
-
-
- </div>
-
+ </ul>
</div>
</div>
- </div>
-
- <div class="container-fluid">
- <div id="banner">
- <div class="pull-left">
- <div id="bannerLeft">
- <h2>Apache Jackrabbit Site</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: 2020-07-08
- </li>
-
-
-
-
- </ul>
- </div>
+ </header>
+ <div class="container-fluid">
+ <header>
+ <div id="banner">
+ <div class="pull-left"><div id="bannerLeft"><h2>Apache Jackrabbit Site</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: 2022-05-12</li>
+ </ul>
+ </div>
+ </header>
<div class="row-fluid">
- <div id="leftColumn" class="span3">
+ <header id="leftColumn" class="span2">
+ <nav class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Apache Jackrabbit</li>
+ <li><a href="index.html" title="Welcome"><span class="none"></span>Welcome</a></li>
+ <li><a href="downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li>
+ <li><a href="articles.html" title="Articles"><span class="none"></span>Articles</a></li>
+ <li><a href="frequently-asked-questions.html" title="FAQ"><span class="none"></span>FAQ</a></li>
+ <li><a href="https://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" class="externalLink" title="Archived Jackrabbit Wiki"><span class="none"></span>Archived Jackrabbit Wiki</a></li>
+ <li><a href="jackrabbit-history.html" title="Jackrabbit History"><span class="none"></span>Jackrabbit History</a></li>
+ <li class="nav-header">Documentation</li>
+ <li><a href="getting-started-with-apache-jackrabbit.html" title="Getting Started"><span class="none"></span>Getting Started</a></li>
+ <li><a href="standalone-server.html" title="Standalone Server"><span class="none"></span>Standalone Server</a></li>
+ <li><a href="jackrabbit-components.html" title="Jackrabbit Components"><span class="none"></span>Jackrabbit Components</a></li>
+ <li><a href="first-hops.html" title="First Hops"><span class="none"></span>First Hops</a></li>
+ <li><a href="jcr-api.html" title="JCR & API"><span class="none"></span>JCR & API</a></li>
+ <li><a href="jackrabbit-architecture.html" title="Jackrabbit Architecture"><span class="none"></span>Jackrabbit Architecture</a></li>
+ <li><a href="deployment-models.html" title="Deployment Models"><span class="none"></span>Deployment Models</a></li>
+ <li><a href="jackrabbit-configuration.html" title="Jackrabbit Configuration"><span class="none"></span>Jackrabbit Configuration</a></li>
+ <li><a href="node-types.html" title="Node Types"><span class="none"></span>Node Types</a></li>
+ <li><a href="object-content-mapping.html" title="Object Content Mapping"><span class="none"></span>Object Content Mapping</a></li>
+ <li class="nav-header">Development</li>
+ <li><a href="jackrabbit-team.html" title="Jackrabbit Team"><span class="none"></span>Jackrabbit Team</a></li>
+ <li><a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap"><span class="none"></span>Jackrabbit Roadmap</a></li>
+ <li><a href="building-jackrabbit.html" title="Building Jackrabbit"><span class="none"></span>Building Jackrabbit</a></li>
+ <li><a href="mailing-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li>
+ <li><a href="issue-tracker.html" title="Issue Tracker"><span class="none"></span>Issue Tracker</a></li>
+ <li><a href="source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a></li>
+ <li><a href="continuous-integration.html" title="Continuous Integration"><span class="none"></span>Continuous Integration</a></li>
+ <li><a href="website.html" title="Website"><span class="none"></span>Website</a></li>
+ <li><a href="creating-releases.html" title="Creating Releases"><span class="none"></span>Creating Releases</a></li>
+ <li><a href="supporting-software-attribution.html" title="Attribution"><span class="none"></span>Attribution</a></li>
+ <li class="nav-header">Apache Software Foundation</li>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors"><span class="none"></span>Current Sponsors</a></li>
+ <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Privacy"><span class="none"></span>Privacy</a></li>
+ </ul>
+ </nav>
<div class="well sidebar-nav">
-
-
- <ul class="nav nav-list">
- <li class="nav-header">Apache Jackrabbit</li>
-
- <li>
-
- <a href="index.html" title="Welcome">
- <i class="none"></i>
- Welcome</a>
- </li>
-
- <li>
-
- <a href="downloads.html" title="Downloads">
- <i class="none"></i>
- Downloads</a>
- </li>
-
- <li>
-
- <a href="articles.html" title="Articles">
- <i class="none"></i>
- Articles</a>
- </li>
-
- <li>
-
- <a href="frequently-asked-questions.html" title="FAQ">
- <i class="none"></i>
- FAQ</a>
- </li>
-
- <li>
-
- <a href="http://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" class="externalLink" title="Archived Jackrabbit Wiki">
- <i class="none"></i>
- Archived Jackrabbit Wiki</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-history.html" title="Jackrabbit History">
- <i class="none"></i>
- Jackrabbit History</a>
- </li>
- <li class="nav-header">Documentation</li>
-
- <li>
-
- <a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">
- <i class="none"></i>
- Getting Started</a>
- </li>
-
- <li>
-
- <a href="standalone-server.html" title="Standalone Server">
- <i class="none"></i>
- Standalone Server</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-components.html" title="Jackrabbit Components">
- <i class="none"></i>
- Jackrabbit Components</a>
- </li>
-
- <li>
-
- <a href="first-hops.html" title="First Hops">
- <i class="none"></i>
- First Hops</a>
- </li>
-
- <li>
-
- <a href="jcr-api.html" title="JCR & API">
- <i class="none"></i>
- JCR & API</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-architecture.html" title="Jackrabbit Architecture">
- <i class="none"></i>
- Jackrabbit Architecture</a>
- </li>
-
- <li>
-
- <a href="deployment-models.html" title="Deployment Models">
- <i class="none"></i>
- Deployment Models</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-configuration.html" title="Jackrabbit Configuration">
- <i class="none"></i>
- Jackrabbit Configuration</a>
- </li>
-
- <li>
-
- <a href="node-types.html" title="Node Types">
- <i class="none"></i>
- Node Types</a>
- </li>
-
- <li>
-
- <a href="object-content-mapping.html" title="Object Content Mapping">
- <i class="none"></i>
- Object Content Mapping</a>
- </li>
- <li class="nav-header">Development</li>
-
- <li>
-
- <a href="jackrabbit-team.html" title="Jackrabbit Team">
- <i class="none"></i>
- Jackrabbit Team</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">
- <i class="none"></i>
- Jackrabbit Roadmap</a>
- </li>
-
- <li>
-
- <a href="building-jackrabbit.html" title="Building Jackrabbit">
- <i class="none"></i>
- Building Jackrabbit</a>
- </li>
-
- <li>
-
- <a href="mailing-lists.html" title="Mailing Lists">
- <i class="none"></i>
- Mailing Lists</a>
- </li>
-
- <li>
-
- <a href="issue-tracker.html" title="Issue Tracker">
- <i class="none"></i>
- Issue Tracker</a>
- </li>
-
- <li>
-
- <a href="source-repository.html" title="Source Repository">
- <i class="none"></i>
- Source Repository</a>
- </li>
-
- <li>
-
- <a href="continuous-integration.html" title="Continuous Integration">
- <i class="none"></i>
- Continuous Integration</a>
- </li>
-
- <li>
-
- <a href="website.html" title="Website">
- <i class="none"></i>
- Website</a>
- </li>
-
- <li>
-
- <a href="creating-releases.html" title="Creating Releases">
- <i class="none"></i>
- Creating Releases</a>
- </li>
-
- <li>
-
- <a href="supporting-software-attribution.html" title="Attribution">
- <i class="none"></i>
- Attribution</a>
- </li>
-
- <li>
-
- <a href="privacy-policy.html" title="Privacy">
- <i class="none"></i>
- Privacy</a>
- </li>
- <li class="nav-header">Apache Software Foundation</li>
-
- <li>
-
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction">
- <i class="none"></i>
- Introduction</a>
- </li>
-
- <li>
-
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
- <i class="none"></i>
- Sponsorship</a>
- </li>
-
- <li>
-
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors">
- <i class="none"></i>
- Current Sponsors</a>
- </li>
- </ul>
-
-
-
- <hr />
-
- <div id="poweredBy">
-
- <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
-
-
- <div class="g-plusone" data-href="http://www.apache.org/jackrabbit-site/" data-size="tall" ></div>
-
- <div class="clear"></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>
+ <hr />
+ <div id="poweredBy">
+ <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
+ </header>
+ <main id="bodyColumn" class="span10" >
+<!--
+ 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
@@ -459,59 +183,43 @@
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
- limitations under the License. --><h1>Index readers</h1>
+ limitations under the License.
+-->
+<h1>Index readers</h1>
<p>Jackrabbit uses Lucene as the underlying index implementation and provides several extensions and customizations that help improve performance in an environment where changes to the index are frequent. The extensions also cover features that are not supported by Lucene, like hierarchical queries.</p>
-<p><img src="index-readers-per-segment.jpg" alt="Per Index Segment" /></p>
-<div class="section">
-<h2>CachingIndexReader<a name="CachingIndexReader"></a></h2>
-<p>The <tt>CachingIndexReader</tt> is at the very bottom of the index reader stack in Jackrabbit. It’s main purpose is to cache the parent relationship of a node. Each node is represented with a document in the index and one of the fields is <tt>_:PARENT</tt>. The value of this field is the string representation of the parent nodes UUID. In case of the root node the the parent field contains an empty string as its value. Several queries in Jackrabbit are hierarchical and check whether a node is a descendant of another node. For the very simple case, where one needs to know if a node is the child of another node, we can just look up both nodes (lucene documents) in the index and compare the parent field on one node with the <tt>_:UUID</tt> field of the other. If they match the one is the child of the other node. When it comes to evaluating a descendant axis, this becomes much more expensive and will cause lots of document lookups in lucene. By caching the parent child relation
ship of documents, hierarchical operations can be executed much faster.</p>
-<p>The cache consists of an array of DocId instances. The length of this array corresponds to the number of documents accessible through the index reader. That is every document in the index has a corresponding cache entry in the array. Initially the cache is empty and is filled as it is accessed. There are two kinds of DocIds: PlainDocId and UUIDDocId. When the parent of a node resides in the same index segment a PlainDocId is created, which simply contains the document number of the parent. If the parent resides in a different index segment a UUIDDocId is created, which contains the UUID of the parent node. When a UUIDDocId is resolved it is passed an index reader, which allows it to get the document number for the UUID and cache it for later reuse.</p></div>
-<div class="section">
-<h2>Overwriting DocId<a name="Overwriting_DocId"></a></h2>
-<p>It may happen that a PlainDocId is present in the cache of a <tt>CachingIndexReader</tt> but must be considered invalid in the context of a call. <tt>CachingIndexReader.getParent()</tt> may be called from a ReadOnlyIndexReader instance which has the target of the PlainDocId in the set of deleted document. This indicates that the nodes has been deleted or modified. Thus it has traveled to another index segment. In this case the PlainDocId is overwritten with a UUIDDocId. The opposite never happens. A UUIDDocId is never overwritten with a PlainDocId because when a document is added to an index a new CachingIndexReader is created.</p></div>
-<div class="section">
-<h2>SharedIndexReader<a name="SharedIndexReader"></a></h2>
-<p>The SharedIndexReader wraps a CachingIndexReader and adds a reference count facility. A SharedIndexReader is kept open for the entire lifetime of a PersistentIndex. Even if documents are marked deleted in the underlying index (by another thread through CommittableIndexReader), the SharedIndexReader will still be kept open and considers the documents as valid. The reference counting is needed because it may happen that a client of the SharedIndexReader is still in use while the underlying PersistentIndex is closed. This may happen when the index merger replaces indexes while a query still operates on the indexes to be deleted. Using reference counts, closing the SharedIndexReader is delayed until all clients are finished with the SharedIndexReader.</p></div>
-<div class="section">
-<h2>ReadOnlyIndexReader<a name="ReadOnlyIndexReader"></a></h2>
-<p>The inconsistency introduced by the SharedIndexReader (considers deleted documents as still valid) is corrected by the ReadOnlyIndexReader. Whenever a new instance of this reader is created it copies the currently marked deleted documents from the CommittableIndexReader. At the same time all methods that attempt delete documents will throw a UnsupportedOperationException.</p></div>
-<div class="section">
-<h2>CommittableIndexReader<a name="CommittableIndexReader"></a></h2>
-<p>This is the index reader where documents are marked deleted in a PersistentIndex. As with the SharedIndexReader the CommittableIndexReader is kept open for the entire lifetime of the PersistentIndex. To achieve this the CommittableIndexReader exposes a method commitDeleted, which forces the underlying native lucene index reader to commit changes. Only committing changes whithout closing the index reader is otherwise not possible using the plain lucene index reader.</p></div>
-<div class="section">
-<h2>Combining the index segments<a name="Combining_the_index_segments"></a></h2>
-<p><img src="index-readers-per-query-handler.jpg" alt="Per Query Handler" /></p></div>
-<div class="section">
-<h2>CachingMultiIndexReader<a name="CachingMultiIndexReader"></a></h2>
-<p>The index for the content of a workspace consists of multiple segments, that is multiple ReadOnlyIndexReaders. They are combined in a MultiIndex using a CachingMultiIndexReader. In order to speed up lookups by UUID the CachingMultiIndexReader also has a DocNumberCache. This cache uses a LRU algorithm to keep a limited amount of UUID to document number mappings.</p></div>
-<div class="section">
-<h2>CombinedIndexReader<a name="CombinedIndexReader"></a></h2>
-<p>This index reader is similar to the CachingMultiIndexReader, in fact both implement MultiIndexReader and HierarchyResolver. A CombinedIndexReader is created when a query needs an index reader that spans both the workspace index as well as the jcr:system index, where the version store resides.</p></div>
- </div>
- </div>
- </div>
-
+<p><img src="index-readers-per-segment.jpg" alt="Per Index Segment" /></p><section>
+<h2><a name="CachingIndexReader"></a>CachingIndexReader</h2>
+<p>The <code>CachingIndexReader</code> is at the very bottom of the index reader stack in Jackrabbit. It’s main purpose is to cache the parent relationship of a node. Each node is represented with a document in the index and one of the fields is <code>_:PARENT</code>. The value of this field is the string representation of the parent nodes UUID. In case of the root node the the parent field contains an empty string as its value. Several queries in Jackrabbit are hierarchical and check whether a node is a descendant of another node. For the very simple case, where one needs to know if a node is the child of another node, we can just look up both nodes (lucene documents) in the index and compare the parent field on one node with the <code>_:UUID</code> field of the other. If they match the one is the child of the other node. When it comes to evaluating a descendant axis, this becomes much more expensive and will cause lots of document lookups in lucene. By caching the parent ch
ild relationship of documents, hierarchical operations can be executed much faster.</p>
+<p>The cache consists of an array of DocId instances. The length of this array corresponds to the number of documents accessible through the index reader. That is every document in the index has a corresponding cache entry in the array. Initially the cache is empty and is filled as it is accessed. There are two kinds of DocIds: PlainDocId and UUIDDocId. When the parent of a node resides in the same index segment a PlainDocId is created, which simply contains the document number of the parent. If the parent resides in a different index segment a UUIDDocId is created, which contains the UUID of the parent node. When a UUIDDocId is resolved it is passed an index reader, which allows it to get the document number for the UUID and cache it for later reuse.</p></section><section>
+<h2><a name="Overwriting_DocId"></a>Overwriting DocId</h2>
+<p>It may happen that a PlainDocId is present in the cache of a <code>CachingIndexReader</code> but must be considered invalid in the context of a call. <code>CachingIndexReader.getParent()</code> may be called from a ReadOnlyIndexReader instance which has the target of the PlainDocId in the set of deleted document. This indicates that the nodes has been deleted or modified. Thus it has traveled to another index segment. In this case the PlainDocId is overwritten with a UUIDDocId. The opposite never happens. A UUIDDocId is never overwritten with a PlainDocId because when a document is added to an index a new CachingIndexReader is created.</p></section><section>
+<h2><a name="SharedIndexReader"></a>SharedIndexReader</h2>
+<p>The SharedIndexReader wraps a CachingIndexReader and adds a reference count facility. A SharedIndexReader is kept open for the entire lifetime of a PersistentIndex. Even if documents are marked deleted in the underlying index (by another thread through CommittableIndexReader), the SharedIndexReader will still be kept open and considers the documents as valid. The reference counting is needed because it may happen that a client of the SharedIndexReader is still in use while the underlying PersistentIndex is closed. This may happen when the index merger replaces indexes while a query still operates on the indexes to be deleted. Using reference counts, closing the SharedIndexReader is delayed until all clients are finished with the SharedIndexReader.</p></section><section>
+<h2><a name="ReadOnlyIndexReader"></a>ReadOnlyIndexReader</h2>
+<p>The inconsistency introduced by the SharedIndexReader (considers deleted documents as still valid) is corrected by the ReadOnlyIndexReader. Whenever a new instance of this reader is created it copies the currently marked deleted documents from the CommittableIndexReader. At the same time all methods that attempt delete documents will throw a UnsupportedOperationException.</p></section><section>
+<h2><a name="CommittableIndexReader"></a>CommittableIndexReader</h2>
+<p>This is the index reader where documents are marked deleted in a PersistentIndex. As with the SharedIndexReader the CommittableIndexReader is kept open for the entire lifetime of the PersistentIndex. To achieve this the CommittableIndexReader exposes a method commitDeleted, which forces the underlying native lucene index reader to commit changes. Only committing changes whithout closing the index reader is otherwise not possible using the plain lucene index reader.</p></section><section>
+<h2><a name="Combining_the_index_segments"></a>Combining the index segments</h2>
+<p><img src="index-readers-per-query-handler.jpg" alt="Per Query Handler" /></p></section><section>
+<h2><a name="CachingMultiIndexReader"></a>CachingMultiIndexReader</h2>
+<p>The index for the content of a workspace consists of multiple segments, that is multiple ReadOnlyIndexReaders. They are combined in a MultiIndex using a CachingMultiIndexReader. In order to speed up lookups by UUID the CachingMultiIndexReader also has a DocNumberCache. This cache uses a LRU algorithm to keep a limited amount of UUID to document number mappings.</p></section><section>
+<h2><a name="CombinedIndexReader"></a>CombinedIndexReader</h2>
+<p>This index reader is similar to the CachingMultiIndexReader, in fact both implement MultiIndexReader and HierarchyResolver. A CombinedIndexReader is created when a query needs an index reader that spans both the workspace index as well as the jcr:system index, where the version store resides.</p></section>
+ </main>
+ </div>
+ </div>
<hr/>
-
<footer>
- <div class="container-fluid">
- <div class="row-fluid">
- <p >Copyright © 2020
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All rights reserved.
-
- </p>
+ <div class="container-fluid">
+ <div class="row-fluid">
+<p>© 2022
+<a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
+</p>
</div>
-
-
-
-
-
-
<div id="ohloh" class="pull-right">
- <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ <script src="https://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
</div>
</div>
</footer>
- </body>
+ </body>
</html>
\ No newline at end of file
Modified: jackrabbit/site/live/jcr/jackrabbit-architecture.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/jackrabbit-architecture.html?rev=1900838&r1=1900837&r2=1900838&view=diff
==============================================================================
--- jackrabbit/site/live/jcr/jackrabbit-architecture.html (original)
+++ jackrabbit/site/live/jcr/jackrabbit-architecture.html Thu May 12 13:18:21 2022
@@ -1,450 +1,176 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2020-07-08
- | Rendered using Apache Maven Fluido Skin 1.3.1
+ | Generated by Apache Maven Doxia Site Renderer 1.9.2 from src\site\markdown/jackrabbit-architecture.md at 2022-05-12
+ | Rendered using Apache Maven Fluido Skin 1.9
-->
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20200708" />
- <meta http-equiv="Content-Language" content="en" />
- <title>Apache Jackrabbit - Jackrabbit Architecture</title>
- <link rel="stylesheet" href="./css/apache-maven-fluido-1.3.1.min.css" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ <meta name="generator" content="Apache Maven Doxia Site Renderer 1.9.2" />
+ <title>Apache Jackrabbit – Jackrabbit Architecture</title>
+ <link rel="stylesheet" href="./css/apache-maven-fluido-1.9.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.1.min.js"></script>
-
-
- </head>
- <body class="topBarEnabled">
-
-
-
-
-
-
- <a href="http://github.com/apache/jackrabbit">
+ <script src="./js/apache-maven-fluido-1.9.min.js"></script>
+<!-- Matomo -->
+<script>
+ var _paq = window._paq = window._paq || [];
+ /* tracker methods like "setCustomDimension" should be called before "trackPageView" */
+ /* We explicitly disable cookie tracking to avoid privacy issues */
+ _paq.push(['disableCookies']);
+ _paq.push(['trackPageView']);
+ _paq.push(['enableLinkTracking']);
+ (function() {
+ var u="https://matomo.privacy.apache.org/";
+ _paq.push(['setTrackerUrl', u+'matomo.php']);
+ _paq.push(['setSiteId', '4']);
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
+ g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
+ })();
+</script>
+<!-- End Matomo Code -->
+ </head>
+ <body class="topBarEnabled">
+ <a href="https://github.com/apache/jackrabbit">
<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 ">
+ <header id="topbar" class="navbar navbar-fixed-top ">
<div class="navbar-inner">
- <div class="container-fluid">
+ <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>
-
- <a class="brand" href="index.html" title="Apache Jackrabbit">
-
-
- <img src="images/logos/jlogo.gif" alt="Apache Jackrabbit" />
-
- </a>
-
- <ul class="nav">
- <li class="dropdown">
+<a class="brand" href="index.html" title="Apache Jackrabbit"><img src="images/logos/jlogo.gif" alt="Apache Jackrabbit" />
+</a>
+ <ul class="nav">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Jackrabbit <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="index.html" title="Welcome">Welcome</a>
-</li>
-
- <li> <a href="downloads.html" title="Downloads">Downloads</a>
-</li>
-
- <li> <a href="articles.html" title="Articles">Articles</a>
-</li>
-
- <li> <a href="frequently-asked-questions.html" title="FAQ">FAQ</a>
-</li>
-
- <li> <a href="http://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" title="Archived Jackrabbit Wiki">Archived Jackrabbit Wiki</a>
-</li>
-
- <li> <a href="jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a>
-</li>
- </ul>
+ <li><a href="index.html" title="Welcome">Welcome</a></li>
+ <li><a href="downloads.html" title="Downloads">Downloads</a></li>
+ <li><a href="articles.html" title="Articles">Articles</a></li>
+ <li><a href="frequently-asked-questions.html" title="FAQ">FAQ</a></li>
+ <li><a href="https://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" title="Archived Jackrabbit Wiki">Archived Jackrabbit Wiki</a></li>
+ <li><a href="jackrabbit-history.html" title="Jackrabbit History">Jackrabbit History</a></li>
+ </ul>
</li>
- <li class="dropdown">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a>
-</li>
-
- <li> <a href="standalone-server.html" title="Standalone Server">Standalone Server</a>
-</li>
-
- <li> <a href="jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a>
-</li>
-
- <li> <a href="first-hops.html" title="First Hops">First Hops</a>
-</li>
-
- <li> <a href="jcr-api.html" title="JCR & API">JCR & API</a>
-</li>
-
- <li> <a href="jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a>
-</li>
-
- <li> <a href="deployment-models.html" title="Deployment Models">Deployment Models</a>
-</li>
-
- <li> <a href="jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a>
-</li>
-
- <li> <a href="node-types.html" title="Node Types">Node Types</a>
-</li>
-
- <li> <a href="object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a>
-</li>
- </ul>
+ <li><a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">Getting Started</a></li>
+ <li><a href="standalone-server.html" title="Standalone Server">Standalone Server</a></li>
+ <li><a href="jackrabbit-components.html" title="Jackrabbit Components">Jackrabbit Components</a></li>
+ <li><a href="first-hops.html" title="First Hops">First Hops</a></li>
+ <li><a href="jcr-api.html" title="JCR & API">JCR & API</a></li>
+ <li><a href="jackrabbit-architecture.html" title="Jackrabbit Architecture">Jackrabbit Architecture</a></li>
+ <li><a href="deployment-models.html" title="Deployment Models">Deployment Models</a></li>
+ <li><a href="jackrabbit-configuration.html" title="Jackrabbit Configuration">Jackrabbit Configuration</a></li>
+ <li><a href="node-types.html" title="Node Types">Node Types</a></li>
+ <li><a href="object-content-mapping.html" title="Object Content Mapping">Object Content Mapping</a></li>
+ </ul>
</li>
- <li class="dropdown">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Development <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a>
-</li>
-
- <li> <a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a>
-</li>
-
- <li> <a href="building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a>
-</li>
-
- <li> <a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a>
-</li>
-
- <li> <a href="issue-tracker.html" title="Issue Tracker">Issue Tracker</a>
-</li>
-
- <li> <a href="source-repository.html" title="Source Repository">Source Repository</a>
-</li>
-
- <li> <a href="continuous-integration.html" title="Continuous Integration">Continuous Integration</a>
-</li>
-
- <li> <a href="website.html" title="Website">Website</a>
-</li>
-
- <li> <a href="creating-releases.html" title="Creating Releases">Creating Releases</a>
-</li>
-
- <li> <a href="supporting-software-attribution.html" title="Attribution">Attribution</a>
-</li>
-
- <li> <a href="privacy-policy.html" title="Privacy">Privacy</a>
-</li>
- </ul>
+ <li><a href="jackrabbit-team.html" title="Jackrabbit Team">Jackrabbit Team</a></li>
+ <li><a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">Jackrabbit Roadmap</a></li>
+ <li><a href="building-jackrabbit.html" title="Building Jackrabbit">Building Jackrabbit</a></li>
+ <li><a href="mailing-lists.html" title="Mailing Lists">Mailing Lists</a></li>
+ <li><a href="issue-tracker.html" title="Issue Tracker">Issue Tracker</a></li>
+ <li><a href="source-repository.html" title="Source Repository">Source Repository</a></li>
+ <li><a href="continuous-integration.html" title="Continuous Integration">Continuous Integration</a></li>
+ <li><a href="website.html" title="Website">Website</a></li>
+ <li><a href="creating-releases.html" title="Creating Releases">Creating Releases</a></li>
+ <li><a href="supporting-software-attribution.html" title="Attribution">Attribution</a></li>
+ </ul>
</li>
- <li class="dropdown">
+ <li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Apache Software Foundation <b class="caret"></b></a>
<ul class="dropdown-menu">
-
- <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a>
-</li>
-
- <li> <a href="http://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a>
-</li>
- </ul>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" title="Introduction">Introduction</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" title="Current Sponsors">Current Sponsors</a></li>
+ <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" title="Privacy">Privacy</a></li>
+ </ul>
</li>
- </ul>
-
-
-
-
- </div>
-
+ </ul>
</div>
</div>
- </div>
-
- <div class="container-fluid">
- <div id="banner">
- <div class="pull-left">
- <div id="bannerLeft">
- <h2>Apache Jackrabbit Site</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: 2020-07-08
- </li>
-
-
-
-
- </ul>
- </div>
+ </header>
+ <div class="container-fluid">
+ <header>
+ <div id="banner">
+ <div class="pull-left"><div id="bannerLeft"><h2>Apache Jackrabbit Site</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: 2022-05-12</li>
+ </ul>
+ </div>
+ </header>
<div class="row-fluid">
- <div id="leftColumn" class="span3">
+ <header id="leftColumn" class="span2">
+ <nav class="well sidebar-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Apache Jackrabbit</li>
+ <li><a href="index.html" title="Welcome"><span class="none"></span>Welcome</a></li>
+ <li><a href="downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li>
+ <li><a href="articles.html" title="Articles"><span class="none"></span>Articles</a></li>
+ <li><a href="frequently-asked-questions.html" title="FAQ"><span class="none"></span>FAQ</a></li>
+ <li><a href="https://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" class="externalLink" title="Archived Jackrabbit Wiki"><span class="none"></span>Archived Jackrabbit Wiki</a></li>
+ <li><a href="jackrabbit-history.html" title="Jackrabbit History"><span class="none"></span>Jackrabbit History</a></li>
+ <li class="nav-header">Documentation</li>
+ <li><a href="getting-started-with-apache-jackrabbit.html" title="Getting Started"><span class="none"></span>Getting Started</a></li>
+ <li><a href="standalone-server.html" title="Standalone Server"><span class="none"></span>Standalone Server</a></li>
+ <li><a href="jackrabbit-components.html" title="Jackrabbit Components"><span class="none"></span>Jackrabbit Components</a></li>
+ <li><a href="first-hops.html" title="First Hops"><span class="none"></span>First Hops</a></li>
+ <li><a href="jcr-api.html" title="JCR & API"><span class="none"></span>JCR & API</a></li>
+ <li class="active"><a href="#"><span class="none"></span>Jackrabbit Architecture</a></li>
+ <li><a href="deployment-models.html" title="Deployment Models"><span class="none"></span>Deployment Models</a></li>
+ <li><a href="jackrabbit-configuration.html" title="Jackrabbit Configuration"><span class="none"></span>Jackrabbit Configuration</a></li>
+ <li><a href="node-types.html" title="Node Types"><span class="none"></span>Node Types</a></li>
+ <li><a href="object-content-mapping.html" title="Object Content Mapping"><span class="none"></span>Object Content Mapping</a></li>
+ <li class="nav-header">Development</li>
+ <li><a href="jackrabbit-team.html" title="Jackrabbit Team"><span class="none"></span>Jackrabbit Team</a></li>
+ <li><a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap"><span class="none"></span>Jackrabbit Roadmap</a></li>
+ <li><a href="building-jackrabbit.html" title="Building Jackrabbit"><span class="none"></span>Building Jackrabbit</a></li>
+ <li><a href="mailing-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li>
+ <li><a href="issue-tracker.html" title="Issue Tracker"><span class="none"></span>Issue Tracker</a></li>
+ <li><a href="source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a></li>
+ <li><a href="continuous-integration.html" title="Continuous Integration"><span class="none"></span>Continuous Integration</a></li>
+ <li><a href="website.html" title="Website"><span class="none"></span>Website</a></li>
+ <li><a href="creating-releases.html" title="Creating Releases"><span class="none"></span>Creating Releases</a></li>
+ <li><a href="supporting-software-attribution.html" title="Attribution"><span class="none"></span>Attribution</a></li>
+ <li class="nav-header">Apache Software Foundation</li>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction"><span class="none"></span>Introduction</a></li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship"><span class="none"></span>Sponsorship</a></li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors"><span class="none"></span>Current Sponsors</a></li>
+ <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" class="externalLink" title="Privacy"><span class="none"></span>Privacy</a></li>
+ </ul>
+ </nav>
<div class="well sidebar-nav">
-
-
- <ul class="nav nav-list">
- <li class="nav-header">Apache Jackrabbit</li>
-
- <li>
-
- <a href="index.html" title="Welcome">
- <i class="none"></i>
- Welcome</a>
- </li>
-
- <li>
-
- <a href="downloads.html" title="Downloads">
- <i class="none"></i>
- Downloads</a>
- </li>
-
- <li>
-
- <a href="articles.html" title="Articles">
- <i class="none"></i>
- Articles</a>
- </li>
-
- <li>
-
- <a href="frequently-asked-questions.html" title="FAQ">
- <i class="none"></i>
- FAQ</a>
- </li>
-
- <li>
-
- <a href="http://jackrabbit.apache.org/archive/wiki/JCR/Home_70731.html" class="externalLink" title="Archived Jackrabbit Wiki">
- <i class="none"></i>
- Archived Jackrabbit Wiki</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-history.html" title="Jackrabbit History">
- <i class="none"></i>
- Jackrabbit History</a>
- </li>
- <li class="nav-header">Documentation</li>
-
- <li>
-
- <a href="getting-started-with-apache-jackrabbit.html" title="Getting Started">
- <i class="none"></i>
- Getting Started</a>
- </li>
-
- <li>
-
- <a href="standalone-server.html" title="Standalone Server">
- <i class="none"></i>
- Standalone Server</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-components.html" title="Jackrabbit Components">
- <i class="none"></i>
- Jackrabbit Components</a>
- </li>
-
- <li>
-
- <a href="first-hops.html" title="First Hops">
- <i class="none"></i>
- First Hops</a>
- </li>
-
- <li>
-
- <a href="jcr-api.html" title="JCR & API">
- <i class="none"></i>
- JCR & API</a>
- </li>
-
- <li class="active">
-
- <a href="#"><i class="none"></i>Jackrabbit Architecture</a>
- </li>
-
- <li>
-
- <a href="deployment-models.html" title="Deployment Models">
- <i class="none"></i>
- Deployment Models</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-configuration.html" title="Jackrabbit Configuration">
- <i class="none"></i>
- Jackrabbit Configuration</a>
- </li>
-
- <li>
-
- <a href="node-types.html" title="Node Types">
- <i class="none"></i>
- Node Types</a>
- </li>
-
- <li>
-
- <a href="object-content-mapping.html" title="Object Content Mapping">
- <i class="none"></i>
- Object Content Mapping</a>
- </li>
- <li class="nav-header">Development</li>
-
- <li>
-
- <a href="jackrabbit-team.html" title="Jackrabbit Team">
- <i class="none"></i>
- Jackrabbit Team</a>
- </li>
-
- <li>
-
- <a href="jackrabbit-roadmap.html" title="Jackrabbit Roadmap">
- <i class="none"></i>
- Jackrabbit Roadmap</a>
- </li>
-
- <li>
-
- <a href="building-jackrabbit.html" title="Building Jackrabbit">
- <i class="none"></i>
- Building Jackrabbit</a>
- </li>
-
- <li>
-
- <a href="mailing-lists.html" title="Mailing Lists">
- <i class="none"></i>
- Mailing Lists</a>
- </li>
-
- <li>
-
- <a href="issue-tracker.html" title="Issue Tracker">
- <i class="none"></i>
- Issue Tracker</a>
- </li>
-
- <li>
-
- <a href="source-repository.html" title="Source Repository">
- <i class="none"></i>
- Source Repository</a>
- </li>
-
- <li>
-
- <a href="continuous-integration.html" title="Continuous Integration">
- <i class="none"></i>
- Continuous Integration</a>
- </li>
-
- <li>
-
- <a href="website.html" title="Website">
- <i class="none"></i>
- Website</a>
- </li>
-
- <li>
-
- <a href="creating-releases.html" title="Creating Releases">
- <i class="none"></i>
- Creating Releases</a>
- </li>
-
- <li>
-
- <a href="supporting-software-attribution.html" title="Attribution">
- <i class="none"></i>
- Attribution</a>
- </li>
-
- <li>
-
- <a href="privacy-policy.html" title="Privacy">
- <i class="none"></i>
- Privacy</a>
- </li>
- <li class="nav-header">Apache Software Foundation</li>
-
- <li>
-
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="Introduction">
- <i class="none"></i>
- Introduction</a>
- </li>
-
- <li>
-
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsorship">
- <i class="none"></i>
- Sponsorship</a>
- </li>
-
- <li>
-
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Current Sponsors">
- <i class="none"></i>
- Current Sponsors</a>
- </li>
- </ul>
-
-
-
- <hr />
-
- <div id="poweredBy">
-
- <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
-
-
- <div class="g-plusone" data-href="http://www.apache.org/jackrabbit-site/" data-size="tall" ></div>
-
- <div class="clear"></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>
+ <hr />
+ <div id="poweredBy">
+ <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
+ </header>
+ <main id="bodyColumn" class="span10" >
+<!--
+ 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
@@ -457,108 +183,78 @@
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
- limitations under the License. --><h1>Jackrabbit Architecture</h1>
-
+ limitations under the License.
+-->
+<h1>Jackrabbit Architecture</h1>
<ul>
-
+
<li><a href="how-jackrabbit-works.html">How Jackrabbit works</a></li>
-
<li><a href="repository-lifecycle.html">Repository lifecycle</a></li>
-
<li><a href="search-implementation.html">Search implementation</a></li>
-
<li><a href="index-readers.html">Index readers</a></li>
-
<li><a href="concurrency-control.html">Concurrency control</a></li>
</ul>
<p>The general architecture of Jackrabbit can be described in three Layers: A Content Application Layer, an API Layer and a Content Repository Implementation Layer.</p>
-<p><img src="jackrabbit-architecture.png" alt="Jackrabbit Architecture Overview" /></p>
-<div class="section">
-<h2>Content Applications<a name="Content_Applications"></a></h2>
+<p><img src="jackrabbit-architecture.png" alt="Jackrabbit Architecture Overview" /></p><section>
+<h2><a name="Content_Applications"></a>Content Applications</h2>
<p>Content Applications interact through the JSR-170 API with the Content Repository Implementation. There are numerous applications that are available for JSR-170 repositories, some of them are very generic (like a WebDAV server) other applications can be very specific and make use of the content repository as a store for the information that is used by the applications. Java Applications can use a JSR-170 content repository as a replacement for anything from property-files, XML-configuration, certain portions of relational database functionality to straight file system or blob-management. Using a content repository allows an application to deal with an arbitrarily large hierarchical space in a scalable manner automatically profiting from the repository services such as versioning, query, transactions or namespaces which make a content repository an ideal data store for many applications.</p>
<p>A “Generic Content Application” (an application that has no particular functional focus but just allows for generic introspection and manipulation of the repository) uses the capabilities of the node types, access control and other facilities to display a user interface or a network protocol to the end user, seemingly independent from the content that is stored in the repository. Examples of such generic applications are “The Content Explorer”, “WebDAV Server” or a “Subversion Server”. (Or generic Portal, CMS or DMS applications).</p>
-<p>A “Specialized Content Application” operates under the assumption that there are certain node types that it operates on, and that it is familiar at least partially with the data model exposed by defined node types. Mostly these node types are defined by the application itself and ship with the application. These applications use a content repository as their persistence layer as a natural evolution from the use of an RDBMS or a file system. Examples of “Specialized Content Applications” have a very wide range from a “DVD Collection Management”, to a “Message Board”, to “Workflow and BPM” but also possibly complete next generation “Enterprise Resource Planning Systems”.</p></div>
-<div class="section">
-<h2>Content Repository API<a name="Content_Repository_API"></a></h2>
+<p>A “Specialized Content Application” operates under the assumption that there are certain node types that it operates on, and that it is familiar at least partially with the data model exposed by defined node types. Mostly these node types are defined by the application itself and ship with the application. These applications use a content repository as their persistence layer as a natural evolution from the use of an RDBMS or a file system. Examples of “Specialized Content Applications” have a very wide range from a “DVD Collection Management”, to a “Message Board”, to “Workflow and BPM” but also possibly complete next generation “Enterprise Resource Planning Systems”.</p></section><section>
+<h2><a name="Content_Repository_API"></a>Content Repository API</h2>
<p>The Content Repository API Layer is split into two major sections.</p>
-
<ul>
-
+
<li>
-<p>The Content Repository API defined by JSR-170</p></li>
-
+
+<p>The Content Repository API defined by JSR-170</p>
+</li>
<li>
-<p>A number features of a content repository, that have been removed from the JSR-170 specification since they are difficult to implement on existing non-java-based content repositories and administrational Repository tasks that have also been deliberately excluded from JSR-170</p></li>
+
+<p>A number features of a content repository, that have been removed from the JSR-170 specification since they are difficult to implement on existing non-java-based content repositories and administrational Repository tasks that have also been deliberately excluded from JSR-170</p>
+</li>
</ul>
<p>There are only very few (mostly administrational) applications which make use of the non-JSR-170 APIs provided by Jackrabbit.</p>
-<p>The boxes in the architecture chart do not symbolize package names or class names directly but mostly semantically grouped blocks of functionality.</p></div>
-<div class="section">
-<h2>Content Repository Implementation<a name="Content_Repository_Implementation"></a></h2>
+<p>The boxes in the architecture chart do not symbolize package names or class names directly but mostly semantically grouped blocks of functionality.</p></section><section>
+<h2><a name="Content_Repository_Implementation"></a>Content Repository Implementation</h2>
<p>The content Repository Implementation portion of the architecture chart reflects the major building blocks of the jackrabbit content repository implementation.</p>
<p>The size of the blocks symbolizes roughly the amount of code and therefore the complexity of the individual functional block. Again the functional blocks do not directly map to package or class names.</p>
<p>There are three scopes in a content repository: A repository scope, a workspace scope and a session scope.</p>
<p>Every function that is operated against a repository can be attributed to at least one of these scopes, some functions can operate on more than one scope.</p>
-
<ul>
-
+
<li>Repository</li>
-
<li>Nodetype</li>
-
<li>Version</li>
-
<li>NamespaceRegistry</li>
-
<li>Workspace</li>
-
<li>Query</li>
-
<li>Observation</li>
-
<li>State</li>
-
<li>Xml</li>
-
<li>Session</li>
-
<li>Path</li>
-
<li>HierarchyManager</li>
-
<li>QName</li>
-
<li>ItemImpl, PropertyImpl, NodeImpl</li>
-
<li>ItemId, PropertyId, NodeId</li>
-
<li>ItemManager</li>
</ul>
-<p>This is not a complete list but includes some of the most important component of the content repository implementation.</p></div>
- </div>
- </div>
- </div>
-
+<p>This is not a complete list but includes some of the most important component of the content repository implementation.</p></section>
+ </main>
+ </div>
+ </div>
<hr/>
-
<footer>
- <div class="container-fluid">
- <div class="row-fluid">
- <p >Copyright © 2020
- <a href="http://www.apache.org/">The Apache Software Foundation</a>.
- All rights reserved.
-
- </p>
+ <div class="container-fluid">
+ <div class="row-fluid">
+<p>© 2022
+<a href="https://www.apache.org/">The Apache Software Foundation</a> | <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a>
+</p>
</div>
-
-
-
-
-
-
<div id="ohloh" class="pull-right">
- <script type="text/javascript" src="http://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
+ <script src="https://www.ohloh.net/p/jackrabbit/widgets/project_users_logo.js"></script>
</div>
</div>
</footer>
- </body>
+ </body>
</html>
\ No newline at end of file