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 2012/04/22 19:20:13 UTC
svn commit: r813971 [4/11] - /websites/staging/sling/trunk/content/
Modified: websites/staging/sling/trunk/content/downloads.html
==============================================================================
--- websites/staging/sling/trunk/content/downloads.html (original)
+++ websites/staging/sling/trunk/content/downloads.html Sun Apr 22 17:20:11 2012
@@ -82,7 +82,397 @@
<a href="/">Home</a>
</div>
<!-- <h1 class="title">Downloads</h1> -->
+<!-- -->
+<p><a name="Downloads-Downloads"></a></p>
+<h1 id="downloads">Downloads</h1>
+<p>To get the latest development release of Apache Sling, you can check out
+the <a href="project-information#projectinformation-source.html">Source Code</a>
+ and [Getting and Building Sling]
+ yourself. Otherwise, the releases below are available for download. To
+install, just download and extract. These [KEYS|http://www.apache.org/dist/sling/KEYS]
+ can be used to verify the release archive.</p>
+<p>All Apache Sling products are distributed under the terms of The Apache
+Software License (version 2.0). See our <a href="project-license.html">license</a>
+, or the LICENSE file included in each distribution.</p>
+<p><a name="Downloads-Mirrors"></a></p>
+<h2 id="mirrors">Mirrors</h2>
+<p>Use the links below to download binary or source distributions of Apache
+Sling from one of our mirrors.</p>
+<p>You are currently using <em>[preferred](preferred.html)
+</em>. If you encounter a problem with this mirror, please select another
+mirror. If all mirrors are failing, there are backup mirrors (at the end of
+the mirrors list) that should be available.
+If the mirror displayed above is labeled <em>preferred</em>, then please reload
+this page by <a href="http://sling.apache.org/site/downloads.cgi">clicking here</a>
+.</p>
+<p>{html}
+<form action="<a href="location.html">location</a>
+" method="get" id="SelectMirror">
+Other mirrors: </P><select name="Preferred">
+<a href="if-any-http.html">if-any http</a>
+<a href="for-http.html">for http</a>
+<option value="[http]">[http]</option>[end]
+<a href="end.html">end</a>
+<a href="if-any-ftp.html">if-any ftp</a>
+<a href="for-ftp.html">for ftp</a>
+<option value="[ftp]">[ftp]</option>[end]
+<a href="end.html">end</a>
+<a href="if-any-backup.html">if-any backup</a>
+<a href="for-backup.html">for backup</a>
+<option value="[backup]">[backup] (backup)</option>[end]
+<a href="end.html">end</a>
+</select>
+<input type="submit" value="Change"></input>
+</form>
+{html}</p>
+<p><a name="Downloads-SlingApplication"></a></p>
+<h2 id="sling-application">Sling Application</h2>
+<table>
+<tr><th> Artifact </th><th> Version </th><th> Provides </th><th> Package </th></tr>
+<tr><td> Sling Standalone Application </td><td> 6 </td><td> A self-runnable Sling jar. </td><td>
+{downloadmirror:sling}org.apache.sling.launchpad-6-standalone.jar{downloadmirror}
+</td></tr>
+<tr><td> Sling Web Application </td><td> 6 </td><td> A ready-to run Sling webapp as a war file. </td><td>
+{downloadmirror:sling}org.apache.sling.launchpad-6.war{downloadmirror} </td></tr>
+{downloadmirror:sling}sling-6-source-release.zip{downloadmirror} |
+</table>
+
+<p>If you want to experiment with bleeding edge code, <a href="getting-and-building-sling.html">building Sling yourself</a>
+ is not that hard.</p>
+<p>If you are looking for previous releases of Apache Sling, have a look in
+the <a href="http://archive.apache.org/dist/sling/">archives</a>
+. For previous incubator releases of Apache Sling, have a look in the [Incubator archives|http://archive.apache.org/dist/incubator/sling/]
+.</p>
+<p><a name="Downloads-SlingComponents"></a></p>
+<h2 id="sling-components">Sling Components</h2>
+<table>
+<tr><th> Artifact </th><th> Version </th><th> Binary </th><th> Source </th></tr>
+<tr><td> Adapter </td><td> 2.0.12 </td><td>
+{slingdownload:jar}org.apache.sling.adapter-2.0.12{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.adapter-2.0.12-source-release{slingdownload}
+</td></tr>
+<tr><td> API </td><td> 2.2.4 </td><td>
+{slingdownload:jar}org.apache.sling.api-2.2.4{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.api-2.2.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Auth Core </td><td> 1.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.auth.core-1.0.6{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.auth.core-1.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> Auth Form </td><td> 1.0.4 </td><td>
+{slingdownload:jar}org.apache.sling.auth.form-1.0.4{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.auth.form-1.0.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Auth OpenID </td><td> 1.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.auth.openid-1.0.2{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.auth.openid-1.0.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Auth Selector </td><td> 1.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.auth.selector-1.0.2{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.auth.selector-1.0.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Bundle Resource Provider </td><td> 2.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.bundleresource.impl-2.0.6{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.bundleresource.impl-2.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> Commons Classloader </td><td> 1.2.4 </td><td>
+{slingdownload:jar}org.apache.sling.commons.classloader-1.2.4{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.commons.classloader-1.2.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Commons Compiler </td><td> 2.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.commons.compiler-2.0.2{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.commons.compiler-2.0.2-project{slingdownload}
+</td></tr>
+<tr><td> Commons Log </td><td> 3.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.commons.log-3.0.0{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.commons.log-3.0.0-project{slingdownload}
+</td></tr>
+<tr><td> Commons Log Service </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.commons.logservice-1.0.0{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.commons.logservice-1.0.0-project{slingdownload}
+</td></tr>
+<tr><td> Commons HTML </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.commons.html-1.0.0{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.commons.html-1.0.0-project{slingdownload}
+</td></tr>
+<tr><td> Commons JSON </td><td> 2.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.commons.html-2.0.6{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.commons.html-2.0.6-project{slingdownload}
+</td></tr>
+<tr><td> Commons OSGi </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.commons.osgi-2.1.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.commons.osgi-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Commons Scheduler </td><td> 2.3.4 </td><td>
+{slingdownload:jar}org.apache.sling.commons.scheduler-2.3.4{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.commons.scheduler-2.3.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Commons Testing </td><td> 2.0.10 </td><td>
+{slingdownload:jar}org.apache.sling.commons.testing-2.0.10{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.commons.testing-2.0.10-source-release{slingdownload}
+</td></tr>
+<tr><td> Commons Threads </td><td> 3.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.commons.threads-3.1.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.commons.threads-3.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Engine </td><td> 2.2.4 </td><td>
+{slingdownload:jar}org.apache.sling.engine-2.2.4{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.engine-2.2.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Event </td><td> 3.1.2 </td><td>
+{slingdownload:jar}org.apache.sling.event-3.1.2{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.event-3.1.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Explorer </td><td> 1.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.extensions.explorer-1.0.2{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.extensions.explorer-1.0.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Failing Server-Side Tests </td><td> 1.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.testing.samples.failingtests-1.0.6{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.testing.samples.failingtests-1.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> FileSystem Provider </td><td> 1.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.fsresource-1.0.2{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.fsresource-1.0.2-source-release{slingdownload}
+</td></tr>
+<tr><td> GWT Integration </td><td> 3.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.gwt.servlet-3.0.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.gwt.servlet-3.0.0-source-release{slingdownload}
+</td></tr>
+<tr><td> I18n </td><td> 2.2.0 </td><td>
+{slingdownload:jar}org.apache.sling.i18n-2.2.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.i18n-2.2.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Installer Core </td><td> 3.3.4 </td><td>
+{slingdownload:jar}org.apache.sling.installer.core-3.3.4{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.installer.core-3.3.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Installer Configuration Support </td><td> 1.0.4 </td><td>
+{slingdownload:jar}org.apache.sling.installer.factory.configuration-1.0.4{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.installer.factory.configuration-1.0.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Installer File Provider </td><td> 1.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.installer.provider.file-1.0.2{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.installer.provider.file-1.0.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Installer JCR Provider </td><td> 3.1.2 </td><td>
+{slingdownload:jar}org.apache.sling.installer.provider.jcr-3.1.2{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.installer.provider.jcr-3.1.2-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR API </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.api-2.1.0{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.api-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR Base </td><td> 2.1.2 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.base-2.1.2{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.base-2.1.2-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR ClassLoader </td><td> 3.1.4 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.classloader-3.1.4{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.classloader-3.1.4-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR ContentLoader </td><td> 2.1.4 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.contentloader-2.1.4{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.jcr.contentloader-2.1.4-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR Compiler </td><td> 2.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.compiler-2.0.2{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.compiler-2.0.2-project{slingdownload}
+</td></tr>
+<tr><td> JCR Jackrabbit AccessManager </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.jackrabbit.accessmanager-2.1.0{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.jcr.jackrabbit.accessmanager-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR Jackrabbit Server </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.jackrabbit.server-2.1.0{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.jcr.jackrabbit.server-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR Jackrabbit UserManager </td><td> 2.2.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.jackrabbit.usermanager-2.2.0{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.jcr.jackrabbit.usermanager-2.2.0-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR Resource </td><td> 2.0.10 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.resource-2.0.10{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.resource-2.0.10-project{slingdownload}
+</td></tr>
+<tr><td> JCR Prefs </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.prefs-1.0.0{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.prefs-1.0.0-project{slingdownload}
+</td></tr>
+<tr><td> JCR WebDAV </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.webdav-2.1.0{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.webdav-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR DavEx </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.davex-1.0.0{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.davex-1.0.0-source-release{slingdownload}
+</td></tr>
+<tr><td> JCR Web Console Plugin </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.jcr.webconsole-1.0.0{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.jcr.webconsole-1.0.0-source-release{slingdownload}
+</td></tr>
+<tr><td> JUnit Core </td><td> 1.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.junit.core-1.0.6{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.junit.core-1.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> JUnit Remote Tests Runners </td><td> 1.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.junit.remote-1.0.6{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.junit.remote-1.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> JUnit Scriptable Tests Provider </td><td> 1.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.junit.scriptable-1.0.6{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.junit.scriptable-1.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> Mime Type Service </td><td> 2.1.4 </td><td>
+{slingdownload:jar}org.apache.sling.commons.mime-2.1.4{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.commons.mime-2.1.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad API </td><td> 1.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.launchpad.api-1.1.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.launchpad.api-1.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Base </td><td> 2.3.0 </td><td>
+{slingdownload:jar}org.apache.sling.launchpad.base-2.3.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.launchpad.base-2.3.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Base - Application Launcher </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.launchpad.base-2.1.0-app{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.launchpad.base-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Base - Web Launcher </td><td> 2.1.0 </td><td>
+{slingdownload:war}org.apache.sling.launchpad.base-2.1.0-webapp{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.launchpad.base-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Content </td><td> 2.0.6 </td><td>
+{slingdownload:war}org.apache.sling.launchpad.content-2.0.6{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.launchpad.content-2.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Installer </td><td> 1.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.launchpad.installer-1.1.0{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.launchpad.installer-1.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Integration Tests </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.launchpad.integration-tests-1.0.0{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.launchpad.integration-tests-1.0.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Testing Services </td><td> 2.0.8 </td><td>
+{slingdownload:jar}org.apache.sling.launchpad.test-services-2.0.8{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.launchpad.test-services-2.0.8-source-release{slingdownload}
+</td></tr>
+<tr><td> Launchpad Testing Services WAR </td><td> 2.0.8 </td><td>
+{slingdownload:war}org.apache.sling.launchpad.test-services-war-2.0.8{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.launchpad.test-services-war-2.0.8-source-release{slingdownload}
+</td></tr>
+<tr><td> Path-based RTP sample </td><td> 2.0.4 </td><td>
+{slingdownload:jar}org.apache.sling.samples.path-based.rtp-2.0.4{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.samples.path-based.rtp-2.0.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Rewriter </td><td> 1.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.rewriter-1.0.2{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.rewriter-1.0.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Sample Integration Tests </td><td> 1.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.testing.samples.integrationtests-1.0.6{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.testing.samples.integrationtests-1.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> Sample Server-Side Tests </td><td> 1.0.6 </td><td>
+{slingdownload:jar}org.apache.sling.testing.samples.sampletests-1.0.6{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.testing.samples.sampletests-1.0.6-source-release{slingdownload}
+</td></tr>
+<tr><td> Scripting API </td><td> 2.1.4 </td><td>
+{slingdownload:jar}org.apache.sling.scripting.api-2.1.4{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.scripting.api-2.1.4-source-release{slingdownload}
+</td></tr>
+<tr><td> Scripting Core </td><td> 2.0.20 </td><td>
+{slingdownload:jar}org.apache.sling.scripting.core-2.0.20{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.scripting.core-2.0.20-source-release{slingdownload}
+</td></tr>
+<tr><td> Scripting Java </td><td> 2.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.scripting.java-2.0.2{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.scripting.java-2.0.2-project{slingdownload}
+</td></tr>
+<tr><td> Scripting JavaScript </td><td> 2.0.12 </td><td>
+{slingdownload:jar}org.apache.sling.scripting.javascript-2.0.12{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.scripting.javascript-2.0.12-project{slingdownload}
+</td></tr>
+<tr><td> Scripting JSP </td><td> 2.0.20 </td><td>
+{slingdownload:jar}org.apache.sling.scripting.jsp-2.0.20{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.scripting.jsp-2.0.20-project{slingdownload}
+</td></tr>
+<tr><td> Scripting JSP Taglib </td><td> 2.1.6 </td><td>
+{slingdownload:jar}org.apache.sling.scripting.jsp.taglib-2.1.6{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.scripting.jsp.taglib-2.1.6-project{slingdownload}
+</td></tr>
+<tr><td> Scripting JST </td><td> 2.0.4 </td><td>
+{slingdownload:jar}org.apache.sling.scripting.jst-2.0.4{slingdownload} </td><td>
+{slingdownload:bin}org.apache.sling.scripting.jst-2.0.4-project{slingdownload}
+</td></tr>
+<tr><td> Security </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.security-1.0.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.security-1.0.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Servlets Get </td><td> 2.1.2 </td><td>
+{slingdownload:jar}org.apache.sling.servlets.get-2.1.2{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.servlets.get-2.1.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Servlets Post </td><td> 2.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.servlets.post-2.1.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.servlets.post-2.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Servlets Resolver </td><td> 2.1.2 </td><td>
+{slingdownload:jar}org.apache.sling.servlets.resolver-2.1.2{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.servlets.resolver-2.1.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Settings </td><td> 1.1.0 </td><td>
+{slingdownload:jar}org.apache.sling.settings-1.1.0{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.settings-1.1.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Test Tools </td><td> 1.0.2 </td><td>
+{slingdownload:jar}org.apache.sling.testing.tools-1.0.2{slingdownload} </td><td>
+{slingdownload:zip}org.apache.sling.testing.tools-1.0.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Thread Dumper </td><td> 0.2.2 </td><td>
+{slingdownload:jar}org.apache.sling.extensions.threaddump-0.2.2{slingdownload}
+</td><td>
+{slingdownload:bin}org.apache.sling.extensions.threaddump-0.2.2-source-release{slingdownload}
+</td></tr>
+<tr><td> Web Console Branding </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.extensions.webconsolebranding-1.0.0{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.extensions.webconsolebranding-1.0.0-source-release{slingdownload}
+</td></tr>
+<tr><td> Web Console Security Provider </td><td> 1.0.0 </td><td>
+{slingdownload:jar}org.apache.sling.extensions.webconsolesecurityprovider-1.0.0{slingdownload}
+</td><td>
+{slingdownload:zip}org.apache.sling.extensions.webconsolesecurityprovider-1.0.0-source-release{slingdownload}
+</td></tr>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Modified: websites/staging/sling/trunk/content/embedding-sling.html
==============================================================================
--- websites/staging/sling/trunk/content/embedding-sling.html (original)
+++ websites/staging/sling/trunk/content/embedding-sling.html Sun Apr 22 17:20:11 2012
@@ -82,7 +82,231 @@
<a href="/">Home</a>
</div>
<!-- <h1 class="title">Embedding Sling</h1> -->
+<!-- -->
+<p><a name="EmbeddingSling-EmbeddingSling"></a></p>
+<h1 id="embedding-sling">Embedding Sling</h1>
+<p>The Sling Launchpad Launcher can be used to embed the OSGi Framework
+startup in your own Java application. This functionality is implemented in
+the <a href="http://svn.apache.org/repos/asf/sling/trunk/launchpad/base">Sling Launchpad Base project</a>
+. This project has the following features:</p>
+<ul>
+<li>Builds three artifacts:
+<strong> A standalone Java Application with the artifact qualifier <em>app</em>; e.g.
+<em>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT-app.jar</em></strong> A Web Application with the artifact qualifier <em>webapp</em>; e.g
+<em>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT-wepabb.war</em>
+<em><em> The primary artifact without an artifact qualifier; e.g.
+</em>org.apache.sling.launchpad.base-2.3.1-SNAPSHOT.jar</em></li>
+<li>Embeds the OSGi Framework (Apache Felix) in the primary artifact</li>
+<li>Encapsulates the OSGi Framework in its own <em>URLClassLoader</em></li>
+<li>Supports Framework restart</li>
+<li>Allows propagation of core setup functionality depending on the
+environment</li>
+</ul>
+<p>This page is about the internal details of the Sling Launchpad Base module.
+To get an outside overview of the Sling Launchpad you might want to refer
+to <a href="the-sling-launchpad.html">The Sling Launchpad</a>
+ page.</p>
+<p><a name="EmbeddingSling-Structure"></a></p>
+<h1 id="structure">Structure</h1>
+<p>The Launcher is based on three parts:
+1. The external part which is for example the standalone Java application's
+main class or the servlet deployed into the servlet container
+1. The internal part which is the OSGi framework plus helper classes to
+control the framework and run initial installations
+1. The bridging part, which contains API common to the external and internal
+part.</p>
+<p>The external part uses the bridging part to create the class loader into
+which the internal part is loaded. The bidirectional communication between
+the external and internal part is implement based on two interfaces:</p>
+<ul>
+<li>The <em>Launcher</em> interface is implemented by a class in the internal part
+which is loaded through the bridge class loader. This interface allows
+setting, starting and stopping of the framework.</li>
+<li>The <em>Notifiable</em> interface is implemented by a class in the external
+part which instance is handed to the <em>Launcher</em> instance. This interface
+allows the internal part to communicate back to the external part, most
+notably to indicate that the framework has been stopped from within or that
+the framework has been updated and must be restarted.</li>
+</ul>
+<p><a name="EmbeddingSling-TheBridgingPart"></a></p>
+<h1 id="the-bridging-part">The Bridging Part</h1>
+<p>The bridging part is provided in the
+<em>org.apache.sling.launchpad.base.shared</em> package:</p>
+<table>
+<tr><td> Class </td><td> Description </td></tr>
+<tr><td> Launcher </td><td> The interface implemented by the internal class matching the
+external class being called to start/stop the framework. </td></tr>
+<tr><td> LauncherClassLoader </td><td> *URLClassLoader* implementing the class loader to
+load the internal part (along with the OSGi framework). This class loader
+only delegates to the parent class loader any packages not contained in the
+launchpad library (primary artifact of the Launchpad Base project). </td></tr>
+<tr><td> Loader </td><td> Helper class to find the launchpad library and to create the
+*LauncherClassLoader* with that library. This class is also used to
+actually load the *Launcher* implementation to be called from the
+external launcher class. </td></tr>
+<tr><td> Notifiable </td><td> The interface implemented in the external part and handed
+over to the internal part. </td></tr>
+<tr><td> SharedConstants </td><td> Constants naming various properties and classes. </td></tr>
+</table>
+<p><a name="EmbeddingSling-TheInternalPart"></a></p>
+<h1 id="the-internal-part">The Internal Part</h1>
+<p>The main class from the internal class directly used is <a href="http://svn.apache.org/repos/asf/sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/base/impl/Sling.java"><em>Sling</em></a>
+ which instantiated to start the OSGi Framework. This class is responsible
+for setting up the environment to finally start the OSGi Framework:</p>
+<ul>
+<li>Read the <em>sling.properties</em> file</li>
+<li>Ensure the presence of the JMX MBeanServer service</li>
+<li>Execute the bootstrap installations, updates and uninstallations</li>
+</ul>
+<p>The <a href="http://svn.apache.org/repos/asf/sling/trunk/launchpad/base/src/main/java/org/apache/sling/launchpad/base/impl/SlingFelix.java"><em>SlingFelix</em></a>
+ class extends the Apache Felix <em>Felix</em> class which is the actual OSGi
+framework implementation. We extend the class to be able to notify the
+<em>Notifiable</em> implementation and update the OSGi framework from within the
+OSGi framework by updating the system bundle.</p>
+<p><a name="EmbeddingSling-TheExternalPart"></a></p>
+<h2 id="the-external-part">The External Part</h2>
+<p>The external part is comprised of a main class started from the environment
+-- main class of the Java applicaction or the servlet deployed in the
+servlet container -- and a corresponding delegate class located inside of
+the launchpad base library. This delegate class is instantiated by the
+<em>Loader</em> loading from the <em>LauncherClassLoader</em>.</p>
+<p><a name="EmbeddingSling-StandaloneJavaApplication"></a></p>
+<h3 id="standalone-java-application">Standalone Java Application</h3>
+<p>The standalone Java Application makes use of three classes:</p>
+<table>
+<tr><td> Class </td><td> Description </td></tr>
+<tr><td> Main </td><td> This is the main class whose *main* method is called by the Java
+VM. This class is itself the *Notifiable* and finds the *sling.home*
+location from the environment (command line parameter, system property, or
+environment variable). </td></tr>
+<tr><td> MainDelegate </td><td> This class is loaded by the *Loader* from the
+*LauncherClassLoader* to actually complete the initial setup before
+creating the *Sling* class to start the framework. </td></tr>
+<tr><td> ControlListener </td><td> This class is used by the *Main* class to open a
+server socket to be able to start and stop Sling as a server. This class
+allows for starting (opening the server socket), status check (connecting
+to the socket asking for status), and shutdown (connecting to the socket
+asking for shutdown). </td></tr>
+</table>
+
+<p>At the moment these classes are not directly suitable to be embedded in an existing application (or custom application launcher framework) unless that embedding prepares command line arguments in a {{String<a href=".html"></a>
+}} and calls the <em>Main.main</em> method. To allow for custom embeddings or
+extensions, the work distriubtions between the three classes should be
+refactored.</p>
+<p><a name="EmbeddingSling-EmbeddingtheStandaloneJavaApplication"></a></p>
+<h3 id="embedding-the-standalone-java-application">Embedding the Standalone Java Application</h3>
+<p>{info}
+This work is being done as part of <a href="https://issues.apache.org/jira/browse/SLING-2225">SLING-2225</a>
+ and will be officially available with the Sling Launchpad Base release
+2.4.0. If you want to use the embedding before the release, you have to
+checkout the source from [SVN|http://svn.apache.org/repos/asf/sling/trunk/launchpad/base]
+ and build yourself.
+{info}</p>
+<p>To embedd the Sling Launcher in an application, the <em>Main</em> class is
+extended from. To manage the launcher, the following API is available:</p>
+<table>
+<tr><th> Method </th><th> Description </th></tr>
+<tr><td> *Main(Map<String, String> properties)* </td><td> Instantiates the Main class
+with the given configuration properties. These are properties which are
+used directly as overwrites to the configurations in the
+*sling.properties* file. There is no more conversion applied. </td></tr>
+<tr><td> *doControlCommand()* </td><td> Before starting the application for the first
+time, this method can be called to handle any control command action. </td></tr>
+<tr><td> *doStart()* </td><td> Starts the Sling Application using the provided
+configuration properties as overwrites. Also these properties (or the
+*sling.home* system property or the *SLING_HOME* environment variable
+are analyzed to get the value for the *sling.home* setting. </td></tr>
+<tr><td> *doStop()* </td><td> Stops the application started by the *doStart()* method.
+</td></tr>
+</table>
+
+<p><a name="EmbeddingSling-ExternalControloftheSlingApplication"></a></p>
+<h4 id="external-control-of-the-sling-application">External Control of the Sling Application</h4>
+<p>By using control actions, the Sling Launcher may open or connect to a
+control port to communicate. The <em>doControlAction()</em> method together with
+the <em>sling.control.action</em> and <em>sling.control.socket</em> properties is
+able to setup this communication.</p>
+<p>The <em>sling.control.socket</em> is either a normal port number, in which case
+the connection is opened on the <em>localhost</em> interface (usually
+127.0.0.1). Otheriwse, it may also be a value of the form <em>host:port</em> where
+<em>host</em> is the name or IP address of the interface to connect to and port is
+the port number. For security reasons it is suggested to not use an
+interface which is available remotely. So the default of <em>localhost</em> is
+usually the best choice.</p>
+<p>The <em>sling.control.action</em> takes either of three values:</p>
+<table>
+<tr><td> *start* </td><td> Starts a server socket as specified by the
+*sling.control.socket* property. If the socket cannot be bound to
+(because the port is in use) an error message is printed. Using the
+*start* action only makes sense when starting the application. </td></tr>
+<tr><td> *stop* </td><td> The *stop* action is used to stop a running application. For
+that a connection is opened to the server running on the socket specified
+by the *sling.control.socket* property. On this connection the server is
+instructed to shut down. After executing the *stop* action, the Java
+application should be terminated. </td></tr>
+<tr><td> *status* </td><td> The *status* action is used to check the status of a
+running application. For that a connection is opened to the server running
+on the socket specified by the *sling.control.socket* property. On this
+connection the server is queried on its status. After executing the
+*stop* action, the Java application should be terminated. </td></tr>
+</table>
+
+<p><a name="EmbeddingSling-ConversionofCommandlineArgumentstoProperties"></a></p>
+<h4 id="conversion-of-commandline-arguments-to-properties">Conversion of Commandline Arguments to Properties</h4>
+<p>When calling the Main class through the JVM startup the {{Main.main(String<a href=".html"></a>
+ args)}} methods is called which reads the command line arguments and
+converts them into a <em>Map<String, String></em> suitable for the constructore
+as follows:</p>
+<table>
+<tr><th> Command Line Argument </th><th> Properties Entry </th></tr>
+<tr><td> start </td><td> sling.control.action = "start" </td></tr>
+<tr><td> status </td><td> sling.control.action = "status" </td></tr>
+<tr><td> stop </td><td> sling.control.action = "stop" </td></tr>
+<tr><td> -c slinghome </td><td> sling.home = slinghome </td></tr>
+<tr><td> -l loglevel </td><td> org.apache.sling.commons.log.level = loglevel </td></tr>
+<tr><td> -f logfile </td><td> org.apache.sling.commons.log.file = logfile </td></tr>
+<tr><td> -a address </td><td> This command line argument is not supported yet and thus
+ignored </td></tr>
+<tr><td> -p port </td><td> org.osgi.service.http.port = port </td></tr>
+<tr><td> -j [ host ":" ](-host-":"-.html)
+ port </td><td> sling.control.socket = [ host ":" ]
+ port </td></tr>
+<tr><td> -h </td><td> This command line option is handled directly and not converted into
+the map </td></tr>
+</table>
+
+<p><a name="EmbeddingSling-WebApplication"></a></p>
+<h3 id="web-application">Web Application</h3>
+<p>The web application makes use of 5 classes:</p>
+<table>
+<tr><td> Class </td><td> Description </td></tr>
+<tr><td> SlingServlet </td><td> This is the servlet registered in the *web.xml*
+descriptor and loaded by the servlet container into which Sling is
+deplyoed. This class locates the *sling.home* folder and loads the
+*SlingServletDelagate* to actually launch the framework. </td></tr>
+<tr><td> SlingSessionListener </td><td> This -- somewhat inappropriately named -- class is
+registered as a listener by the Sling *web.xml* descriptor. It is called
+by the servlet container and forwards events to the
+*SlingHttpSessionListenerDelegate* which in turn forwards the events to
+the respective Servlet API listener services registered in the OSGi
+Framework. </td></tr>
+<tr><td> SlingBridge </td><td> Simple extension of the *Sling* class which registers the
+system bundle's *BundleContext* as a servlet context attribute of the
+Sling web application. This allows Servlet Container bridging to properly
+work. </td></tr>
+<tr><td> SlingHttpSessionListenerDelegate </td><td> This class is loaded by the
+*LauncherClassLoader* called from the *SlingSessionListener*. It is
+called by the *SlingSessionListener* to forward servlet container events
+to registered Servlet API listener services. </td></tr>
+<tr><td> SlingServletDelegate </td><td> This class is loaded by the *Loader* from the
+*LauncherClassLoader* to actually complete the initial setup before
+creating the *SlingBridge* class to start the framework. </td></tr>
+</table>
+
+<p>At the moment these classes, particularly the <em>SlingServlet</em> class, are
+not particularly well suited to be extended by a servlet slightly modifying
+the launcher.</p>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Modified: websites/staging/sling/trunk/content/errorhandling.html
==============================================================================
--- websites/staging/sling/trunk/content/errorhandling.html (original)
+++ websites/staging/sling/trunk/content/errorhandling.html Sun Apr 22 17:20:11 2012
@@ -82,7 +82,85 @@
<a href="/">Home</a>
</div>
<!-- <h1 class="title">Errorhandling</h1> -->
-
+<!-- -->
+<p><a name="Errorhandling-HandlingErrors"></a></p>
+<h1 id="handling-errors">Handling Errors</h1>
+<p>The Sling Engine includes support for handling uncaught <em>Throwable</em> as
+well as rendering custom HTTP status code pages. This is implemented by
+expecting a (single) <em>org.apache.sling.engine.servlets.ErrorHandler</em>
+service to which handling of uncaught <em>Throwable</em> and HTTP status
+responses are delegated.</p>
+<p>The Sling Servlet Resolver bundle implements this interface by providing an
+elaborate mechanism to find the correct error handling script or servlet
+using the same algorithms as are used to select the scripts or servlets to
+handle regular requests.</p>
+<p>This page provides more information on how error handler scripts are
+selected and what is provided out of the box.</p>
+<p><a name="Errorhandling-HTTPStatusCodes"></a></p>
+<h2 id="http-status-codes">HTTP Status Codes</h2>
+<p>The Sling engine implements the <em>HttpServletResponse.sendError</em> methods
+by calling the {{ErrorHandler.handleError(int status, String message,
+SlingHttpServletRequest request, SlingHttpServletResponse response)}}
+method.</p>
+<p>The Servlet Resolver bundle implementation looks up a script to handle the
+status code as follows:</p>
+<ul>
+<li>The status code is converted to a string and used as the request
+extension. Any request extensions, selectors or suffixes from the actual
+request are ignored.</li>
+<li>The same resource type hierarchy is followed to find the script as for
+regular script resolution. The difference is that for error handler scripts
+<em>sling/servlet/errorhandler</em> is used as the implied base resource type
+(as opposed to <em>sling/servlet/default</em> for regular script resolution.</li>
+</ul>
+<p><em>Examples:</em></p>
+<ul>
+<li>An application provider my provide a default handler for the 404/NOT
+FOUND status. This script might be located in
+<em>/libs/sling/servlet/errorhandler/404.jsp</em>.</li>
+<li>An programmer might provide a handler for the 403/FORBIDDEN status in
+<em>/apps/sling/servlet/errorhandler/403.esp</em>.</li>
+</ul>
+<p><a name="Errorhandling-UncaughtThrowables"></a></p>
+<h2 id="uncaught-throwables">Uncaught Throwables</h2>
+<p>To handle uncaught Throwables the simple name (<em>Class.getSimpleName()</em>)
+of the <em>Throwable</em> class is used as request extension. Similarly to the
+Java try-catch clauses the class hierarchy is supported. That is to handle
+an uncaught <em>FileNotFoundException</em>, the names <em>FileNotFoundException</em>,
+<em>IOException</em>, <em>Exception</em>, <em>Throwable</em> are checked for a Servlet and
+the first one found is then used. Again, the Serlvet may be a Servlet
+registered as an OSGi service or may be a plain script stored in the JCR
+repository or provided through some custom Resource provider.</p>
+<p><em>Example:</em>
+To register a catch-all handler for any uncaught Throwables you might
+create a script <em>/apps/sling/servlet/errorhandler/Throwable.esp</em>.</p>
+<p><em>Note:</em> If no script or servlet to handle an uncaught <em>Throwable</em> is
+registered, the default handler kicks in, which sends back a 500/INTERNAL
+SERVER ERROR response containing the <em>Throwable</em> and the stack trace.
+This response is <em>not</em> handled by the HTTP Status Code handling described
+above because the response status is sent using
+<em>HttpServletResponse.setStatus(int, String)</em>. To prevent this default
+response you have to implement a catch-all handler for the <em>Throwable</em>
+class as shown in the example.</p>
+<p><a name="Errorhandling-DefaultHandler"></a></p>
+<h2 id="default-handler">Default Handler</h2>
+<p>The Sling Servlet Resolver bundle provides a default error handler servlet
+which is used if the algorithms described above do not resolve to a handler
+script or servlet. The provided error handler servlet does the following:</p>
+<ul>
+<li>Print a descriptive message, which is the
+<em>javax.servlet.error.message</em> request attribute by default</li>
+<li>Print a stacktrace if the <em>javax.servlet.error.exception</em> is set</li>
+<li>Dump the request progress tracker</li>
+</ul>
+<p>Starting with Sling Servlet Resolver version 2.0.10 the default error
+handler servlet is looked up using the string <em>default</em> as the request
+extension and the provided default servlet is registered as
+<em><prefix>/sling/servlet/errorhandler/default.servlet</em> where <prefix> is
+the last entry in the resource resolver search path, <em>/libs</em> by default.</p>
+<p>Thus to overwrite the default error handler servlet provide a servlet or
+script for the <em>default</em> extension, for example
+<em>/apps/sling/servlet/errorhandler/default.groovy</em>.</p>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Modified: websites/staging/sling/trunk/content/eventing-and-jobs.html
==============================================================================
--- websites/staging/sling/trunk/content/eventing-and-jobs.html (original)
+++ websites/staging/sling/trunk/content/eventing-and-jobs.html Sun Apr 22 17:20:11 2012
@@ -82,7 +82,411 @@
<a href="/">Home</a>
</div>
<!-- <h1 class="title">Eventing and Jobs</h1> -->
-
+<!-- -->
+<p><a name="EventingandJobs-Eventing,JobsandScheduling"></a></p>
+<h2 id="eventing-jobs-and-scheduling">Eventing, Jobs and Scheduling</h2>
+<p>Apache Sling provides some mechanisms and support for eventing, handling
+jobs and scheduling. </p>
+<p>To get some hands on code, you can refer to the following tutorials:
+<em> <a href="how-to-manage-events-in-sling.html">How to Manage Events in Sling</a>
+</em> <a href="scheduler-service-(commons-scheduler).html">Scheduler Service (commons scheduler)</a></p>
+<p><a name="EventingandJobs-PossibleUseCasesforEventing"></a></p>
+<h3 id="possible-use-cases-for-eventing">Possible Use Cases for Eventing</h3>
+<ul>
+<li>Workflow</li>
+<li>Post Processing (business processes)</li>
+<li>Caching</li>
+<li>Auditing</li>
+</ul>
+<p><a name="EventingandJobs-SourcesofEvents"></a></p>
+<h3 id="sources-of-events">Sources of Events</h3>
+<p>There is a variety of sources from which events can be send:
+<em> JCR observation events
+</em> Application generated events
+<em> Events from messaging systems (~JMS)
+</em> "External events"</p>
+<p>The events can eiter be generated inside a current user context, e.g. when
+the user performs an action through the UI, or they can be out of a user
+context, e.g. for schedulded events. This leads to different weights of
+events.</p>
+<p><a name="EventingandJobs-WeightsofEvents"></a></p>
+<h3 id="weights-of-events">Weights of Events</h3>
+<p>We can distinguish two different weights of events, depending how they are
+distributed in a clustered environment:</p>
+<ul>
+<li>User generated events - these events are generated directly by some user
+action and are therefore started on one single node.</li>
+<li>Environment generated events (JCR events, scheduler events etc.) - these
+events are generated "simultaniously" on all nodes.</li>
+</ul>
+<p>External events, like incoming JMS events etc. might fall either into the
+first or the second category. The receiver of such events must have the
+knowledge about the weight of the event.</p>
+<p><a name="EventingandJobs-BasicPrinciples"></a></p>
+<h3 id="basic-principles">Basic Principles</h3>
+<p>The foundation of the 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, however the sender must explicitly declare an event to be
+distributed. There are exceptions to "distributing everything to
+everywhere" 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>The event mechanism is an <em>event</em> mechanism which should not be confused
+with a <em>messaging</em> mechanism. Events are received by the event mechanism
+and distributed to registered listeners. Concepts like durable listeners,
+guarantee of processing etc. are not part of the event mechanism itself.
+However, there will be additional support for such things, like job events.</p>
+<p>The application should try to use application events instead of low level
+JCR events whereever possible. Therefore a bridging between JCR events and
+the event mechanism is required. However, a general "automatic" mapping
+will not be provided. It is up to the application to develop such a mapping
+on a per use case base. There might be some support to make the mapping
+easier.</p>
+<p>The event handling should be made as transparent to the developer as
+possible. Therefore the additional code for a developer to make the
+eventing working in a clustered environment etc. should be kept to a
+minimum (which will hopefully reduce possible user errors).</p>
+<p><a name="EventingandJobs-EventMechanism"></a></p>
+<h2 id="event-mechanism">Event Mechanism</h2>
+<p>The event mechanism is leveraging the OSGi Event Admin Specification (OSGi
+Compendium 113). The event admin specification provides a sufficient base.
+It is based on the event publish and subscribe mechanism. Each event is
+associated with a topic and data. The data consists of custom key-value
+pairs where the keys are strings and the values can be any object. However,
+to work in distributed environments it is advisable to use only string and
+scalar types for data. If complex objects are required they have to be
+serializable.</p>
+<p>Events can either be send synchronously or asynchronously. It is up to the
+caller (the one sending the event) to decide this by choosing one of the
+provided methods.</p>
+<p>The OSGi API is very simple and leightweight - sending an event is just
+generating the event object and calling the event admin. Rceiving the event
+is implementing a single interface and declaring through properties which
+topics one is interested in. It's possible to add an additional filter
+(based on property values for example).</p>
+<p>%N The event handler should not take too much time to process the event.
+For example, the Apache Felix implementation of the event admin black lists
+an event handler if it takes more than 5 seconds to process the event -
+regardless if the event is sent synchronously or asynchronously. Therefore
+any heavier processing has to be done in the background. The event is just
+the trigger to start this. The job mechanism explained in this
+documentation is a good way of implementing this functionality for an event
+handler.</p>
+<p>The aim is to add all functionality on top of an existing event admin
+implementation. Therefore everything should be added by additional event
+handlers.</p>
+<p><a name="EventingandJobs-EventHandler"></a></p>
+<h2 id="event-handler">Event Handler</h2>
+<p>An event handler registers itself on a (set of) topic. It can also specify
+a filter for the events. This event handler is either notified
+synchronously or asynchronously depending on how the event has been sent.</p>
+<p><a name="EventingandJobs-Events"></a></p>
+<h2 id="events">Events</h2>
+<p>The type of the event is specified by the hierarchically organized topic.
+In order to provide clustering of JCR repositories and clustering of the
+sling based application instances, each event can contain the following
+properties - if they are absent, a default value is assumed:</p>
+<ul>
+<li>=event.distribute= - this flag is set by the sender of an event to give a
+hint if the event should be distributed across instances. For example JCR
+observation based events are already distributed on all instances, so there
+is no further need to distribute them. If the flag is present, the event
+will be distributed. The value has currently no meaning, however the
+EventUtil method should be used to add this property. If the flag is absent
+the event is distributed locally only.</li>
+<li>=event.application= - 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 note,
+the =event.application= is missing, if it is a remote event, the
+=event.application= contains the ID of the node, the event has been
+initially created.</li>
+</ul>
+<p>While the =event.distribute= must be set by the sender of an event (if the
+event should be distributed), the =event.application= 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
+=event.application= is set by the event distribution mechanism.</p>
+<p><a name="EventingandJobs-EventDistributionAcrossApplicationNodes(Cluster)"></a></p>
+<h2 id="event-distribution-across-application-nodes-cluster">Event Distribution Across Application Nodes (Cluster)</h2>
+<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, the JCR repository is used for distribution. The
+distributing event handler writes the events into the repository, 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 =event.distribute= in the event
+properties (through ~EventUtil).
+The existance of this flag allows to register an event handler for all
+events having this flag. The event handler will add the =event.application=
+information and write the event into the repository. All other application
+nodes have an observer registered and get notified each time a new event is
+added to the repository. They'll read the event from the repository, clear
+the =event.distribute= and send this event locally and asynchronously.</p>
+<p>An event handler receiving such an event can distinguish it by checking the
+=event.application= property. If the property is not available, it is a
+local event - if the property is available it is a remote event.</p>
+<p>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. Defining the filter for the
+=event.distribute= is also very simple.</p>
+<p><a name="EventingandJobs-StoringEventsintheRepository"></a></p>
+<h3 id="storing-events-in-the-repository">Storing Events in the Repository</h3>
+<p>Distributable events are stored in the repository, the repository will have
+a specific area (path) where all events are stored. </p>
+<p>Each event is stored as a separate node with the following properties:
+<table>
+<tr><td> <em>Property Name</em> </td><td> <em>Description</em> </td></tr>
+<tr><td> =event:topic= </td><td> The topic of the event </td></tr>
+<tr><td> =event:application= </td><td> The identifier of the application node where the
+event was created </td></tr>
+<tr><td> =event:created= </td><td> The date and time when the event has been created
+(stored in the repository)
+</tr>
+<tr><td> =event:properties= </td><td> Serialized properties (except the
+=event.distribute=, but including the =event.application=) </td></tr>
+</table></p>
+<p>Each application is periodically removing old events from the repository
+(using the scheduler).</p>
+<p><a name="EventingandJobs-Jobs(GuaranteeofProcessing)"></a></p>
+<h2 id="jobs-guarantee-of-processing">Jobs (Guarantee of Processing)</h2>
+<p>In general, the eventing mechanism has no knowledge about the contents of
+an event. Therefore, it can't decide if an event must be processed by a
+node. 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
+processed the event.</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 this event
+exactly once. Typical examples are sending notification emails (or sms) or
+post processing of content (like thumbnail generation of images or
+documents).</p>
+<p>We will call these events jobs to make clear that someone has to do
+something with the event (do the job). We will use a special topic
+=org/apache/sling/event/job= to indicate that the event contains a job, the
+real topic of the event is stored in the =event.job.topic= property. When a
+job event (event with the topic =org/apache/sling/event/job=) is received,
+a new event with the topic from the property =event.job.topic= is fired.</p>
+<p>The event must have the following properties:
+<table>
+<tr><td> <em>Property Name</em> </td><td> <em>Description</em> </td></tr>
+<tr><td> =event.job.topic= </td><td> The topic of the job </td></tr>
+<tr><td> =event.job.id= </td><td> A unique identifier for this job (optional) </td></tr>
+</table></p>
+<p>The job event handler listens for all job events (all events with the topic
+=org/apache/sling/event/job=). The event handler will write the job event
+into the repository (into the job area), lock it, create a new event with
+the topic from the property =event.job.topic= and send the job event
+through the event admin. When the job is finished, the event listener will
+unlock the node from the repository.</p>
+<p>To avoid timeouts and black listing of event handlers, the job event
+handler does not assume that the job has been processed if the event could
+be sent successfully. It is the task of the event handler to notify the job
+event handler that it has processed the job. In addition, the job
+processing should be done in the background. The =EventUtil= class has a
+helper method for this: =processJob(Event, JobProcessor)=. The event
+handler must implement the =JobProcessor= interface which consists of a
+single =process(Event)= method. When the event handler receives a job
+event, it calls =EventUtil.processJob(event, this)= and returns. The
+=process(Event)= method is now called in the background and when it
+finishes, the job event handler is notified that the job is completed.</p>
+<p>If the event handler wants to do the background processing by itself or
+does not need background processing at all, it must signal completition of
+the job by call =EventUtil.finishedJob(event)=.</p>
+<p>By default an application node is queuing the jobs which means that only
+one job is processed at a time. If a job can be run in parallel on one
+application node, the property =event.job.parallel= should be set with any
+value.</p>
+<p>The job id is optional and can be used to update or reactivate jobs.</p>
+<p><a name="EventingandJobs-StoringJobsintheRepository"></a></p>
+<h3 id="storing-jobs-in-the-repository">Storing Jobs in the Repository</h3>
+<p>Jobs are stored in the repository in order to ensure that exactly one
+single application node is processing the job. The repository will have a
+specific area (path) where all jobs are stored. In order to distinguish a
+job which occured twice and a job which is generated at the same time on
+several nodes, each job can be uniquely identified by its topic (property
+=event.job.topic=) and the =event.job.id= property. It is up to the client
+who is creating the event to ensure that the =event.job.id= property is
+unqiue <em>and</em> identical on all application nodes. If the job id is not
+provided for the job, then it is up to the client to ensure that the job
+even is only fired once.</p>
+<p>When the job event listener tries to write a job into the repository it
+will check if the repository already contains a job with the given topic
+=event.job.topic= and =event.job.id= property. If the event has already
+been written by some other application node, it's not written again. If the
+event has been written by the same node, it will be set to active again
+(=event:active= will be set to true and =event:created= will be updated).</p>
+<p>Each job is stored as a separate node with the following properties:
+<table>
+<tr><td> <em>Property Name</em> </td><td> <em>Description</em> </td></tr>
+<tr><td> =event:topic= </td><td> The topic of the job </td></tr>
+<tr><td> =event:application= </td><td> The identifier of the node where the job was
+created </td></tr>
+<tr><td> =event:processor= </td><td> The identifier of the node which processed the job
+</td></tr>
+<tr><td> =event:active= </td><td> Indicates if this job is active and should be
+processed(unlocked) or is currently processed (locked) </td></tr>
+<tr><td> =event:created= </td><td> The date and time when the event has been created
+(stored in the repository)
+</tr>
+<tr><td> =event:id= </td><td> The unique identifier of this job (optional).
+</tr>
+<tr><td> =event:properties= </td><td> Serialized properties </td></tr>
+<tr><td> =event:finished= </td><td> The date and time when the job has been finished </td></tr>
+</table></p>
+<p>The failover of an application node is accomplished by locking and the
+=event:active= flag. If a job is locked in the repository a session scoped
+lock is used. If this application node dies, the lock dies as well. Each
+application node observes the JCR locking properties and therefore gets
+aware of unlocked event nodes with the active flag set to true. If an
+application node finds such a node, it locks it, updates the
+=event:application= information and processes it accordingly. In this case
+the event gets the additional property =org/apache/sling/job/retry=. </p>
+<p>Each application is periodically removing old jobs from the repository
+(using the scheduler).</p>
+<p><a name="EventingandJobs-DistributionofJobs"></a></p>
+<h3 id="distribution-of-jobs">Distribution of Jobs</h3>
+<p>A job event is an event like any other. Therefore it is up to the client
+generating the event to decide if the event should be distributed. If the
+event is distributed, it will be distributed with a set =event.application=
+on the remote nodes. If the job event handler receives a job with the
+=event.application= property set, it will not try to write it into the
+repository. It will just broadcast this event asynchronously as a ~FYI
+event.</p>
+<p>If a job event is created simultanously on all application nodes, the event
+will not be distributed. The application node that actually has the lock on
+the stored job in the repository will clear the =event.application= when
+sending the event locally. All other application nodes will use the
+=event.application= stored in the repository when broadcasting the event
+locally.</p>
+<p><a name="EventingandJobs-UsagePatterns"></a></p>
+<h2 id="usage-patterns">Usage Patterns</h2>
+<p>Based on some usage patterns, we discuss the functionality of the eventing
+mechanism.</p>
+<p><a name="EventingandJobs-SendingUserGeneratedEvents"></a></p>
+<h3 id="sending-user-generated-events">Sending User Generated Events</h3>
+<p>If a user action results in an event, the event is only created on one
+single node in the cluster. The event object is generated and delivered to
+the OSGi event admin. If the =event.distribute= is not explicitly set, the
+event is only distributed localled.</p>
+<p>If the =event.distribute= is the, the cluster event handler will write the
+event into the repository. All nodes in the cluster observe the repository
+area where all events are stored. If a new event is written into that area,
+each application node will get notified. It will create the event based on
+the information in the repository, clear the =event.distribute= and publish
+the event.</p>
+<p>The flow can be described as follows:
+1. Client code generates event using OSGi API, if the =event.distribute=
+should be set, it is using the ~EventUtil.
+1. Client code sends the event to the (local) event admin.
+1. Event admin delivers the event locally.
+1. Clustering event handler receives the event if =event.distribute= is
+present
+1. # Event handler adds =event.application= and writes the event to the
+repository
+1. # Remote repository observers get notified through JCR observation about
+the new event. They distribute the event locally with the
+=event.application= (from the node where the event occured first) and
+cleared =event.distribute=.</p>
+<p><a name="EventingandJobs-ProcessingJCREvents"></a></p>
+<h3 id="processing-jcr-events">Processing JCR Events</h3>
+<p>JCR events are environment generated events and therefore are sent by the
+repository to each node in the cluster. In general, it is advisable to not
+built the application on the low level repository events but to use
+application events. Therefore the observer of the JCR event should create
+an OSGi event based on the changes in the repository. A decision has to be
+made if the event should be a job or a plain event.</p>
+<p>The flow can be described as follows:
+1. Client registers for JCR observation
+1. JCR notifies the client for changes
+1. Client generates OSGi event based on the JCR events (the
+=event.distribute= will not be set), it decides if it sends this event as a
+job.
+1. Client code sends the event to the (local) event admin
+1. Event admin publishes the event locally
+1. The distribution event handler does not set see the event as the
+=event.distribute= is not set.
+1. The job event handler gets the event if it has the job topic
+1. # The job event handler adds the =event.application= property and tries to
+write the job to the repository
+1. ## If no job with the topic and =id= property is in the repository, the
+event will be written and locked.
+1. ## If an event with the topic and =id= property is in the repository then:
+1. ### If the =event.application= equals the current application node, the
+event is set to active (=event:active=) in the repository again and locked
+1. ### If the =event.application= does not equal the current application
+node, the event is not distributed locally.
+1. ## If the job could be locked in the repository, the job event handler
+delivers the job locally and synchronously and it unlocks the job and sets
+=event:active= to false afterwards.</p>
+<p><a name="EventingandJobs-SendingScheduledEvents"></a></p>
+<h3 id="sending-scheduled-events">Sending Scheduled Events</h3>
+<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>
+<p>In most use cases a scheduler will send job events to ensure that exactly
+one application node is processing the event.</p>
+<p><a name="EventingandJobs-ReceivingOSGiEvents"></a></p>
+<h3 id="receiving-osgi-events">Receiving OSGi Events</h3>
+<p>If you want to receive OSGi events, you can just follow the specification:
+receive it via a custom event handler which is registered on bundle start -
+a filter can be specified as a configuration property of the handler. </p>
+<p>As we follow the principle of distributing each event to every registered
+handler, the handler has to decide if it will process the event. In order
+to avoid multiple processing of this event in a clustered environment, the
+event handler should check the =event.application= property. If it is not
+set, it's a local event and the handler should process the event. If the
+=event.application= is set, it's a remote event and the handler should not
+process the event. This is a general rule of thumb - however, it's up to
+the handler to make its decision either on =event.application= or any other
+information.</p>
+<p>It is advisable to perform the local event check even in a non clustered
+environment as it makes the migration to a cluster later on much easier and
+there is nearly no performance overhead caused by the check.</p>
+<p>The ~EventUtil class provides an utility method =isLocalEvent(Event)= which
+checks the existance of the =event.application= property and returns =true=
+if it is absend.</p>
+<p><a name="EventingandJobs-Scheduler"></a></p>
+<h2 id="scheduler">Scheduler</h2>
+<p>Each Sling based application will contain a scheduler service (which is
+based on the Quartz open source project).</p>
+<p><a name="EventingandJobs-UseCases"></a></p>
+<h2 id="use-cases">Use Cases</h2>
+<p><a name="EventingandJobs-PostProcessing(BusinessProcesses)"></a></p>
+<h3 id="post-processing-business-processes">Post Processing (Business Processes)</h3>
+<p>A typical example for post processing (or running a business process) is
+sending an email or creating thumbnails and extracting meta data from the
+content (like we do in DAM), which we will discuss here.</p>
+<p>An appropriate JCR observer will be registered. This observer detects when
+new content is put into the repository or when content is changed. In these
+cases it creates appropriate =CONTENT_ADDED=, =CONTENT_UPDATED= OSGi events
+from the JCR events. In order to ensure that these actions get processed
+accordingly, the event is send as a job (with the special job topic, the
+=topic= and =id= property).</p>
+<p>The event admin now delivers these jobs to the registered handlers. The job
+event handler gets notified and (simplified version) sends the contained
+event synchronously. One of the handlers for these events is the post
+processing service in DAM. The job mechanism ensures that exactly one
+application node is post processing and that the process has to be finished
+even if the application node dies during execution.</p>
+<p><a name="EventingandJobs-Scheduling"></a></p>
+<h2 id="scheduling">Scheduling</h2>
+<p>The scheduler is a service which uses the open source Quartz library. The
+scheduler has methods to start jobs periodically or with a cron definition.
+In addition, a service either implementing =java.lang.Runnable= or
+=org.quartz.job= is started through the whiteboard pattern <em>if</em> it either
+contains a configuration property =scheduler.expression= or
+=scheduler.period=. The job is started with the ~PID of the service - if
+the service has no PID, the configuration property =scheduler.name= must be
+set.</p>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
Modified: websites/staging/sling/trunk/content/filters.html
==============================================================================
--- websites/staging/sling/trunk/content/filters.html (original)
+++ websites/staging/sling/trunk/content/filters.html Sun Apr 22 17:20:11 2012
@@ -82,7 +82,224 @@
<a href="/">Home</a>
</div>
<!-- <h1 class="title">Filters</h1> -->
+<!-- -->
+<p><a name="Filters-ServletFilterSupport"></a></p>
+<h1 id="servlet-filter-support">Servlet Filter Support</h1>
+<p>Sling supports filter processing by applying filter chains to the requests
+before actually dispatching to the servlet or script for processing.
+Filters to be used in such filter processing are plain OSGi services of
+type <em>javax.servlet.Filter</em> which of course means that the services
+implement this interface.</p>
+<p>{note}</p>
+<p>See <a href="https://issues.apache.org/jira/browse/SLING-1213">SLING-1213</a>
+, [SLING-1734|https://issues.apache.org/jira/browse/SLING-1734]
+, and [Registering filters with Sling|http://markmail.org/message/quxhm7d5s6u66crr]
+ for more details.
+{note}</p>
+<p>For Sling to pick up a <em>javax.servlet.Filter</em> service for filter
+processing two service registration properties are inspected:</p>
+<table>
+<tr><th> Property </th><th> Type </th><th> Default Value </th><th> Valid Values </th><th> Description </th></tr>
+<tr><td> *sling.filter.scope* </td><td> *String*, {{String[](.html)
+}} or *Vector<String>* </td><td> *request* </td><td> *REQUEST*, *INCLUDE*,
+*FORWARD*, *ERROR*, *COMPONENT* </td><td> Indication of which chain the
+filter should be added to. This property is required. If it is missing from
+the service, the service is ignored because it is assumed another consumer
+will be interested in using the service. Any unknown values of this
+property are also ignored causing the service to be completely ignored if
+none of the values provided by the property are valid. See below for the
+description of the filter chains. </td></tr>
+<tr><td> *service.ranking* </td><td> *Integer* </td><td> *0* </td><td> Any *Integer* value </td><td>
+Indication of where to place the filter in the filter chain. The higher the
+number the earlier in the filter chain. This value may span the whole range
+of integer values. Two filters with equal *service.ranking* property
+value (explicitly set or default value of zero) will be ordered according
+to their *service.id* service property as described in section 5.2.5,
+Service Properties, of the OSGi Core Specification R 4.2. </td></tr>
+</table>
+<p><a name="Filters-FilterChains"></a></p>
+<h2 id="filter-chains">Filter Chains</h2>
+<p>Sling maintains five filter chains: request level, component level, include
+filters, forward filters and error filters. Except for the component level
+filter these filter chains correspond to the filter <em><dispatcher></em>
+configurations as defined for Servlet API 2.5 web applications (see section
+SRV.6.2.5 Filters and the RequestDispatcher).</p>
+<p>The following table summarizes when each of the filter chains is called and
+what value must be defined in the <em>sling.filter.scope</em> property to have a
+filter added to the respective chain:</p>
+<table>
+<tr><th> *sling.filter.scope* </th><th> Servlet API Correspondence </th><th> Description </th></tr>
+<tr><td> *REQUEST* </td><td> *REQUEST* </td><td> Filters are called once per request hitting
+Sling from the outside. These filters are called after the resource
+addressed by the request URL and the Servlet or script to process the
+request has been resolved before the *COMPONENT* filters (if any) and the
+Servlet or script are called. </td></tr>
+<tr><td> *INCLUDE* </td><td> *INCLUDE* </td><td> Filters are called upon calling the
+*RequestDispatcher.include* method after the included resource and the
+Servlet or script to process the include have been resolved before the
+Servlet or script is called. </td></tr>
+<tr><td> *FORWARD* </td><td> *FORWARD* </td><td> Filters are called upon calling the
+*RequestDispatcher.forward* method after the included resource and the
+Servlet or script to process the include have been resolved before the
+Servlet or script is called. </td></tr>
+<tr><td> *ERROR* </td><td> *ERROR* </td><td> Filters are called upon
+*HttpServletResponse.sendError* or any uncaught *Throwable* before
+resolving the error handler Servlet or script. </td></tr>
+<tr><td> *COMPONENT* </td><td> *REQUEST,INCLUDE,FORWARD* </td><td> The *COMPONENT* scoped
+filters are present for backwards compatibility with earlier Sling Engine
+releases. These filters will be called among the *INCLUDE* and
+*FORWARD* filters upon *RequestDispatcher.include* or
+*RequestDispatcher.forward* as well as before calling the request level
+Servlet or script after the *REQUEST* filters. </td></tr>
+</table>
+
+<p>Note on <em>INCLUDE</em> and <em>FORWARD</em> with respect to JSP tags: These filters
+are also called if the respective including (e.g. <em><jsp:include></em> or
+<em><sling:include></em>) or forwarding (e.g. <em><jsp:forward></em> or
+<em><sling:forward></em>) ultimately calls the <em>RequestDispatcher</em>.</p>
+<p><a name="Filters-FilterProcessing"></a></p>
+<h2 id="filter-processing">Filter Processing</h2>
+<p>Filter processing is part of the Sling request processing, which may be
+sketched as follows:</p>
+<table>
+<tr><td> _Request Level_ </td></tr>
+<tr><td> Authentication </td></tr>
+<tr><td> Resource Resolution </td></tr>
+<tr><td> Servlet/Script Resolution </td></tr>
+<tr><td> Request Level Filter Processing </td></tr>
+<tr><td> _Component Level_ </td></tr>
+</table>
+
+<p>The first step of request processing is the <em>Request Level</em> processing
+which is concerned with resolving the resource, finding the appropriate
+servlet and calling into the request level filter chain. The next step is
+the <em>Component Level</em> processing, calling into the component level filters
+before finally calling the servlet or script:</p>
+<table>
+<tr><td> _Component Level_ </td></tr>
+<tr><td> Component Level Filter Processing </td></tr>
+<tr><td> Call Servlet or Script </td></tr>
+</table>
+
+<p>When a servlet or script is including or forwarding to another resource for
+processing through the <em>RequestDispatcher</em> (or any JSP tag or other
+language feature ultimately using a <em>RequestDispatcher</em>) the following
+<em>Dispatch</em> processing takes place:</p>
+<table>
+<tr><td> _Dispatch_ </td></tr>
+<tr><td> Resolve the resource to dispatch to if not already defined when getting
+the *RequestDispatcher* </td></tr>
+<tr><td> Servlet/Script resolution </td></tr>
+<tr><td> Call include or forward filters depending on the kind of dispatch </td></tr>
+<tr><td> Call Servlet or Script </td></tr>
+</table>
+
+<p>As a consequence, request level filters will be called at most once during
+request processing (they may not be called at all if a filter earlier in
+the filter chain decides to terminate the request) while the component
+level, include, and forward filters may be called multiple times while
+processing a request.</p>
+<p><a name="Filters-Troubleshooting"></a></p>
+<h2 id="troubleshooting">Troubleshooting</h2>
+<p>Apart form the logs which tell you when filters are executed, two Sling
+plugins provide information about filters in the OSGi console.</p>
+<p><a name="Filters-RecentRequestsplugin"></a></p>
+<h3 id="recent-requests-plugin">Recent Requests plugin</h3>
+<p>The request traces provided at <em>/system/console/requests</em> contain
+information about filter execution, as in this example:</p>
+<p><DIV class="code panel" style="border-style: solid;border-width: 1px;"><DIV class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;"><B>Recent Requests plugin info</B></DIV><DIV class="codeContent panelContent">
+ 0 (2010-09-08 15:22:38) TIMER_START{Request Processing}
+ ...
+ 0 (2010-09-08 15:22:38) LOG Method=GET,
+PathInfo=/libs/wcm/core/content/siteadmin.html
+ 3 (2010-09-08 15:22:38) LOG Applying request filters
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+org.apache.sling.bgservlets.impl.BackgroundServletStarterFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+org.apache.sling.portal.container.internal.request.PortalFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+org.apache.sling.rewriter.impl.RewriterFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+com.day.cq.wcm.core.impl.WCMRequestFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+org.apache.sling.i18n.impl.I18NFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+com.day.cq.theme.impl.ThemeResolverFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+com.day.cq.wcm.foundation.forms.impl.FormsHandlingServlet
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+org.apache.sling.engine.impl.debug.RequestProgressTrackerLogFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+com.day.cq.wcm.mobile.core.impl.redirect.RedirectFilter
+ 3 (2010-09-08 15:22:38) LOG RedirectFilter did not redirect
+(MobileUtil.isMobileResource() returns false)
+ 3 (2010-09-08 15:22:38) LOG Applying inner filters
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+com.day.cq.wcm.core.impl.WCMComponentFilter
+ 3 (2010-09-08 15:22:38) LOG Calling filter:
+com.day.cq.wcm.core.impl.WCMDebugFilter
+ 3 (2010-09-08 15:22:38)
+TIMER_START{/libs/cq/ui/components/widget/html.jsp#0}
+ ...
+ 8 (2010-09-08 15:22:38) TIMER_END{8,Request Processing} Request Processing</p>
+<p><a name="Filters-ConfigStatusplugin"></a></p>
+<h3 id="config-status-plugin">Config Status plugin</h3>
+<p>The configuration status page at <em>/system/console/config</em> includes the
+current list of active filters in its <em>Servlet Filters</em> category, as in
+this example:</p>
+<p><DIV class="code panel" style="border-style: solid;border-width: 1px;"><DIV class="codeHeader panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;"><B>Config Status plugin info</B></DIV><DIV class="codeContent panelContent">
+ Current Apache Sling Servlet Filter Configuration</p>
+<div class="codehilite"><pre><span class="n">Request</span> <span class="n">Filters:</span>
+<span class="o">-</span><span class="mi">2147483648</span> <span class="p">:</span> <span class="n">class</span>
+</pre></div>
+
+
+<p>org.apache.sling.bgservlets.impl.BackgroundServletStarterFilter (2547)
+ -3000 : class
+org.apache.sling.portal.container.internal.request.PortalFilter (2562)
+ -2500 : class org.apache.sling.rewriter.impl.RewriterFilter (3365)
+ -2000 : class com.day.cq.wcm.core.impl.WCMRequestFilter (2548)
+ -700 : class org.apache.sling.i18n.impl.I18NFilter (2334)
+ -600 : class com.day.cq.theme.impl.ThemeResolverFilter (2244)
+ -600 : class com.day.cq.wcm.foundation.forms.impl.FormsHandlingServlet
+(2268)
+ 0 : class
+org.apache.sling.engine.impl.debug.RequestProgressTrackerLogFilter (2402)
+ 1000 : class com.day.cq.wcm.mobile.core.impl.redirect.RedirectFilter (3363)</p>
+<div class="codehilite"><pre><span class="n">Error</span> <span class="n">Filters:</span>
+<span class="o">---</span>
+
+<span class="n">Include</span> <span class="n">Filters:</span>
+<span class="o">-</span><span class="mi">200</span> <span class="p">:</span> <span class="n">class</span> <span class="n">com</span><span class="o">.</span><span class="n">day</span><span class="o">.</span><span class="n">cq</span><span class="o">.</span><span class="n">wcm</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">WCMComponentFilter</span> <span class="p">(</span><span class="mi">2583</span><span class="p">)</span>
+<span class="mi">1000</span> <span class="p">:</span> <span class="n">class</span> <span class="n">com</span><span class="o">.</span><span class="n">day</span><span class="o">.</span><span class="n">cq</span><span class="o">.</span><span class="n">wcm</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">WCMDebugFilter</span> <span class="p">(</span><span class="mi">2449</span><span class="p">)</span>
+
+<span class="n">Forward</span> <span class="n">Filters:</span>
+<span class="o">-</span><span class="mi">200</span> <span class="p">:</span> <span class="n">class</span> <span class="n">com</span><span class="o">.</span><span class="n">day</span><span class="o">.</span><span class="n">cq</span><span class="o">.</span><span class="n">wcm</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">WCMComponentFilter</span> <span class="p">(</span><span class="mi">2583</span><span class="p">)</span>
+<span class="mi">1000</span> <span class="p">:</span> <span class="n">class</span> <span class="n">com</span><span class="o">.</span><span class="n">day</span><span class="o">.</span><span class="n">cq</span><span class="o">.</span><span class="n">wcm</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">WCMDebugFilter</span> <span class="p">(</span><span class="mi">2449</span><span class="p">)</span>
+
+<span class="n">Component</span> <span class="n">Filters:</span>
+<span class="o">-</span><span class="mi">200</span> <span class="p">:</span> <span class="n">class</span> <span class="n">com</span><span class="o">.</span><span class="n">day</span><span class="o">.</span><span class="n">cq</span><span class="o">.</span><span class="n">wcm</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">WCMComponentFilter</span> <span class="p">(</span><span class="mi">2583</span><span class="p">)</span>
+<span class="mi">1000</span> <span class="p">:</span> <span class="n">class</span> <span class="n">com</span><span class="o">.</span><span class="n">day</span><span class="o">.</span><span class="n">cq</span><span class="o">.</span><span class="n">wcm</span><span class="o">.</span><span class="n">core</span><span class="o">.</span><span class="n">impl</span><span class="o">.</span><span class="n">WCMDebugFilter</span> <span class="p">(</span><span class="mi">2449</span><span class="p">)</span>
+</pre></div>
+
+
+<p>The first numbers on those lines are the filter priorities, and the last
+number in parentheses is the OSGi service ID.</p>
+<p><a name="Filters-SupportinSlingEngine2.1.0"></a></p>
+<h2 id="support-in-sling-engine-210">Support in Sling Engine 2.1.0</h2>
+<p>Up to and including Sling Engine 2.1.0 support for Servlet Filters has been
+as follows:</p>
+<ul>
+<li>Any <em>javax.servlet.Filter</em> service is accepted as a filter for Sling
+unless the <em>pattern</em> property used by the <a href="http://felix.apache.org/site/apache-felix-http-service.html#ApacheFelixHTTPService-UsingtheWhiteboard">Apache Felix HttpService whiteboard support</a>
+ is set in the service registration properties.</li>
+<li>The <em>filter.scope</em> property is optional and supports the case-sensitive
+values <em>request</em> and <em>component</em>.</li>
+<li>Filter ordering is defined by the <em>filter.order</em> property whose default
+value is <em>Integer.MAX_VALUE</em> where smaller values have higher priority
+over higher values.</li>
+</ul>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.