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 [13/50] - in /jackrabbit/site/live/jcr: ./ components/ css/ images/ js/ ocm/ status/
Modified: jackrabbit/site/live/jcr/embedded-repository.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/embedded-repository.html?rev=1900838&r1=1900837&r2=1900838&view=diff
==============================================================================
--- jackrabbit/site/live/jcr/embedded-repository.html (original)
+++ jackrabbit/site/live/jcr/embedded-repository.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/embedded-repository.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 - Embedded Repository</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 – Embedded Repository</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,15 +183,16 @@
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>Embedded Repository</h1>
+ limitations under the License.
+-->
+<h1>Embedded Repository</h1>
<p>You can run Jackrabbit in embedded mode inside your application if you only (or mostly) access a repository from that one application. In this deployment model the Jackrabbit dependencies are included directly in your classpath and your application is in full control of the repository lifecycle. To use this deployment model you need to add the appropriate dependencies to your application and include a few lines of Jackrabbit-specific code to start and stop a repository. You can then use the standard JCR API to access and manage content inside the repository.</p>
-<p>This page describes how to embed Jackrabbit in your application.</p>
-<div class="section">
-<h2>Jackrabbit dependencies<a name="Jackrabbit_dependencies"></a></h2>
+<p>This page describes how to embed Jackrabbit in your application.</p><section>
+<h2><a name="Jackrabbit_dependencies"></a>Jackrabbit dependencies</h2>
<p>To use Jackrabbit in embedded mode you need to make sure that the JCR API and all required Jackrabbit libraries are included in your classpath. If you use <a class="externalLink" href="http://maven.apache.org/">Maven 2</a> , you can achieve this by specifying the following dependencies.</p>
<div class="source">
-<pre><dependency>
+<div class="source"><pre class="prettyprint linenums"><dependency>
<groupId>javax.jcr</groupId>
<artifactId>jcr</artifactId>
<version>1.0</version>
@@ -493,14 +218,15 @@
<artifactId>slf4j-log4j12</artifactId>
<version>1.5.3</version>
</dependency>
-</pre></div>
+</pre></div></div>
+
<p>The jcr dependency includes the JCR 1.0 API in your classpath. You need to explicitly declare this dependency as in jackrabbit-core the JCR API dependency scope is <i>provided</i> to work better in deployment models where the JCR API is shared between multiple applications.</p>
-<p>The jackrabbit-core dependency pulls in the Jackrabbit content repository implementation and a set of transitive dependencies needed by Jackrabbit. See the <a href="downloads.html">Downloads</a> page for the latest available version.</p>
-<p>Jackrabbit uses the <a class="externalLink" href="http://www.slf4j.org/">SLF4J</a> for logging and leaves it up to the embedding application to decide which underlying logging library to use. In the example above we use the slf4j-log4j12 library which uses <a class="externalLink" href="http://logging.apache.org/log4j/1.2/">log4j 1.2</a> for handling the log messages. Note that the commons-logging dependency (which is a transitive dependency from <a class="externalLink" href="http://poi.apache.org/">Apache POI</a> ) is explicitly replaced with the jcl-over-slf4j dependency that routes also all <a class="externalLink" href="http://commons.apache.org/logging/">Commons Logging</a> log messages through the selected SLF4J implementation. Jackrabbit 1.5.x uses SLF4J version 1.5.3.</p>
-<p>The full set of compile-scope dependencies included by the above declaration is shown below. If you use a build tool like <a class="externalLink" href="http://ant.apache.org/">Ant</a> where you need to explicitly include all dependencies, you can use this list to correctly configure your classpath.</p>
+<p>The jackrabbit-core dependency pulls in the Jackrabbit content repository implementation and a set of transitive dependencies needed by Jackrabbit. See the <a href="downloads.html">Downloads</a> page for the latest available version.</p>
+<p>Jackrabbit uses the <a class="externalLink" href="http://www.slf4j.org/">SLF4J</a> for logging and leaves it up to the embedding application to decide which underlying logging library to use. In the example above we use the slf4j-log4j12 library which uses <a class="externalLink" href="http://logging.apache.org/log4j/1.2/">log4j 1.2</a> for handling the log messages. Note that the commons-logging dependency (which is a transitive dependency from <a class="externalLink" href="http://poi.apache.org/">Apache POI</a> ) is explicitly replaced with the jcl-over-slf4j dependency that routes also all <a class="externalLink" href="http://commons.apache.org/logging/">Commons Logging</a> log messages through the selected SLF4J implementation. Jackrabbit 1.5.x uses SLF4J version 1.5.3.</p>
+<p>The full set of compile-scope dependencies included by the above declaration is shown below. If you use a build tool like <a class="externalLink" href="http://ant.apache.org/">Ant</a> where you need to explicitly include all dependencies, you can use this list to correctly configure your classpath.</p>
<div class="source">
-<pre>+- javax.jcr:jcr:jar:1.0:compile
+<div class="source"><pre class="prettyprint linenums">+- javax.jcr:jcr:jar:1.0:compile
+- org.apache.jackrabbit:jackrabbit-core:jar:1.5.0:compile
| +- concurrent:concurrent:jar:1.3.4:compile
| +- commons-collections:commons-collections:jar:3.1:compile
@@ -516,22 +242,22 @@
| | | +- org.fontbox:fontbox:jar:0.1.0:compile
| | | \- org.jempbox:jempbox:jar:0.2.0:compile
| | \- net.sourceforge.nekohtml:nekohtml:jar:1.9.7:compile
-| | \- xerces:xercesImpl:jar:2.8.1:compile
-| | \- xml-apis:xml-apis:jar:1.3.03:compile
+| | \- xerces:xercesImpl:jar:2.8.1:compile
+| | \- xml-apis:xml-apis:jar:1.3.03:compile
| +- org.slf4j:slf4j-api:jar:1.5.3:compile
| +- org.apache.lucene:lucene-core:jar:2.3.2:compile
| \- org.apache.derby:derby:jar:10.2.1.6:compile
+- org.slf4j:jcl-over-slf4j:jar:1.5.3:compile
\- org.slf4j:slf4j-log4j12:jar:1.5.3:compile
\- log4j:log4j:jar:1.2.14:compile
-</pre></div>
-<p>Note that some of the transitive dependencies listed above may conflict with some other dependencies of our application. In such cases you may want to consider switching to a deployment model that uses separate class loaders for your application and the Jackrabbit content repository.</p></div>
-<div class="section">
-<h2>Starting the repository<a name="Starting_the_repository"></a></h2>
+</pre></div></div>
+
+<p>Note that some of the transitive dependencies listed above may conflict with some other dependencies of our application. In such cases you may want to consider switching to a deployment model that uses separate class loaders for your application and the Jackrabbit content repository.</p></section><section>
+<h2><a name="Starting_the_repository"></a>Starting the repository</h2>
<p>Once you have your classpath configured you can start the repository with the following piece of code.</p>
<div class="source">
-<pre>import javax.jcr.Repository;
+<div class="source"><pre class="prettyprint linenums">import javax.jcr.Repository;
import org.apache.jackrabbit.core.RepositoryImpl;
import org.apache.jackrabbit.core.config.RepositoryConfig;
@@ -539,42 +265,43 @@ String xml = "/path/to/repository/c
String dir = "/path/to/repository/directory";
RepositoryConfig config = RepositoryConfig.create(xml, dir);
Repository repository = RepositoryImpl.create(config);
-</pre></div>
-<p>See the [Jackrabbit Configuration] page for more information on repository configuration. See the <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/core/config/RepositoryConfig.html">RepositoryConfig</a> and <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/core/RepositoryImpl.html">RepositoryImpl</a> javadocs for more details on these classes.</p></div>
-<div class="section">
-<h2>Shutting down the repository<a name="Shutting_down_the_repository"></a></h2>
+</pre></div></div>
+
+<p>See the [Jackrabbit Configuration] page for more information on repository configuration. See the <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/core/config/RepositoryConfig.html">RepositoryConfig</a> and <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/core/RepositoryImpl.html">RepositoryImpl</a> javadocs for more details on these classes.</p></section><section>
+<h2><a name="Shutting_down_the_repository"></a>Shutting down the repository</h2>
<p>When your application no longer needs the content repository, you can shut it down with the following code.</p>
<div class="source">
-<pre>((RepositoryImpl) repository).shutdown();
-</pre></div>
-<p>This will forcibly close all open sessions and make sure that all repository content is safely stored on disk.</p></div>
-<div class="section">
-<h2>The TransientRepository class<a name="The_TransientRepository_class"></a></h2>
-<p>Jackrabbit comes with a <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/core/TransientRepository.html">TransientRepository</a> class that makes it even easier to get started with a content repository. This class is especially handy for quick prototyping, but using the RepositoryImpl class as described above gives you better control over the repository lifecycle and is typically a better alternative for production code.</p>
+<div class="source"><pre class="prettyprint linenums">((RepositoryImpl) repository).shutdown();
+</pre></div></div>
+
+<p>This will forcibly close all open sessions and make sure that all repository content is safely stored on disk.</p></section><section>
+<h2><a name="The_TransientRepository_class"></a>The TransientRepository class</h2>
+<p>Jackrabbit comes with a <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/core/TransientRepository.html">TransientRepository</a> class that makes it even easier to get started with a content repository. This class is especially handy for quick prototyping, but using the RepositoryImpl class as described above gives you better control over the repository lifecycle and is typically a better alternative for production code.</p>
<div class="source">
-<pre>import javax.jcr.Repository;
+<div class="source"><pre class="prettyprint linenums">import javax.jcr.Repository;
import org.apache.jackrabbit.core.TransientRepository;
Repository repository = new TransientRepository();
-</pre></div>
-<p>This creates a repository instance that starts up when the first session is created and automatically shuts down when the last session is closed. By default the repository will be created in a “jackrabbit” subdirectory using a default configuration file in <tt>jackrabbit/repository.xml</tt>. See the TransientRepository javadocs for the ways to override these defaults.</p></div>
-<div class="section">
-<h2>Enabling remote access<a name="Enabling_remote_access"></a></h2>
+</pre></div></div>
+
+<p>This creates a repository instance that starts up when the first session is created and automatically shuts down when the last session is closed. By default the repository will be created in a “jackrabbit” subdirectory using a default configuration file in <code>jackrabbit/repository.xml</code>. See the TransientRepository javadocs for the ways to override these defaults.</p></section><section>
+<h2><a name="Enabling_remote_access"></a>Enabling remote access</h2>
<p>Even if you mostly use the content repository in embedded mode within your application, it may occasionally be useful to be able to access the repository for example from an external administration tool while your application is still running. You can use the jackrabbit-jcr-rmi library to make this possible. To do this, you first need to add the appropriate dependency.</p>
<div class="source">
-<pre><dependency>
+<div class="source"><pre class="prettyprint linenums"><dependency>
<groupId>org.apache.jackrabbit</groupId>
<artifactId>jackrabbit-jcr-rmi</artifactId>
<version>1.5.0</version>
</dependency>
-</pre></div>
-<p>Make sure that you have <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/rmiregistry.html">rmiregistry</a> running, and use the following code to export the repository. Note that you need to include the JCR API and the jackrabbit-jcr-rmi libraries in the rmiregistry classpath for the binding to work without extra RMI codebase settings.</p>
+</pre></div></div>
+
+<p>Make sure that you have <a class="externalLink" href="http://java.sun.com/j2se/1.5.0/docs/tooldocs/solaris/rmiregistry.html">rmiregistry</a> running, and use the following code to export the repository. Note that you need to include the JCR API and the jackrabbit-jcr-rmi libraries in the rmiregistry classpath for the binding to work without extra RMI codebase settings.</p>
<div class="source">
-<pre>import java.rmi.Naming;
+<div class="source"><pre class="prettyprint linenums">import java.rmi.Naming;
import org.apache.jackrabbit.rmi.server.RemoteAdapterFactory;
import org.apache.jackrabbit.rmi.server.RemoteRepository;
import org.apache.jackrabbit.rmi.jackrabbit.JackrabbitRemoteAdapterFactory;
@@ -584,47 +311,51 @@ repository
RemoteAdapterFactory factory = new JackrabbitRemoteAdapterFactory();
RemoteRepository remote = factory.getRemoteRepository(repository);
Naming.bind(url, remote);
-</pre></div>
+</pre></div></div>
+
<p>Use the following code to remote the repository binding from the RMI registry before you shutdown the repository.</p>
<div class="source">
-<pre>Naming.unbind(url);
-</pre></div>
+<div class="source"><pre class="prettyprint linenums">Naming.unbind(url);
+</pre></div></div>
+
<p>You need to keep a direct reference to the RemoteRepository instance in your code until you call Naming.unbind as otherwise it could get garbage collected before a remote client connects to it.</p>
-<p>See the <a href="repository-server.html">Repository Server</a> page for instructions on how to access such a remote repository.</p></div>
-<div class="section">
-<h2>Embedded repository in a web application<a name="Embedded_repository_in_a_web_application"></a></h2>
+<p>See the <a href="repository-server.html">Repository Server</a> page for instructions on how to access such a remote repository.</p></section><section>
+<h2><a name="Embedded_repository_in_a_web_application"></a>Embedded repository in a web application</h2>
<p>If your want to embed Jackrabbit in a web application, you can use the classes in the jackrabbit-jcr-servlet library to avoid the above startup and shutdown code. To do this, you first need to include jackrabbit-jcr-servlet as a dependency.</p>
<div class="source">
-<pre><dependency>
+<div class="source"><pre class="prettyprint linenums"><dependency>
<groupId>org.apache.jackrabbit</groupId>
<artifactId>jackrabbit-jcr-servlet</artifactId>
<version>1.5.0</version>
</dependency>
-</pre></div>
+</pre></div></div>
+
<p>Then you can instruct the servlet container to automatically start and stop the repository as a part of your webapp lifecycle by including the following servlet configuration in your web.xml file.</p>
<div class="source">
-<pre><servlet>
+<div class="source"><pre class="prettyprint linenums"><servlet>
<servlet-name>ContentRepository</servlet-name>
<servlet-class>org.apache.jackrabbit.servlet.jackrabbit.JackrabbitRepositoryServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
-</pre></div>
-<p>See the <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/servlet/jackrabbit/JackrabbitRepositoryServlet.html">JackrabbitRepositoryServlet</a> javadocs for the available configuration options.</p>
+</pre></div></div>
+
+<p>See the <a class="externalLink" href="http://jackrabbit.apache.org/api/1.5/org/apache/jackrabbit/servlet/jackrabbit/JackrabbitRepositoryServlet.html">JackrabbitRepositoryServlet</a> javadocs for the available configuration options.</p>
<p>You can then access the repository in your own servlet classes using the following piece of code without worrying about the repository lifecycle.</p>
<div class="source">
-<pre>import javax.jcr.Repository;
+<div class="source"><pre class="prettyprint linenums">import javax.jcr.Repository;
import org.apache.jackrabbit.servlet.ServletRepository;
-</pre></div>
+</pre></div></div>
+
<p>Repository repository = new ServletRepository(this); // “this” is the containing servlet</p>
<p>The benefit of this approach over directly using the RepositoryImpl or TransientRepository classes as described above is that you can later on switch to a different deployment model without any code changes simply by modifying the servlet configuration in your web.xml.</p>
<p>With this approach it is also easier to make your repository remotely available. Add the following configuration to your web.xml and your repository is automatically made available as a remote repository at …/rmi in the URL space of your webapp.</p>
<div class="source">
-<pre><servlet>
+<div class="source"><pre class="prettyprint linenums"><servlet>
<servlet-name>RemoteRepository</servlet-name>
<servlet-class>org.apache.jackrabbit.servlet.remote.RemoteBindingServlet</servlet-class>
</servlet>
@@ -632,33 +363,24 @@ import org.apache.jackrabbit.servlet.Ser
<servlet-name>RemoteRepository</servlet-name>
<url-pattern>/rmi</url-pattern>
</servlet-mapping>
-</pre></div>
-<p>Note that you also need the jackrabbit-jcr-rmi dependency in your application for the above configuration to work.</p></div>
- </div>
- </div>
- </div>
+</pre></div></div>
+<p>Note that you also need the jackrabbit-jcr-rmi dependency in your application for the above configuration to work.</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/how-jackrabbit-works.html
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/how-jackrabbit-works.html?rev=1900838&r1=1900837&r2=1900838&view=diff
==============================================================================
--- jackrabbit/site/live/jcr/how-jackrabbit-works.html (original)
+++ jackrabbit/site/live/jcr/how-jackrabbit-works.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/how-jackrabbit-works.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 - How Jackrabbit works</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 – How Jackrabbit works</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,65 +183,58 @@
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>How Jackrabbit works</h1>
+ limitations under the License.
+-->
+<h1>How Jackrabbit works</h1>
<p>The diagram on the left explains which components of the Jackrabbit are used when a user of the JCR API modified content in the content repository. This is a simple and very common operation, that touches a large portion of the components in the Jackrabbit implementation. Please keep in mind that this implementation architecture is not mandated by JCR, but has been designed from scratch based on JCR.</p>
<p><img src="how-jackrabbit-works-ism.jpg" alt="Item State Manager" /></p>
<p>The used components and their respective functions in the order of their appearance in the use case of writing or modifying content in the content repository:</p>
-
<ul>
-
-<li><b>Transient Item State Manager</b><br />Once content items are read by a session they are cached in the Transient Item State Manager. When those items are modified the modification is only visible to that same session, in the so-called “transient” space.</li>
-</ul>
-<ul>
-
-<li><b>Transactional Item State Manager</b> When the Application persists the modified items using the JCR <tt>Item.save()</tt> or <tt>Session.save()</tt> the transient Items are promoted into the Transactional ISM. The modifications are still only visible within the scope of this transaction, meaning that other sessions will not see the modification until they are committed. The commit is implicit if the Content Repository is not running in an XA environment.</li>
-</ul>
+<li>
-<ul>
-
-<li><b>Shared Item State Manager</b> Once a transaction is committed the Shared Item State Manager receives the changelog and publishes the changes to all the sessions logged into the same workspace. This means that all the Item States that are cached and referenced by other sessions are notified and possibly updated or invalidated. The Shared Item State Manager also triggers the observation and hands the changelog over to the persistence manager that is configured for this workspace.</li>
-</ul>
+<p><b>Transient Item State Manager</b><br />
+Once content items are read by a session they are cached in the Transient Item State Manager. When those items are modified the modification is only visible to that same session, in the so-called “transient” space.</p>
+</li>
+<li>
-<ul>
-
-<li><b>Persistence Manager</b><br />The Persistence Manager persists all the Item States in the changelog passed by the Shared ISM. The persistence manager is a very simple, fast and transactional interface that is very low-level and does not need to understand the complexities of the repository operations, but basically just needs to be able persist and retrieve a given item based on its item id.</li>
-</ul>
+<p><b>Transactional Item State Manager</b> When the Application persists the modified items using the JCR <code>Item.save()</code> or <code>Session.save()</code> the transient Items are promoted into the Transactional ISM. The modifications are still only visible within the scope of this transaction, meaning that other sessions will not see the modification until they are committed. The commit is implicit if the Content Repository is not running in an XA environment.</p>
+</li>
+<li>
-<ul>
-
-<li><b>Observation</b><br />When a transaction is committed the Shared Item State Manager triggers the Observation mechanism. This allows applications to asynchronously subscribe changes in the workspace. Jackrabbit also non-standard offers a synchronous observation.</li>
-</ul>
+<p><b>Shared Item State Manager</b> Once a transaction is committed the Shared Item State Manager receives the changelog and publishes the changes to all the sessions logged into the same workspace. This means that all the Item States that are cached and referenced by other sessions are notified and possibly updated or invalidated. The Shared Item State Manager also triggers the observation and hands the changelog over to the persistence manager that is configured for this workspace.</p>
+</li>
+<li>
-<ul>
-
-<li><b>Query Manager / Index</b><br />Through a synchronous observation event the Query Manager is instructed to index the new or modified items. A content repository index is much more complex than a classical RDB index since it deals with content repository features like the item hierarchy, nodetype inheritance or fulltext searches.</li>
-</ul>
- </div>
- </div>
- </div>
+<p><b>Persistence Manager</b><br />
+The Persistence Manager persists all the Item States in the changelog passed by the Shared ISM. The persistence manager is a very simple, fast and transactional interface that is very low-level and does not need to understand the complexities of the repository operations, but basically just needs to be able persist and retrieve a given item based on its item id.</p>
+</li>
+<li>
- <hr/>
+<p><b>Observation</b><br />
+When a transaction is committed the Shared Item State Manager triggers the Observation mechanism. This allows applications to asynchronously subscribe changes in the workspace. Jackrabbit also non-standard offers a synchronous observation.</p>
+</li>
+<li>
+<p><b>Query Manager / Index</b><br />
+Through a synchronous observation event the Query Manager is instructed to index the new or modified items. A content repository index is much more complex than a classical RDB index since it deals with content repository features like the item hierarchy, nodetype inheritance or fulltext searches.</p>
+</li>
+</ul>
+ </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/images/apache-maven-project-2.png
URL: http://svn.apache.org/viewvc/jackrabbit/site/live/jcr/images/apache-maven-project-2.png?rev=1900838&r1=1900837&r2=1900838&view=diff
==============================================================================
Binary files - no diff available.