Author: buildbot
Date: Tue Jun 18 13:12:53 2013
New Revision: 866045
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/the-sling-engine/filters.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jun 18 13:12:53 2013
@@ -1 +1 @@
-1490318
+1494129
Modified:
websites/staging/sling/trunk/content/documentation/the-sling-engine/filters.html
==============================================================================
---
websites/staging/sling/trunk/content/documentation/the-sling-engine/filters.html
(original)
+++
websites/staging/sling/trunk/content/documentation/the-sling-engine/filters.html
Tue Jun 18 13:12:53 2013
@@ -51,8 +51,7 @@
<a href="/sitemap.html">Site Map</a></p>
<p><strong>API Docs</strong> <br />
<a href="/apidocs/sling6/index.html">Sling 6</a> <br />
-<a href="/apidocs/sling5/index.html">Sling 5</a> <br />
-</p>
+<a href="/apidocs/sling5/index.html">Sling 5</a> </p>
<p><strong>Project info</strong> <br />
<a href="/downloads.cgi">Downloads</a> <br />
<a href="http://www.apache.org/licenses/";>License</a> <br />
@@ -62,13 +61,11 @@
<a href="/project-information.html">Project Information</a> <br />
<a href="https://issues.apache.org/jira/browse/SLING";>Issue Tracker</a> <br />
<a href="http://svn.apache.org/viewvc/sling/trunk";>Browse Source
Repository</a> <br />
-<a href="/project-information/security.html">Security</a> <br />
-</p>
+<a href="/project-information/security.html">Security</a> </p>
<p><strong>Sponsorship</strong> <br />
<a href="http://www.apache.org/foundation/thanks.html";>Thanks</a> <br />
<a href="http://www.apache.org/foundation/sponsorship.html";>Become a
Sponsor</a> <br />
-<a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a> <br />
-</p>
+<a href="http://www.apache.org/foundation/buy_stuff.html";>Buy Stuff</a> </p>
<!-- no valid ads for now, we'll reactivate this when needed
<iframe
src="http://www.apache.org/ads/button.html";
@@ -90,7 +87,10 @@
<h1>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
<code>javax.servlet.Filter</code> which of course means that the services
implement this interface.</p>
<div class="note">
-See [SLING-1213](https://issues.apache.org/jira/browse/SLING-1213),
[SLING-1734|https://issues.apache.org/jira/browse/SLING-1734], and [Registering
filters with Sling|http://markmail.org/message/quxhm7d5s6u66crr] for more
details.
+See <a href="https://issues.apache.org/jira/browse/SLING-1213";>SLING-1213</a>,
+<a href="https://issues.apache.org/jira/browse/SLING-1734";>SLING-1734</a>, and
+<a href="http://markmail.org/message/quxhm7d5s6u66crr";>Registering filters
with Sling</a>
+ for more details.
</div>
<p>For Sling to pick up a <code>javax.servlet.Filter</code> service for filter
processing two service registration properties are inspected:</p>
@@ -195,47 +195,46 @@ See [SLING-1213](https://issues.apache.o
<p>Apart form the logs which tell you when filters are executed, two Sling
plugins provide information about filters in the OSGi console.</p>
<h3 id="recent-requests-plugin">Recent Requests plugin</h3>
<p>The request traces provided at <code>/system/console/requests</code>
contain information about filter execution, as in this example:</p>
-<div class="codehilite"><pre><span class="mi">0</span> <span
class="p">(</span><span class="mi">2010</span><span class="o">-</span><span
class="mi">09</span><span class="o">-</span><span class="mi">08</span> <span
class="mi">15</span><span class="p">:</span><span class="mi">22</span><span
class="p">:</span><span class="mi">38</span><span class="p">)</span> <span
class="n">TIMER_START</span><span class="p">{</span><span
class="n">Request</span> <span class="n">Processing</span><span
class="p">}</span>
-<span class="o">...</span>
-<span class="mi">0</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Method</span><span class="o">=</span><span class="n">GET</span><span
class="p">,</span> <span class="n">PathInfo</span><span class="o">=</span><span
class="sr">/some/</span><span class="n">path</span><span
class="o">.</span><span class="n">html</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Applying</span> <span class="n">request</span> <span
class="n">filters</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter:</span> <span
class="n">org</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">sling</span><span class="o">.</span><span
class="n">bgservlets</span><span class="o">.</span><span
class="n">impl</span><span class="o">.</span><span
class="n">BackgroundServletStarterFilter</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter:</span> <span
class="n">org</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">sling</span><span class="o">.</span><span
class="n">portal</span><span class="o">.</span><span
class="n">container</span><span class="o">.</span><span
class="n">internal</span><span class="o">.</span><span
class="n">request</span><span class="o">.</span><span
class="n">PortalFilter</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter:</span> <span
class="n">org</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">sling</span><span class="o">.</span><span
class="n">rewriter</span><span class="o">.</span><span
class="n">impl</span><span class="o">.</span><span
class="n">RewriterFilter</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter:</span> <span
class="n">org</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">sling</span><span class="o">.</span><span
class="n">i18n</span><span class="o">.</span><span class="n">impl</span><span
class="o">.</span><span class="n">I18NFilter</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter:</span> <span
class="n">org</span><span class="o">.</span><span class="n">apache</span><span
class="o">.</span><span class="n">sling</span><span class="o">.</span><span
class="n">engine</span><span class="o">.</span><span class="n">impl</span><span
class="o">.</span><span class="n">debug</span><span class="o">.</span><span
class="n">RequestProgressTrackerLogFilter</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span class="n">LOG</span> <span
class="n">Applying</span> <span class="n">inner</span> <span
class="n">filters</span>
-<span class="mi">3</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span
class="n">TIMER_START</span><span class="p">{</span><span
class="sr">/some/sc</span><span class="n">ript</span><span
class="o">.</span><span class="n">jsp</span><span class="c1">#0}</span>
-<span class="o">...</span>
-<span class="mi">8</span> <span class="p">(</span><span
class="mi">2010</span><span class="o">-</span><span class="mi">09</span><span
class="o">-</span><span class="mi">08</span> <span class="mi">15</span><span
class="p">:</span><span class="mi">22</span><span class="p">:</span><span
class="mi">38</span><span class="p">)</span> <span
class="n">TIMER_END</span><span class="p">{</span><span
class="mi">8</span><span class="p">,</span><span class="n">Request</span> <span
class="n">Processing</span><span class="p">}</span> <span
class="n">Request</span> <span class="n">Processing</span>
+<div class="codehilite"><pre>0 <span class="p">(</span>2010<span
class="o">-</span>09<span class="o">-</span>08 15<span
class="p">:</span>22<span class="p">:</span>38<span class="p">)</span> <span
class="n">TIMER_START</span><span class="p">{</span><span
class="n">Request</span> <span class="n">Processing</span><span
class="p">}</span>
+<span class="p">...</span>
+0 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Method</span><span class="p">=</span><span class="n">GET</span><span
class="p">,</span> <span class="n">PathInfo</span><span class="p">=</span><span
class="o">/</span><span class="n">some</span><span class="o">/</span><span
class="n">path</span><span class="p">.</span><span class="n">html</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Applying</span> <span class="n">request</span> <span
class="n">filters</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter</span><span class="p">:</span>
<span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span
class="n">bgservlets</span><span class="p">.</span><span
class="n">impl</span><span class="p">.</span><span
class="n">BackgroundServletStarterFilter</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter</span><span class="p">:</span>
<span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span
class="n">portal</span><span class="p">.</span><span
class="n">container</span><span class="p">.</span><span
class="n">internal</span><span class="p">.</span><span
class="n">request</span><span class="p">.</span><span
class="n">PortalFilter</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter</span><span class="p">:</span>
<span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span
class="n">rewriter</span><span class="p">.</span><span
class="n">impl</span><span class="p">.</span><span
class="n">RewriterFilter</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter</span><span class="p">:</span>
<span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span class="n">i18n</span><span
class="p">.</span><span class="n">impl</span><span class="p">.</span><span
class="n">I18NFilter</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Calling</span> <span class="n">filter</span><span class="p">:</span>
<span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span
class="n">engine</span><span class="p">.</span><span class="n">impl</span><span
class="p">.</span><span class="n">debug</span><span class="p">.</span><span
class="n">RequestProgressTrackerLogFilter</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span class="n">LOG</span> <span
class="n">Applying</span> <span class="n">inner</span> <span
class="n">filters</span>
+3 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span
class="n">TIMER_START</span><span class="p">{</span><span
class="o">/</span><span class="n">some</span><span class="o">/</span><span
class="n">script</span><span class="p">.</span><span
class="n">jsp</span>#0<span class="p">}</span>
+<span class="p">...</span>
+8 <span class="p">(</span>2010<span class="o">-</span>09<span
class="o">-</span>08 15<span class="p">:</span>22<span
class="p">:</span>38<span class="p">)</span> <span
class="n">TIMER_END</span><span class="p">{</span>8<span
class="p">,</span><span class="n">Request</span> <span
class="n">Processing</span><span class="p">}</span> <span
class="n">Request</span> <span class="n">Processing</span>
</pre></div>
<h3 id="config-status-plugin">Config Status plugin</h3>
<p>The configuration status page at <code>/system/console/config</code>
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> <span class="n">org</span><span
class="o">.</span><span class="n">apache</span><span class="o">.</span><span
class="n">sling</span><span class="o">.</span><span
class="n">bgservlets</span><span class="o">.</span><span
class="n">impl</span><span class="o">.</span><span
class="n">BackgroundServletStarterFilter</span> <span class="p">(</span><span
class="mi">2547</span><span class="p">)</span>
-<span class="o">-</span><span class="mi">3000</span> <span class="p">:</span>
<span class="n">class</span> <span class="n">org</span><span
class="o">.</span><span class="n">apache</span><span class="o">.</span><span
class="n">sling</span><span class="o">.</span><span
class="n">portal</span><span class="o">.</span><span
class="n">container</span><span class="o">.</span><span
class="n">internal</span><span class="o">.</span><span
class="n">request</span><span class="o">.</span><span
class="n">PortalFilter</span> <span class="p">(</span><span
class="mi">2562</span><span class="p">)</span>
-<span class="o">-</span><span class="mi">2500</span> <span class="p">:</span>
<span class="n">class</span> <span class="n">org</span><span
class="o">.</span><span class="n">apache</span><span class="o">.</span><span
class="n">sling</span><span class="o">.</span><span
class="n">rewriter</span><span class="o">.</span><span
class="n">impl</span><span class="o">.</span><span
class="n">RewriterFilter</span> <span class="p">(</span><span
class="mi">3365</span><span class="p">)</span>
-<span class="o">-</span><span class="mi">700</span> <span class="p">:</span>
<span class="n">class</span> <span class="n">org</span><span
class="o">.</span><span class="n">apache</span><span class="o">.</span><span
class="n">sling</span><span class="o">.</span><span class="n">i18n</span><span
class="o">.</span><span class="n">impl</span><span class="o">.</span><span
class="n">I18NFilter</span> <span class="p">(</span><span
class="mi">2334</span><span class="p">)</span>
-<span class="mi">0</span> <span class="p">:</span> <span
class="n">class</span> <span class="n">org</span><span class="o">.</span><span
class="n">apache</span><span class="o">.</span><span
class="n">sling</span><span class="o">.</span><span
class="n">engine</span><span class="o">.</span><span class="n">impl</span><span
class="o">.</span><span class="n">debug</span><span class="o">.</span><span
class="n">RequestProgressTrackerLogFilter</span> <span class="p">(</span><span
class="mi">2402</span><span class="p">)</span>
+<div class="codehilite"><pre><span class="n">Current</span> <span
class="n">Apache</span> <span class="n">Sling</span> <span
class="n">Servlet</span> <span class="n">Filter</span> <span
class="n">Configuration</span>
-<span class="n">Error</span> <span class="n">Filters:</span>
+<span class="n">Request</span> <span class="n">Filters</span><span
class="p">:</span>
+<span class="o">-</span>2147483648 <span class="p">:</span> <span
class="n">class</span> <span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span
class="n">bgservlets</span><span class="p">.</span><span
class="n">impl</span><span class="p">.</span><span
class="n">BackgroundServletStarterFilter</span> <span
class="p">(</span>2547<span class="p">)</span>
+<span class="o">-</span>3000 <span class="p">:</span> <span
class="n">class</span> <span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span
class="n">portal</span><span class="p">.</span><span
class="n">container</span><span class="p">.</span><span
class="n">internal</span><span class="p">.</span><span
class="n">request</span><span class="p">.</span><span
class="n">PortalFilter</span> <span class="p">(</span>2562<span
class="p">)</span>
+<span class="o">-</span>2500 <span class="p">:</span> <span
class="n">class</span> <span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span
class="n">rewriter</span><span class="p">.</span><span
class="n">impl</span><span class="p">.</span><span
class="n">RewriterFilter</span> <span class="p">(</span>3365<span
class="p">)</span>
+<span class="o">-</span>700 <span class="p">:</span> <span
class="n">class</span> <span class="n">org</span><span class="p">.</span><span
class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span class="n">i18n</span><span
class="p">.</span><span class="n">impl</span><span class="p">.</span><span
class="n">I18NFilter</span> <span class="p">(</span>2334<span class="p">)</span>
+0 <span class="p">:</span> <span class="n">class</span> <span
class="n">org</span><span class="p">.</span><span class="n">apache</span><span
class="p">.</span><span class="n">sling</span><span class="p">.</span><span
class="n">engine</span><span class="p">.</span><span class="n">impl</span><span
class="p">.</span><span class="n">debug</span><span class="p">.</span><span
class="n">RequestProgressTrackerLogFilter</span> <span
class="p">(</span>2402<span class="p">)</span>
+
+<span class="n">Error</span> <span class="n">Filters</span><span
class="p">:</span>
<span class="o">---</span>
-<span class="n">Include</span> <span class="n">Filters:</span>
+<span class="n">Include</span> <span class="n">Filters</span><span
class="p">:</span>
-<span class="n">Forward</span> <span class="n">Filters:</span>
-<span class="mi">1000</span> <span class="p">:</span> <span
class="n">class</span> <span class="n">some</span><span class="o">.</span><span
class="nb">package</span><span class="o">.</span><span
class="n">DebugFilter</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="p">:</span>
+1000 <span class="p">:</span> <span class="n">class</span> <span
class="n">some</span><span class="p">.</span><span
class="n">package</span><span class="p">.</span><span
class="n">DebugFilter</span> <span class="p">(</span>2449<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">some</span><span
class="o">.</span><span class="nb">package</span><span class="o">.</span><span
class="n">SomeComponentFilter</span> <span class="p">(</span><span
class="mi">2583</span><span class="p">)</span>
+<span class="n">Component</span> <span class="n">Filters</span><span
class="p">:</span>
+<span class="o">-</span>200 <span class="p">:</span> <span
class="n">class</span> <span class="n">some</span><span class="p">.</span><span
class="n">package</span><span class="p">.</span><span
class="n">SomeComponentFilter</span> <span class="p">(</span>2583<span
class="p">)</span>
</pre></div>
-<p></DIV></p>
<p>The first numbers on those lines are the filter priorities, and the last
number in parentheses is the OSGi service ID.</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>
@@ -245,7 +244,7 @@ See [SLING-1213](https://issues.apache.o
<li>Filter ordering is defined by the <code>filter.order</code> property whose
default value is <code>Integer.MAX_VALUE</code> where smaller values have
higher priority over higher values.</li>
</ul>
<div class="timestamp" style="margin-top: 30px; font-size: 80%;
text-align: right;">
- Rev. 1475804 by dklco on Thu, 25 Apr 2013 14:45:50 +0000
+ Rev. 1494129 by fmeschbe on Tue, 18 Jun 2013 13:12:44 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache
Sling project
