You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2015/09/22 12:23:33 UTC
svn commit: r966334 [1/11] - in /websites/staging/sling/trunk/content: ./
documentation/ documentation/bundles/ documentation/bundles/scripting/
documentation/development/ documentation/getting-started/
documentation/legacy/ documentation/the-sling-eng...
Author: buildbot
Date: Tue Sep 22 10:23:16 2015
New Revision: 966334
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/contributing.html
websites/staging/sling/trunk/content/documentation.html
websites/staging/sling/trunk/content/documentation/bundles.html
websites/staging/sling/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.html
websites/staging/sling/trunk/content/documentation/bundles/apache-sling-commons-thread-pool.html
websites/staging/sling/trunk/content/documentation/bundles/apache-sling-eventing-and-job-handling.html
websites/staging/sling/trunk/content/documentation/bundles/bundle-resources-extensions-bundleresource.html
websites/staging/sling/trunk/content/documentation/bundles/caching-services.html
websites/staging/sling/trunk/content/documentation/bundles/commons-html-utilities.html
websites/staging/sling/trunk/content/documentation/bundles/configuration-installer-factory.html
websites/staging/sling/trunk/content/documentation/bundles/content-loading-jcr-contentloader.html
websites/staging/sling/trunk/content/documentation/bundles/datasource-providers.html
websites/staging/sling/trunk/content/documentation/bundles/discovery-api-and-impl.html
websites/staging/sling/trunk/content/documentation/bundles/file-installer-provider.html
websites/staging/sling/trunk/content/documentation/bundles/internationalization-support-i18n.html
websites/staging/sling/trunk/content/documentation/bundles/jcr-installer-provider.html
websites/staging/sling/trunk/content/documentation/bundles/log-tracers.html
websites/staging/sling/trunk/content/documentation/bundles/managing-permissions-jackrabbit-accessmanager.html
websites/staging/sling/trunk/content/documentation/bundles/managing-users-and-groups-jackrabbit-usermanager.html
websites/staging/sling/trunk/content/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html
websites/staging/sling/trunk/content/documentation/bundles/mime-type-support-commons-mime.html
websites/staging/sling/trunk/content/documentation/bundles/models.html
websites/staging/sling/trunk/content/documentation/bundles/nosql-resource-providers.html
websites/staging/sling/trunk/content/documentation/bundles/org-apache-sling-junit-bundles.html
websites/staging/sling/trunk/content/documentation/bundles/osgi-installer.html
websites/staging/sling/trunk/content/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html
websites/staging/sling/trunk/content/documentation/bundles/rendering-content-default-get-servlets.html
websites/staging/sling/trunk/content/documentation/bundles/request-analysis.html
websites/staging/sling/trunk/content/documentation/bundles/resource-access-security.html
websites/staging/sling/trunk/content/documentation/bundles/resource-editor.html
websites/staging/sling/trunk/content/documentation/bundles/scheduler-service-commons-scheduler.html
websites/staging/sling/trunk/content/documentation/bundles/scripting.html
websites/staging/sling/trunk/content/documentation/bundles/scripting/scripting-thymeleaf.html
websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html
websites/staging/sling/trunk/content/documentation/bundles/sling-query.html
websites/staging/sling/trunk/content/documentation/bundles/sling-scripting-jsp-taglib.html
websites/staging/sling/trunk/content/documentation/bundles/sling-settings-org-apache-sling-settings.html
websites/staging/sling/trunk/content/documentation/bundles/subsystem-installer-factory.html
websites/staging/sling/trunk/content/documentation/bundles/validation.html
websites/staging/sling/trunk/content/documentation/bundles/web-console-extensions.html
websites/staging/sling/trunk/content/documentation/bundles/xml-support.html
websites/staging/sling/trunk/content/documentation/configuration.html
websites/staging/sling/trunk/content/documentation/development.html
websites/staging/sling/trunk/content/documentation/development/client-request-logging.html
websites/staging/sling/trunk/content/documentation/development/dependency-management.html
websites/staging/sling/trunk/content/documentation/development/embedding-sling.html
websites/staging/sling/trunk/content/documentation/development/getting-and-building-sling.html
websites/staging/sling/trunk/content/documentation/development/ide-tooling.html
websites/staging/sling/trunk/content/documentation/development/issue-tracker.html
websites/staging/sling/trunk/content/documentation/development/jcr-mock.html
websites/staging/sling/trunk/content/documentation/development/jspc.html
websites/staging/sling/trunk/content/documentation/development/jsr-305.html
websites/staging/sling/trunk/content/documentation/development/logging.html
websites/staging/sling/trunk/content/documentation/development/maven-archetypes.html
websites/staging/sling/trunk/content/documentation/development/maven-launchpad-plugin.html
websites/staging/sling/trunk/content/documentation/development/maven-usage.html
websites/staging/sling/trunk/content/documentation/development/maventipsandtricks.html
websites/staging/sling/trunk/content/documentation/development/monitoring-requests.html
websites/staging/sling/trunk/content/documentation/development/osgi-mock.html
websites/staging/sling/trunk/content/documentation/development/release-management.html
websites/staging/sling/trunk/content/documentation/development/repository-based-development.html
websites/staging/sling/trunk/content/documentation/development/resourceresolver-mock.html
websites/staging/sling/trunk/content/documentation/development/sling-mock.html
websites/staging/sling/trunk/content/documentation/development/sling-testing-tools.html
websites/staging/sling/trunk/content/documentation/development/sling.html
websites/staging/sling/trunk/content/documentation/development/slingstart.html
websites/staging/sling/trunk/content/documentation/development/version-policy.html
websites/staging/sling/trunk/content/documentation/getting-started.html
websites/staging/sling/trunk/content/documentation/getting-started/discover-sling-in-15-minutes.html
websites/staging/sling/trunk/content/documentation/legacy/logging.html
websites/staging/sling/trunk/content/documentation/pax-exam-utils.html
websites/staging/sling/trunk/content/documentation/the-sling-engine.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/adapters.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/architecture.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/authentication.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/authentication/authentication-actors.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/authentication/authentication-authenticationhandler.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/authentication/authentication-authenticationhandler/form-based-authenticationhandler.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/authentication/authentication-authenticationhandler/openid-authenticationhandler.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/authentication/authentication-framework.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/authentication/authentication-tasks.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/default-mapping-and-rendering.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/dispatching-requests.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/errorhandling.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/featureflags.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/filters.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/mappings-for-resource-resolution.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/request-listeners.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/request-parameters.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/resources.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/service-authentication.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/servlets.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/sling-api-crud-support.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/sling-properties.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/the-sling-launchpad.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/url-decomposition.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/url-to-script-resolution.html
websites/staging/sling/trunk/content/documentation/the-sling-engine/wrap-or-decorate-resources.html
websites/staging/sling/trunk/content/documentation/tutorials-how-tos.html
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/46-line-blog.html
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/getting-resources-and-properties-in-sling.html
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/how-to-manage-events-in-sling.html
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/installing-and-upgrading-bundles.html
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/jackrabbit-persistence.html
websites/staging/sling/trunk/content/documentation/tutorials-how-tos/testing-sling-based-applications.html
websites/staging/sling/trunk/content/downloads.html
websites/staging/sling/trunk/content/errors/403.html
websites/staging/sling/trunk/content/errors/404.html
websites/staging/sling/trunk/content/guides.html
websites/staging/sling/trunk/content/index.html
websites/staging/sling/trunk/content/links.html
websites/staging/sling/trunk/content/media.html
websites/staging/sling/trunk/content/news.html
websites/staging/sling/trunk/content/old-stuff.html
websites/staging/sling/trunk/content/old-stuff/assembly.html
websites/staging/sling/trunk/content/old-stuff/launch-sling.html
websites/staging/sling/trunk/content/old-stuff/request-processing.html
websites/staging/sling/trunk/content/old-stuff/run-modes-org-apache-sling-runmode.html
websites/staging/sling/trunk/content/old-stuff/scriptengineintegration.html
websites/staging/sling/trunk/content/old-stuff/scriptengineintegration/groovy-support.html
websites/staging/sling/trunk/content/old-stuff/scriptengineintegration/xslt-processing-pipeline.html
websites/staging/sling/trunk/content/old-stuff/servlet-resolution.html
websites/staging/sling/trunk/content/old-stuff/sling-api.html
websites/staging/sling/trunk/content/plugins.html
websites/staging/sling/trunk/content/project-information.html
websites/staging/sling/trunk/content/project-information/apache-sling-community-roles-and-processes.html
websites/staging/sling/trunk/content/project-information/project-license.html
websites/staging/sling/trunk/content/project-information/project-team.html
websites/staging/sling/trunk/content/project-information/security.html
websites/staging/sling/trunk/content/site-conversion.html
websites/staging/sling/trunk/content/sitemap.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Sep 22 10:23:16 2015
@@ -1 +1 @@
-1704524
+1704535
Modified: websites/staging/sling/trunk/content/contributing.html
==============================================================================
--- websites/staging/sling/trunk/content/contributing.html (original)
+++ websites/staging/sling/trunk/content/contributing.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Contributing</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,13 +101,24 @@
<h1>Contributing</h1>
- <p>See <a href="/project-information.html">Project Information</a> for details about the tools mentioned below.</p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>See <a href="/project-information.html">Project Information</a> for details about the tools mentioned below.</p>
<p>Apache Sling is a volunteer effort, so there is always plenty of work that needs to be accomplished. If you want to help support Sling, this page is intended as a starting point for specific contribution ideas. To further understand how the Sling community operates, refer to the Community Roles and Processes document and/or join the mailing lists.</p>
<p>The Sling project organizes its "to do" list using the JIRA issue tracking system. Specific items from Sling's JIRA issue tracking system are highlighted on this page, but are not limited to it. The purpose of the list here is to highlight issues that are either more important or serve as good entry points for new contributors.</p>
<p>It is important to point out that you do not need to be a programmer to contribute to Sling. As such, we will break out the list of issues below for non-programmers and programmers.</p>
-<h2 id="non-programmers">Non-Programmers</h2>
+<h2 id="non-programmers">Non-Programmers<a class="headerlink" href="#non-programmers" title="Permanent link">¶</a></h2>
<p>Improve web site or documentation (e.g., create/propose FAQ entries). There is no specific JIRA issue for this task, but any contributions could be posted as new JIRA issues for the Documentation component.</p>
-<h2 id="programmers">Programmers</h2>
+<h2 id="programmers">Programmers<a class="headerlink" href="#programmers" title="Permanent link">¶</a></h2>
<p>Implement support for various rendering technologies in Sling. Examples coming to mind are JSF and Wicket.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
Rev. 1541505 by bdelacretaz on Wed, 13 Nov 2013 12:41:14 +0000
Modified: websites/staging/sling/trunk/content/documentation.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation.html (original)
+++ websites/staging/sling/trunk/content/documentation.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Documentation</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -95,7 +106,18 @@
<h1>Documentation</h1>
- <p>The documentation is split into different parts:</p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>The documentation is split into different parts:</p>
<ul>
<li><a href="/documentation/getting-started.html">Getting Started</a>, the right place to start!</li>
<li><a href="/documentation/the-sling-engine.html">The Sling Engine</a>, all about the heart of Sling</li>
@@ -106,9 +128,9 @@
<li><a href="/documentation/configuration.html">Configuration</a></li>
<li><a href="http://sling.apache.org/apidocs/sling5/index.html">API Doc</a></li>
</ul>
-<h1 id="how-can-you-contribute">How can you contribute</h1>
+<h1 id="how-can-you-contribute">How can you contribute<a class="headerlink" href="#how-can-you-contribute" title="Permanent link">¶</a></h1>
<p>We're on the way to improve the documentation, but it's a long way. If you would like to contribute to the documentation you are very welcome. Please directly post your proposals to the <a href="http://cwiki.apache.org/SLING/">public wiki</a> or post your suggestions to the mailing list.</p>
-<h1 id="how-is-the-documentation-generated">How is the documentation generated</h1>
+<h1 id="how-is-the-documentation-generated">How is the documentation generated<a class="headerlink" href="#how-is-the-documentation-generated" title="Permanent link">¶</a></h1>
<p><em>The Sling web site and documentation are managed with the <a href="https://www.apache.org/dev/cms.html">Apache CMS</a>.
For Apache Sling specific extensions see the <a href="#the-sling-site">The Sling Site</a>
section below.</em></p>
@@ -141,7 +163,7 @@ completed.
<li>The Bundle documentation</li>
</ol>
<p>This page is about how this documentation is maintained and who is allowed to do what.</p>
-<h2 id="the-sling-site">The Sling Site</h2>
+<h2 id="the-sling-site">The Sling Site<a class="headerlink" href="#the-sling-site" title="Permanent link">¶</a></h2>
<p>The site is managed with the <a href="https://www.apache.org/dev/cms.html">Apache CMS</a>
where the source is kept in SVN at <a href="https://svn.apache.org/repos/asf/sling/site/trunk/content">https://svn.apache.org/repos/asf/sling/site/trunk/content</a>.</p>
<p>This section lists some Apache Sling features to help with the maintenance
@@ -230,14 +252,14 @@ It is important to have the first part a
the Django/Markdown combo will create a list for each entry.
</div>
-<h3 id="code-highlighting">Code Highlighting</h3>
+<h3 id="code-highlighting">Code Highlighting<a class="headerlink" href="#code-highlighting" title="Permanent link">¶</a></h3>
<p>Code Highlighting works by indenting code by four blanks. To indicate the
type of highlighting preced the code style text with either <code>:::<lexer></code> to
get high lighted code using the given <code><lexer></code> or <code>#!<lexer></code> to get high
lighted code with line numbers using the given <code><lexer></code>. See
<a href="http://www.apache.org/dev/cmsref.html#code-hilighter">http://www.apache.org/dev/cmsref.html#code-hilighter</a> for main info and
<a href="http://pygments.org/docs/lexers/">http://pygments.org/docs/lexers/</a> for supported lexers</p>
-<h3 id="manual-generation">Manual Generation</h3>
+<h3 id="manual-generation">Manual Generation<a class="headerlink" href="#manual-generation" title="Permanent link">¶</a></h3>
<p>When commiting changes to pages into SVN the pages are automatically
generated in <a href="http://sling.staging.apache.org">the staging site</a>.</p>
<p>To manually generate the site or single pages the <a href="http://svn.apache.org/repos/asf/felix/site">site</a>
@@ -266,9 +288,9 @@ and <code>build_file.pl</code> scripts t
<p>The argument to the <code>--source</code> parameter is relative to the <code>--source-base</code> folder.</p>
-<h2 id="the-public-wiki">The Public Wiki</h2>
+<h2 id="the-public-wiki">The Public Wiki<a class="headerlink" href="#the-public-wiki" title="Permanent link">¶</a></h2>
<p>The public wiki of Sling is available at http://cwiki.apache.org/SLING and is maintained in the Confluence space <em>SLING</em>. This is a public wiki, in that after self-registration, everybody is allowed to edit content.</p>
-<h2 id="the-javadoc">The JavaDoc</h2>
+<h2 id="the-javadoc">The JavaDoc<a class="headerlink" href="#the-javadoc" title="Permanent link">¶</a></h2>
<p>Up until now the JavaDoc of the Sling Bundles has not been published.</p>
<p>I just polished the JavaDoc generation setup of Sling a bit, so that I could generate a first shot of aggregate JavaDocs. This draft can currently be found on my site at http://people.apache.org/~fmeschbe/slingdocs.762729/. This JavaDoc has been generated as follows:</p>
<div class="codehilite"><pre>$ <span class="n">svn</span> <span class="n">export</span> <span class="o">-</span><span class="n">r</span> 762729 <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">svn</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">/</span><span class="n">repos</span><span class="o">/</span><span class="n">asf</span><span class="o">/</span><span class="n">incubator</span><span class="o">/</span><span class="n">sling</span><span class="o">/</span><span class="n">trunk</span> <span class="n">sling</span>
@@ -277,10 +299,10 @@ $ <span class="n">mvn</span> <span class
<p>I am still unsure whether it makes sense to generate aggregate JavaDoc for all (or part of) the bundles of Sling. See also below regarding the Sites.</p>
-<h2 id="the-bundle-documentation">The Bundle Documentation</h2>
+<h2 id="the-bundle-documentation">The Bundle Documentation<a class="headerlink" href="#the-bundle-documentation" title="Permanent link">¶</a></h2>
<p>Apart from the documentation of Sling on the Site and in the Wiki, it would also be thinkable that we accompany the source modules with some documentation and generate this using the Maven Site plugin. My tests so far for generating a multi-module site have not been very successful. But generating the site in a module-by-module manner might be a good thing, at least to get the per-module JavaDoc and some more code-oriented information like Surefire Reports, fixed bugs, etc.</p>
<p>To prepare such Bundle Documentation I added a first shot at site generation setup to the parent project. For now, this includes the module's JavaDoc (of course), the Surefire reports and a report on the issues fixed (or open) with respect to some version. This site generation setup can be configured per module with two properties:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Property</th>
Modified: websites/staging/sling/trunk/content/documentation/bundles.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Bundles</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
Modified: websites/staging/sling/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/accessing-filesystem-resources-extensions-fsresource.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Accessing Filesystem Resources (org.apache.sling.fsresource)</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>Accessing Filesystem Resources (org.apache.sling.fsresource)</h1>
- <div class="toc">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<div class="toc">
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#resource-types">Resource Types</a></li>
@@ -98,27 +120,27 @@
<li><a href="#configuration">Configuration</a></li>
</ul>
</div>
-<h2 id="introduction">Introduction</h2>
+<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></h2>
<p>The Filesystem Resource Provider provides access to the operating system's filesystem through the Sling <code>ResourceResolver</code>. Multiple locations may be mapped into the resource tree by configuring the filesystem location and the resource tree root path for each location to be mapped.</p>
<p>To activate this feature, install the <code>org.apache.sling.fsresource</code> bundle. You can get it from the Sling downloads page or build it yourself from the source code
found under <a href="http://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/fsresource/">bundles/extensions/fsresource</a>.</p>
-<h2 id="resource-types">Resource Types</h2>
+<h2 id="resource-types">Resource Types<a class="headerlink" href="#resource-types" title="Permanent link">¶</a></h2>
<p>Files and directories are mapped into the resource tree as regular <code>Resource</code> instances whose resource type depends on the actual nature of the mapped filesystem resource:</p>
<ul>
<li>Regular files are assigned the <code>nt:file</code> resource type</li>
<li>Directories are assigned the <code>nt:folder</code> resource type</li>
</ul>
-<h2 id="adapters">Adapters</h2>
+<h2 id="adapters">Adapters<a class="headerlink" href="#adapters" title="Permanent link">¶</a></h2>
<p>Filesystem resources extend from Sling's <code>AbstractResource</code> class and thus are adaptable to any type for which an <code>AdapterFactory</code> is registered supporting file system resources. In addition Filesystem Resources support the following adapters natively:</p>
<ul>
<li><code>java.io.File</code> -- The Java file object providing access to the filesystem file</li>
<li><code>java.net.URL</code> -- A valid <code>file://</code> URL to the file. This URL is derived from the <code>java.io.File</code> object by calling the <code>File.toURI().toURL()</code> sequence.</li>
<li><code>java.io.InputStream</code> -- If the <code>java.io.File</code> can be read from (as per <code>File.canRead()</code> an <code>InputStream</code> to read from the file is returned.</li>
</ul>
-<h2 id="configuration">Configuration</h2>
+<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h2>
<p>The Filesystem Resource Provider is configured with OSGi Configuration Admin factory configurtions whose factory PID is <code>org.apache.sling.fsprovider.internal.FsResourceProvider</code>. Configuration can be managed using the OSGi Configuration Admin API, through the Web Console or by any other means supporting Configuration Admin configurations.</p>
<p>The following configuration properties must be specified:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Parameter</th>
Modified: websites/staging/sling/trunk/content/documentation/bundles/apache-sling-commons-thread-pool.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/apache-sling-commons-thread-pool.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/apache-sling-commons-thread-pool.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Apache Sling Commons Thread Pool</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>Apache Sling Commons Thread Pool</h1>
- <p>The Apache Sling Commons Thread Pool bundle provides a thread pool services. All thread pools are managed by the <code>org.apache.sling.commons.threads.ThreadPoolManager</code>. This service can be used to get a thread pool.</p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>The Apache Sling Commons Thread Pool bundle provides a thread pool services. All thread pools are managed by the <code>org.apache.sling.commons.threads.ThreadPoolManager</code>. This service can be used to get a thread pool.</p>
<p>Thread pools are managed by name - there is a default thread pool and custom thread pools can be generated on demand using a unique name.</p>
<p>The thread pools are actually wrappers around the thread pool support (executer) from the Java library. The advantage of using this thread pool service is, that the pools can be configured and managed through OSGi configurations. In addition the bundle contains a plugin for the Apache Felix Web Console.</p>
<p>When using the <code>ThreadPoolMananger</code> it is important to release a thread pool using the manager after it has been used.</p>
Modified: websites/staging/sling/trunk/content/documentation/bundles/apache-sling-eventing-and-job-handling.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/apache-sling-eventing-and-job-handling.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/apache-sling-eventing-and-job-handling.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Apache Sling Eventing and Job Handling</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>Apache Sling Eventing and Job Handling</h1>
- <h2 id="overview">Overview</h2>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">¶</a></h2>
<p>The Apache Sling Event Support bundle adds additional features to the OSGi Event Admin and for distributed event processing.</p>
<p>The bundle provides the following features</p>
<ul>
@@ -101,7 +123,7 @@
<p>To get some hands on code, you can refer to the following tutorials:
<em> <a href="/documentation/tutorials-how-tos/how-to-manage-events-in-sling.html">How to Manage Events in Sling</a>
</em> <a href="/documentation/bundles/scheduler-service-commons-scheduler.html">Scheduler Service (commons scheduler)</a></p>
-<h2 id="jobs-guarantee-of-processing">Jobs (Guarantee of Processing)</h2>
+<h2 id="jobs-guarantee-of-processing">Jobs (Guarantee of Processing)<a class="headerlink" href="#jobs-guarantee-of-processing" title="Permanent link">¶</a></h2>
<p>In general, the eventing mechanism (OSGi EventAdmin) has no knowledge about the contents of an event. Therefore, it can't decide if an event is important and should be processed by someone. As the event mechanism is a "fire event and forget about it" algorithm, there is no way for an event admin to tell if someone has really processed the event. Processing of an event could fail, the server or bundle could be stopped etc.</p>
<p>On the other hand, there are use cases where the guarantee of processing is a must and usually this comes with the requirement of processing exactly once. Typical examples are sending notification emails (or sms), post processing of content (like thumbnail generation of images or documents), workflow steps etc.</p>
<p>The Sling Event Support adds the notion of a job. A job is a special event that has to be processed exactly once. To be precise, the processing guarantee is at most once. However, the time window for a single job where exactly once is very small and only happens if the instance which processes a job crashes after the job processing is finished but before this state is persisted. Therefore a job consumer should be prepared to process a job more than once.</p>
@@ -132,7 +154,7 @@
<p>The job topic follows the conventions for the topic of an OSGi event. All objects in the payload must be serializable and publically available (exported by a bundle). This is required as the job is persisted and unmarshalled before processing.</p>
<p>As soon as the method returns from the job manager, the job is persisted and the job manager ensures that this job will be processed exactly once.</p>
-<h3 id="job-consumers">Job Consumers</h3>
+<h3 id="job-consumers">Job Consumers<a class="headerlink" href="#job-consumers" title="Permanent link">¶</a></h3>
<p>A job consumer is a service consuming and processing a job. It registers itself as an OSGi service together with a property defining which topics this consumer can process:</p>
<div class="codehilite"><pre> <span class="n">import</span> <span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">felix</span><span class="p">.</span><span class="n">scr</span><span class="p">.</span><span class="n">annotations</span><span class="p">.</span><span class="n">Component</span><span class="p">;</span>
<span class="n">import</span> <span class="n">org</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">felix</span><span class="p">.</span><span class="n">scr</span><span class="p">.</span><span class="n">annotations</span><span class="p">.</span><span class="n">Service</span><span class="p">;</span>
@@ -153,12 +175,12 @@
<p>The <em>Job</em> interface allows to query the topic, the payload and additional information about the current job. The consumer can either return <em>JobResult.OK</em> indicating that the job has been processed, <em>JobResult.FAILED</em> indicating the processing failed, but can be retried or <em>JobResult.CANCEL</em> the processing has failed permanently.</p>
-<h3 id="job-handling">Job Handling</h3>
+<h3 id="job-handling">Job Handling<a class="headerlink" href="#job-handling" title="Permanent link">¶</a></h3>
<p>New jobs are first persisted in the resource tree (for failover etc.), then the job is distributed to an instance responsible for processing the job and on that instance the job is put into a processing queue. There are different types of queues defining how the jobs are processed (one after the other, in parallel etc.).</p>
<p>For managing queues, the Sling Job Handler uses the OSGi ConfigAdmin - it is possible to configure one or more queue configurations through the ConfigAdmin. One way of creating and configuring such configurations is the Apache Felix WebConsole.</p>
-<h4 id="queue-configurations">Queue Configurations</h4>
+<h4 id="queue-configurations">Queue Configurations<a class="headerlink" href="#queue-configurations" title="Permanent link">¶</a></h4>
<p>A queue configuration can have the following properties:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Property Name</th>
@@ -168,7 +190,7 @@
<tbody>
<tr>
<td><code>queue.name</code></td>
-<td>The name of the queue. If matching is used for topics, the value {0} can be used for replacing the matched part.</td>
+<td 0="0">The name of the queue. If matching is used for topics, the value </td>
</tr>
<tr>
<td><code>queue.type</code></td>
@@ -201,25 +223,25 @@
</tbody>
</table>
<p>The configurations are processed in order of their service ranking. The first matching queue configuration is used for the job.</p>
-<h4 id="ordered-queues">Ordered Queues</h4>
+<h4 id="ordered-queues">Ordered Queues<a class="headerlink" href="#ordered-queues" title="Permanent link">¶</a></h4>
<p>An ordered queue processes one job after the other.</p>
-<h4 id="unordered-queues-or-parallel-queues">Unordered Queues (or Parallel queues)</h4>
+<h4 id="unordered-queues-or-parallel-queues">Unordered Queues (or Parallel queues)<a class="headerlink" href="#unordered-queues-or-parallel-queues" title="Permanent link">¶</a></h4>
<p>Unordered queues process jobs in parallel.</p>
-<h4 id="topic-round-robin-queues">Topic-Round-Robin Queues</h4>
+<h4 id="topic-round-robin-queues">Topic-Round-Robin Queues<a class="headerlink" href="#topic-round-robin-queues" title="Permanent link">¶</a></h4>
<p>The jobs are processed in parallel. Scheduling of the jobs is based on the topic of the jobs. These are started by doing round-robin on the available topics.</p>
-<h3 id="job-distributing">Job Distributing</h3>
+<h3 id="job-distributing">Job Distributing<a class="headerlink" href="#job-distributing" title="Permanent link">¶</a></h3>
<p>For job distribution (= distributing the processing in a cluster), the job handling uses the topology feature from Sling - each instance in the topology announces the set of topics (consumers) it currently has - and this defines the job capabilities, a mapping from an instance to the topics it can process.</p>
<p>When a job is scheduled, the job manager uses these capabilities to find out the set of instances which is able to process the request. If the queue type is <em>ordered</em> then all jobs are processed by the leader of this set. For parallel queues, the jobs are distributed equally amongst those instance.</p>
<p>Failover is handled by the leader: if an instance dies, the leader will detect this through the topology framework and then redistribute jobs from the dead instance to the available instances. Of course this takes a leader change into account as well. In addition if the job capabilities change and this require a reschedule of jobs, that's done by the leader as well.</p>
-<h3 id="job-creation-patterns">Job Creation Patterns</h3>
+<h3 id="job-creation-patterns">Job Creation Patterns<a class="headerlink" href="#job-creation-patterns" title="Permanent link">¶</a></h3>
<p>The job manager ensures that a job is processed exactly once. However, the client code has to take care that a job is created exactly once. We'll discuss this based on some general usage patterns:</p>
-<h4 id="jobs-based-on-user-action">Jobs based on user action</h4>
+<h4 id="jobs-based-on-user-action">Jobs based on user action<a class="headerlink" href="#jobs-based-on-user-action" title="Permanent link">¶</a></h4>
<p>If a user action results in the creation of a job, the thread processing the user action can directly create the job. This ensures that even in a clustered scenario the job is created only once.</p>
-<h4 id="jobs-based-on-observation-events">Jobs based on observation / events</h4>
+<h4 id="jobs-based-on-observation-events">Jobs based on observation / events<a class="headerlink" href="#jobs-based-on-observation-events" title="Permanent link">¶</a></h4>
<p>If an observation event or any other OSGi event results in the creation of a job, special care needs to be taken in a clustered installation to avoid the job is created on all cluster instances. The easiest way to avoid this, is to use the topology api and make sure the job is only created on the leader instance.</p>
-<h2 id="distributed-events">Distributed Events</h2>
+<h2 id="distributed-events">Distributed Events<a class="headerlink" href="#distributed-events" title="Permanent link">¶</a></h2>
<p>In addition to the job handling, the Sling Event support adds handling for distributed events. A distributed event is an OSGi event which is sent across JVM boundaries to a different VM. A potential use case is to broadcast information in a clustered environment.</p>
-<h3 id="basic-principles">Basic Principles</h3>
+<h3 id="basic-principles">Basic Principles<a class="headerlink" href="#basic-principles" title="Permanent link">¶</a></h3>
<p>The foundation of the distributed event mechanism is to distribute each event to every node in a clustered environment. The event distribution mechanism has no knowledge about the intent of the event and therefore is not able to make delivery decisions by itself. It is up to the sender to decide what should happen. The sender must explicitly declare an event to be distributed as for example framework related events (bundle stopped, installed etc.) should not be distributed.</p>
<p>The event mechanism will provide additional functionality making it easier for event receivers to decide if they should process an event. The event receiver can determine if the event is a local event or comming from a remote application node. Therefore a general rule of thumb is to process events only if they're local and just regard remote events as a FYI.</p>
<p>For distributed events two properties are defined (check the <em>EventUtil</em> class):</p>
@@ -228,10 +250,10 @@
<li><em>event.application</em> - An identifier for the current application node in the cluster. This information will be used to detect if an event has been created on different nodes. If the event has been created on the same node, the <em>event.application</em> is missing, if it is a remote event, the <em>event.application</em> contains the ID of the node, the event has been initially created. Use the <em>EventUtil.isLocal(Event)</em> method to detect if the event is a local or a distributed event.</li>
</ul>
<p>While the <em>event.distribute</em> must be set by the sender of an event (if the event should be distributed), the <em>event.application</em> property is maintained by the event mechanism. Therefore a client sending an event should <em>never</em> set this information by itself. This will confuse the local event handlers and result in unexpected behaviour. On remote events the <em>event.application</em> is set by the event distribution mechanism.</p>
-<h3 id="event-distribution-across-application-nodes-cluster">Event Distribution Across Application Nodes (Cluster)</h3>
+<h3 id="event-distribution-across-application-nodes-cluster">Event Distribution Across Application Nodes (Cluster)<a class="headerlink" href="#event-distribution-across-application-nodes-cluster" title="Permanent link">¶</a></h3>
<p>The (local) event admin is the service distributing events locally. The Sling Distributing Event Handler is a registered event handler that is listening for events to be distributed. It distributes the events to remote application notes, Sling's resource tree is used for distribution. The distributing event handler writes the events into the resource tree, the distributing event handlers on other application nodes get notified through observation and then distribute the read events locally.</p>
<p>As mentioned above, the client sending an event has to mark an event to be distributed in a cluster by setting the <em>event.distribute</em> in the event properties (through <em>EventUtil</em>). This distribution mechanism has the advantage that the application nodes do not need to know each other and the distribution mechanism is independent from the used event admin implementation.</p>
-<h2 id="sending-scheduled-events">Sending Scheduled Events</h2>
+<h2 id="sending-scheduled-events">Sending Scheduled Events<a class="headerlink" href="#sending-scheduled-events" title="Permanent link">¶</a></h2>
<p>Scheduled events are OSGi events that have been created by the environemnt. They are generated on each application node of the cluster through an own scheduler instance. Sending these events works the same as sending events based on JCR events (see above).</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
Rev. 1683618 by sseifert on Thu, 4 Jun 2015 19:50:02 +0000
Modified: websites/staging/sling/trunk/content/documentation/bundles/bundle-resources-extensions-bundleresource.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/bundle-resources-extensions-bundleresource.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/bundle-resources-extensions-bundleresource.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Bundle Resources (extensions.bundleresource)</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>Bundle Resources (extensions.bundleresource)</h1>
- <div class="toc">
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<div class="toc">
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#resource-types">Resource Types</a></li>
@@ -98,21 +120,21 @@
<li><a href="#configuration">Configuration</a></li>
</ul>
</div>
-<h2 id="introduction">Introduction</h2>
+<h2 id="introduction">Introduction<a class="headerlink" href="#introduction" title="Permanent link">¶</a></h2>
<p>The Bundle Resource Provider provides access to files/directories included in an OSGi bundle through the Sling <code>ResourceResolver</code>. </p>
-<h2 id="resource-types">Resource Types</h2>
+<h2 id="resource-types">Resource Types<a class="headerlink" href="#resource-types" title="Permanent link">¶</a></h2>
<p>Files and directories are mapped into the resource tree as regular <code>Resource</code> instances whose resource type depends on the actual nature of the mapped resource:</p>
<ul>
<li>Regular files are assigned the <code>nt:file</code> resource type</li>
<li>Directories are assigned the <code>nt:folder</code> resource type</li>
</ul>
-<h2 id="adapters">Adapters</h2>
+<h2 id="adapters">Adapters<a class="headerlink" href="#adapters" title="Permanent link">¶</a></h2>
<p>Filesystem resources extend from Sling's <code>AbstractResource</code> class and thus are adaptable to any type for which an <code>AdapterFactory</code> is registered supporting bundle resources. In addition <code>BundleResource</code> support the following adapters natively:</p>
<ul>
<li><code>java.net.URL</code> -- A valid <code>bundle://</code> URL to the resource in the bundle. </li>
<li><code>java.io.InputStream</code> -- An <code>InputStream</code> to read file contents. Doesn't apply to folders.</li>
</ul>
-<h2 id="configuration">Configuration</h2>
+<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h2>
<p>Providing bundles have a Bundle manifest header <code>Sling-Bundle-Resources</code> containing a list of absolute paths provided by the bundle. The paths are separated by comma or whitespace (SP, TAB, VTAB, CR, LF). </p>
<p>Example (manifest.mf):</p>
<div class="codehilite"><pre><span class="p">...</span>
Modified: websites/staging/sling/trunk/content/documentation/bundles/caching-services.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/caching-services.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/caching-services.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Sling Caching Services</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>Sling Caching Services</h1>
- <p>Caching services are available as a contribution at <a href="https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/cache">https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/cache</a></p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>Caching services are available as a contribution at <a href="https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/cache">https://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/cache</a></p>
<p>Both EhCache and Infinispan implementations are provided, with good unit and integration tests coverage.</p>
<p>A portal cache provider API implementation is provided, that depends on the whiteboard portal modules
found under <a href="https://svn.apache.org/repos/asf/sling/whiteboard/portal">https://svn.apache.org/repos/asf/sling/whiteboard/portal</a></p>
Modified: websites/staging/sling/trunk/content/documentation/bundles/commons-html-utilities.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/commons-html-utilities.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/commons-html-utilities.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Commons HTML Utilities (org.apache.sling.commons.html)</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>Commons HTML Utilities (org.apache.sling.commons.html)</h1>
- <p>The Apache Sling Commons HTML Utilities bundle provides an HTML parser which can be used to parse HTML and either generate a DOM or SAX events out of the HTML. Therefore the parser transforms the HTML into proper XHTML.</p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>The Apache Sling Commons HTML Utilities bundle provides an HTML parser which can be used to parse HTML and either generate a DOM or SAX events out of the HTML. Therefore the parser transforms the HTML into proper XHTML.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
Rev. 1500729 by dklco on Mon, 8 Jul 2013 13:51:30 +0000
</div>
Modified: websites/staging/sling/trunk/content/documentation/bundles/configuration-installer-factory.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/configuration-installer-factory.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/configuration-installer-factory.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Configuration Installer Factory</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
Modified: websites/staging/sling/trunk/content/documentation/bundles/content-loading-jcr-contentloader.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/content-loading-jcr-contentloader.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/content-loading-jcr-contentloader.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - Content Loading and Nodetype Support (jcr.contentloader)</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,11 +101,22 @@
<h1>Content Loading and Nodetype Support (jcr.contentloader)</h1>
- <p>Apache Sling provides support for initial content loading into a repository and for registering node types. The <code>sling-jcr-contentloader</code> bundle provides loading of content from a bundle into the repository and the <code>sling-jcr-base</code> bundle provides node type registration.</p>
-<h2 id="initial-content-loading">Initial Content Loading</h2>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>Apache Sling provides support for initial content loading into a repository and for registering node types. The <code>sling-jcr-contentloader</code> bundle provides loading of content from a bundle into the repository and the <code>sling-jcr-base</code> bundle provides node type registration.</p>
+<h2 id="initial-content-loading">Initial Content Loading<a class="headerlink" href="#initial-content-loading" title="Permanent link">¶</a></h2>
<p>Bundles can provide initial content, which is loaded into the repository when the bundle has entered the <em>started</em> state. Such content is expected to be contained in the bundles accessible through the Bundle entry API methods. Content to be loaded is declared in the <code>Sling-Initial-Content</code> bundle manifest header. This header takes a comma-separated list of bundle entry paths. Each entry and all its child entries are accessed and entered into starting with the child entries of the listed entries.</p>
<p>Adding this content preserves the paths of the entries as show in this table, which assumes a <code>Sling-Initial-Content</code> header entry of <code>SLING-INF/content</code>:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Entry</th>
@@ -113,7 +135,7 @@
</tbody>
</table>
<p>Bundle entries are installed as follows:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Entry Type</th>
@@ -132,7 +154,7 @@
</tbody>
</table>
<p>It is possible to modify the intial content loading default behaviour by using certain optional directives. Directives should be specified separated by semicolon. They are defined as follows:</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Directive</th>
@@ -181,7 +203,7 @@
</tbody>
</table>
<p>Examples of these directives uses could be (assumes a Sling-Initial-Content header entry of SLING-INF/content):</p>
-<table>
+<table class="table">
<thead>
<tr>
<th>Entry</th>
@@ -207,7 +229,7 @@
</tr>
</tbody>
</table>
-<h2 id="loading-initial-content-from-bundles">Loading initial content from bundles</h2>
+<h2 id="loading-initial-content-from-bundles">Loading initial content from bundles<a class="headerlink" href="#loading-initial-content-from-bundles" title="Permanent link">¶</a></h2>
<p>Repository items to be loaded into the repository, when the bundle is first installed, may be defined in four ways:</p>
<ol>
<li>Directories</li>
@@ -216,13 +238,13 @@
<li>JSON descriptor files</li>
</ol>
<p>Depending on the bundle entry found in the location indicated by the Sling-Initial-Content bundle manifest header, nodes are created (and/or updated) as follows:</p>
-<h3 id="directories">Directories</h3>
+<h3 id="directories">Directories<a class="headerlink" href="#directories" title="Permanent link">¶</a></h3>
<p>Unless a node with the name of the directory already exists or has been defined in an XML or JSON descriptor file (see below) a directory is created as a node with the primary node type "nt:folder" in the repository.</p>
-<h3 id="files">Files</h3>
+<h3 id="files">Files<a class="headerlink" href="#files" title="Permanent link">¶</a></h3>
<p>Unless a node with the name of the file already exists or has been defined in an XML or JSON descriptor file (see below) a file is created as two nodes in the repository. The node bearing the name of the file itself is created with the
primary node type "nt:file". Underneath this file node, a resource node with the primary node type "nt:resource" is created, which is set to the contents of the file.</p>
<p>The MIME type is derived from the file name extension by first trying to resolve it from the Bundle entry URL. If this does not resolve to a MIME type, the Sling MIME type resolution service is used to try to find a mime type. If all fals, the MIME type is defaulted to "application/octet-stream". </p>
-<h3 id="xml-descriptor-files">XML Descriptor Files</h3>
+<h3 id="xml-descriptor-files">XML Descriptor Files<a class="headerlink" href="#xml-descriptor-files" title="Permanent link">¶</a></h3>
<p>Nodes, Properties and in fact complete subtrees may be described in XML files using either the JCR SystemView format, or the format described below. In either case, the file must have the .xml extension.</p>
<div class="codehilite"><pre><span class="nt"><node></span>
<span class="c"><!--</span>
@@ -279,7 +301,7 @@ primary node type "nt:file". Underneath
</pre></div>
-<h4 id="using-a-custom-xml-format">Using a custom XML format</h4>
+<h4 id="using-a-custom-xml-format">Using a custom XML format<a class="headerlink" href="#using-a-custom-xml-format" title="Permanent link">¶</a></h4>
<p>By writing an XSLT stylesheet file, you can use whatever XML format you prefer. The XML file references an XSLT stylesheet by using the xml-stylesheet processing instruction: </p>
<div class="codehilite"><pre><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
<span class="cp"><?xml-stylesheet href="my-transform.xsl" type="text/xsl"?></span> <span class="c"><!-- The path to my-transform.xsl is relative to this file --></span>
@@ -308,7 +330,7 @@ primary node type "nt:file". Underneath
</pre></div>
-<h3 id="json-descriptor-files">JSON Descriptor Files</h3>
+<h3 id="json-descriptor-files">JSON Descriptor Files<a class="headerlink" href="#json-descriptor-files" title="Permanent link">¶</a></h3>
<p>Nodes, Properties and in fact complete subtrees may be described in JSON files using the following skeleton structure (see <a href="http://www.json.org">http://www.json.org</a> or information on the syntax of JSON) :</p>
<div class="codehilite"><pre><span class="p">{</span>
<span class="o">//</span> <span class="n">child</span> <span class="n">node</span> <span class="n">name</span>
@@ -363,11 +385,11 @@ primary node type "nt:file". Underneath
</pre></div>
-<h3 id="extractors">Extractors</h3>
+<h3 id="extractors">Extractors<a class="headerlink" href="#extractors" title="Permanent link">¶</a></h3>
<p>By default, the <code>sling-jcr-contentloader</code> bundle tries to extract certain file types during content loading. These include <code>json</code>, <code>xml</code>, <code>zip</code>, and <code>jar</code> files. Therefore all available extractors are used for content processing. However if some files should be put into the repository unextracted, the <code>ignoreImportProviders</code> directive can be used with a comma separated list of extensions that should not be extracted, like <code>ignoreImportProviders:="jar,zip"</code>. Please note that the value needs to be put into quotation marks if more than one value is used like in the example.</p>
-<h3 id="workspace-targetting">Workspace Targetting</h3>
+<h3 id="workspace-targetting">Workspace Targetting<a class="headerlink" href="#workspace-targetting" title="Permanent link">¶</a></h3>
<p>By default, initial content will be loaded into the default workspace. To override this, add a <code>Sling-Initial-Content-Workspace</code> bundle manifest header to specify the manifest. Note that <em>all</em> content from a bundle will be loaded into the same workspace. </p>
-<h2 id="declared-node-type-registration">Declared Node Type Registration</h2>
+<h2 id="declared-node-type-registration">Declared Node Type Registration<a class="headerlink" href="#declared-node-type-registration" title="Permanent link">¶</a></h2>
<p>The <code>sling-jcr-base</code> bundle provides low-level repository operations which are at the heart of the functionality of Sling:
<em> </em>Node Type Definitions* - The class <code>org.apache.sling.content.jcr.base.NodeTypeLoader</code> provides methods to register custom node types with a repository given a repository session and a node type definition file in CND format. This class is also used by this bundle to register node types on behalf of other bundles.</p>
<p>Bundles may list node type definition files in CND format in the <code>Sling-Nodetypes</code> bundle header. This header is a comma-separated list of resources in the respective bundle. Each resource is taken and fed to the <code>NodeTypeLoader</code> to define the node types.</p>
@@ -378,7 +400,7 @@ primary node type "nt:file". Underneath
Support for re-registration of node types is relatively limited. In Jackrabbit, for example, only "trivial" changes are allowed.
</div>
-<h3 id="automated-tests">Automated tests</h3>
+<h3 id="automated-tests">Automated tests<a class="headerlink" href="#automated-tests" title="Permanent link">¶</a></h3>
<p>The initial content found in the <a href="http://svn.apache.org/repos/asf/sling/trunk/launchpad/content/src/main/resources/content/sling-test">sling-test folder of the launchpad initial content</a> is verified by the <a href="http://svn.apache.org/repos/asf/sling/trunk/launchpad/testing/src/test/java/org/apache/sling/launchpad/webapp/integrationtest/InitialContentTest.java">InitialContentTest</a> when running the <em>launchpad/testing</em> integration tests.</p>
<p>Those tests can be used as verified examples of initial content loading. Contributions are welcome to improve the coverage of those tests.</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
Modified: websites/staging/sling/trunk/content/documentation/bundles/datasource-providers.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/datasource-providers.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/datasource-providers.html Tue Sep 22 10:23:16 2015
@@ -18,11 +18,11 @@
limitations under the License.
-->
<head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Apache Sling - DataSource Provider</title>
<link rel="icon" href="/res/favicon.ico">
<link rel="stylesheet" href="/res/site.css" type="text/css" media="all">
<link rel="stylesheet" href="/res/codehilite.css" type="text/css" media="all">
- <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
</head>
<body>
<div class="title">
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>DataSource Provider</h1>
- <p>DataSource provider bundle supports creation of <code>DataSource</code> instance and registering them with
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>DataSource provider bundle supports creation of <code>DataSource</code> instance and registering them with
the OSGi service registry. Application using the DataSource just obtains it from OSGi while
an administrator can configure the DataSource via Felix WebConsole configuration UI.</p>
<div class="toc">
@@ -106,7 +128,7 @@ an administrator can configure the DataS
<li><a href="#installation">Installation</a></li>
</ul>
</div>
-<h2 id="pooled-connection-datasource-provider">Pooled Connection DataSource Provider</h2>
+<h2 id="pooled-connection-datasource-provider">Pooled Connection DataSource Provider<a class="headerlink" href="#pooled-connection-datasource-provider" title="Permanent link">¶</a></h2>
<p>This bundle enables creating and configuring JDBC DataSource in OSGi environment based on
OSGi configuration. It uses <a href="http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html">Tomcat JDBC Pool</a> as the JDBC Connection Pool provider.</p>
<ol>
@@ -115,7 +137,7 @@ OSGi configuration. It uses <a href="htt
<li>Exposes the DataSource stats as JMX MBean</li>
<li>Supports updating of DataSource connection pool properties at runtime without restart</li>
</ol>
-<h3 id="driver-loading">Driver Loading</h3>
+<h3 id="driver-loading">Driver Loading<a class="headerlink" href="#driver-loading" title="Permanent link">¶</a></h3>
<p>Loading of JDBC driver is tricky on OSGi env. Mostly one has to attach the Driver bundle as a
fragment bundle to the code which creates the JDBC Connection.</p>
<p>With JDBC 4 onwards the Driver class can be loaded via Java SE Service Provider mechanism (SPM)
@@ -130,7 +152,7 @@ contain the following entry:</p>
<p>Sling DataSource Provider bundles maintains a <code>DriverRegistry</code> which contains mapping of Driver
bundle to Driver class supported by it. With this feature there is no need to wrap the Driver
bundle as fragment to DataSource provider bundle</p>
-<h3 id="configuration">Configuration</h3>
+<h3 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h3>
<ol>
<li>Install the current bundle</li>
<li>Install the JDBC Driver bundle</li>
@@ -140,7 +162,7 @@ bundle as fragment to DataSource provide
http://localhost:8080/system/console/configMgr/org.apache.sling.datasource.DataSourceFactory</p>
<p><img alt="Web Console Config" src="/documentation/development/sling-datasource-config.png" /></p>
<p>Using the config ui above one can directly configure most of the properties as explained in <a href="http://tomcat.apache.org/tomcat-7.0-doc/jdbc-pool.html">Tomcat Docs</a></p>
-<h3 id="convert-driver-jars-to-bundle">Convert Driver jars to Bundle</h3>
+<h3 id="convert-driver-jars-to-bundle">Convert Driver jars to Bundle<a class="headerlink" href="#convert-driver-jars-to-bundle" title="Permanent link">¶</a></h3>
<p>Most of the JDBC driver jars have the required OSGi headers and can be directly deployed to OSGi container
as bundles. However some of the drivers e.g. Postgres are not having such headers and hence need to be
converted to OSGi bundles. For them we can use the <a href="http://www.aqute.biz/Bnd/Wrapping">Bnd Wrap</a> command.</p>
@@ -164,7 +186,7 @@ $ <span class="n">java</span> <span clas
<li>Execute the bnd command</li>
<li>Resulting bundle is present in <code>org.postgresql-9.3.1101.jar</code></li>
</ol>
-<h2 id="jndi-datasource">JNDI DataSource</h2>
+<h2 id="jndi-datasource">JNDI DataSource<a class="headerlink" href="#jndi-datasource" title="Permanent link">¶</a></h2>
<p>While running in Application Server the DataSource instance might be managed by app server and registered with
JNDI. To enable lookup of DataSource instance from JNDI you can configure <code>JNDIDataSourceFactory</code></p>
<ol>
@@ -175,7 +197,7 @@ JNDI. To enable lookup of DataSource ins
http://localhost:8080/system/console/configMgr/org.apache.sling.datasource.JNDIDataSourceFactory</p>
<p>Once configured <code>JNDIDataSourceFactory</code> would lookup the DataSource instance and register it with OSGi
ServiceRegistry</p>
-<h2 id="usage">Usage</h2>
+<h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¶</a></h2>
<p>Once the required configuration is done the <code>DataSource</code> would be registered as part of the OSGi Service Registry
The service is registered with service property <code>datasource.name</code> whose value is the name of datasource provided in
OSGi config.</p>
@@ -191,7 +213,7 @@ OSGi config.</p>
</pre></div>
-<h2 id="installation">Installation</h2>
+<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h2>
<p>Download the bundle from <a href="http://sling.apache.org/downloads.cgi">here</a> or use following Maven dependency</p>
<div class="codehilite"><pre><span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.sling<span class="nt"></groupId></span>