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 2014/10/13 10:19:51 UTC
svn commit: r925570 - in /websites/staging/sling/trunk/content: ./
documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html
Author: buildbot
Date: Mon Oct 13 08:19:51 2014
New Revision: 925570
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Oct 13 08:19:51 2014
@@ -1 +1 @@
-1631127
+1631311
Modified: websites/staging/sling/trunk/content/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html (original)
+++ websites/staging/sling/trunk/content/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html Mon Oct 13 08:19:51 2014
@@ -98,16 +98,19 @@
<p>The first component in the pipeline generating the initial SAX events is called a generator. The generator gets the output from Sling, generates SAX events (XML), and streams these events into the pipeline. The counterpart of the generator is the serializer which builds the end of the pipeline. The serializer collects all incomming SAX events, transforms them into the required response by writing into output stream of the response.</p>
<p>Between the generator and the serializer so called transformers can be placed in a chain. A transformer receives SAX events from the previous component in the pipeline and sends SAX events to the next component in the pipeline. A transformer can remove events, change events, add events or just pass on the events.</p>
<p>Sling contains a default pipeline which is executed for all html responses: it starts with an html generator, parsing the html output and sending events into the pipeline. A html serializer collects all events and serializes the output. </p>
-<p>The pipelines can be configured in the repository as a child node of <em>/apps/APPNAME/config/rewriter</em> (or <em>/libs/APPNAME/config/rewriter</em>). (In fact the configured search paths of the resource resolver are observed.) Each node can have the following properties:
-<em> generatorType - the type of the generator (required)
-</em> transformerTypes (multi value string) - the types of the transformers (optional)
-<em> serializerType - the type of the serializer (required)
-</em> paths (multi value string) - the paths this pipeline should run on (content paths)
-<em> contentTypes (multi value string) - the content types this pipeline should be used for (optional)
-</em> extensions (multi value string) - the extensions this pipeline should be used for (optional)
-<em> resourceTypes (multi value string) - the resource types this pipeline should be used for (optional)
-</em> order (long) - the configurations are sorted by this order, order must be higher or equal to 0. The configuration with the highest order is tried first.
-* enabled (boolean) - Is this configuration active? (default yes)</p>
+<p>The pipelines can be configured in the repository as a child node of <em>/apps/APPNAME/config/rewriter</em> (or <em>/libs/APPNAME/config/rewriter</em>). (In fact the configured search paths of the resource resolver are observed.) Each node can have the following properties:</p>
+<ul>
+<li>generatorType - the type of the generator (required)</li>
+<li>transformerTypes (multi value string) - the types of the transformers (optional)</li>
+<li>serializerType - the type of the serializer (required)</li>
+<li>paths (multi value string) - the paths this pipeline should run on (content paths)</li>
+<li>contentTypes (multi value string) - the content types this pipeline should be used for (optional)</li>
+<li>extensions (multi value string) - the extensions this pipeline should be used for (optional)</li>
+<li>resourceTypes (multi value string) - the resource types this pipeline should be used for (optional)</li>
+<li>selectors (multi value string) - a set of selectors the processor should be used for (optional, since 1.0.6)</li>
+<li>order (long) - the configurations are sorted by this order, order must be higher or equal to 0. The configuration with the highest order is tried first.</li>
+<li>enabled (boolean) - Is this configuration active? (default yes)</li>
+</ul>
<p>As you can see from the configuration there are several possibilities to define when a pipeline should be used for a response, like paths, extensions, content types, or resource types. It is possible to specify several of them at once. In this case all conditions must be met.</p>
<p>If a component needs a configuration, the configuration is stored in a child node which name is <em>{componentType}-{name}</em>, e.g. to configure the html generator (named <em>html-generator</em>), the node should have the name <em>generator-html-generator</em>. In the case that the pipeline contains the same transformer several times, the configuration child node should have the formant <em>{componentType}-{index}</em> where index is the index of the transformer starting with 1. For example if you have a pipeline with the following transformers, xslt, html-cleaner, xslt, link-checker, then the configuration nodes should be named <em>transformer-1</em> (for the first xslt), <em>transformer-html-cleaner</em>, <em>transformer-3</em> (for the second xslt), and <em>transformer-link-checker</em>.</p>
<h3 id="default-pipeline">Default Pipeline</h3>
@@ -145,16 +148,19 @@ The <em>getWriter</em> method should ret
<h2 id="configuring-a-processor">Configuring a Processor</h2>
-<p>The processors can be configured in the repository as a child node of <em>/apps/APPNAME/config/rewriter</em> (or libs or any configured search path). Each node can have the following properties:
-<em> processorType - the type of the processor (required) - this is the part from the scr factory information after the slash (in the example above this is </em>uniqueName<em>)
-</em> paths (multi value string) - the paths this processor should run on (content paths)
-<em> contentTypes (multi value string) - the content types this processor should be used for (optional)
-</em> extensions (multi value string) - the extensions this pipeline should be used for (optional)
-<em> resourceTypes (multi value string) - the resource types this pipeline should be used for (optional)
-</em> order (long) - the configurations are sorted by this order, order must be higher or equal to 0. The configuration with the highest order is tried first.
-* enabled (boolean) - Is this configuration active? (default yes)</p>
+<p>The processors can be configured in the repository as a child node of <em>/apps/APPNAME/config/rewriter</em> (or libs or any configured search path). Each node can have the following properties:</p>
+<ul>
+<li>processorType - the type of the processor (required) - this is the part from the scr factory information after the slash (in the example above this is <em>uniqueName</em>)</li>
+<li>paths (multi value string) - the paths this processor should run on (content paths)</li>
+<li>contentTypes (multi value string) - the content types this processor should be used for (optional)</li>
+<li>extensions (multi value string) - the extensions this pipeline should be used for (optional)</li>
+<li>resourceTypes (multi value string) - the resource types this pipeline should be used for (optional)</li>
+<li>selectors (multi value string) - a set of selectors the processor should be used for (optional, since 1.0.6)</li>
+<li>order (long) - the configurations are sorted by this order, order must be higher or equal to 0. The configuration with the highest order is tried first.</li>
+<li>enabled (boolean) - Is this configuration active? (default yes)</li>
+</ul>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1341376 by fmeschbe on Tue, 22 May 2012 09:41:06 +0000
+ Rev. 1631311 by sseifert on Mon, 13 Oct 2014 08:19:31 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project