http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/models.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/models.html b/documentation/bundles/models.html index 5f4a2eb..d712dea 100644 --- a/documentation/bundles/models.html +++ b/documentation/bundles/models.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Models - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/models.html" class="label">models</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <p>Many Sling projects want to be able to create model objects - POJOs which are automatically mapped from Sling objects, typically resources, but also request objects. Sometimes these POJOs need OSGi services as well.</p> <h1><a href="#design-goals" name="design-goals">Design Goals</a></h1>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/nosql-resource-providers.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/nosql-resource-providers.html b/documentation/bundles/nosql-resource-providers.html index d9d2420..42e6299 100644 --- a/documentation/bundles/nosql-resource-providers.html +++ b/documentation/bundles/nosql-resource-providers.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> NoSQL Resource Providers (org.apache.sling.nosql) - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/resourceproviders.html" class="label">resourceproviders</a> <a href="/tags/nosql.html" class="label">nosql</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <h2><a href="#introduction" name="introduction">Introduction</a></h2> <p>Apache Sling provides resource-based access to NoSQL document stores like MongoDB and Couchbase via its Resource API using the NoSQL resource providers. This is possible in combination with a JCR-based repository (e.g. only on a special path in the resource tree), or a only persistence for the whole resource tree depending on the resource provider configuration.</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/org-apache-sling-junit-bundles.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/org-apache-sling-junit-bundles.html b/documentation/bundles/org-apache-sling-junit-bundles.html index 34f23f7..4d21020 100644 --- a/documentation/bundles/org-apache-sling-junit-bundles.html +++ b/documentation/bundles/org-apache-sling-junit-bundles.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> JUnit server-side testing support bundles - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>This is an overview of the Sling bundles that provide support for server-side JUnit tests. </p> + </h1><div class="tags"><a href="/tags/testing.html" class="label">testing</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>This is an overview of the Sling bundles that provide support for server-side JUnit tests. </p> <p>The Maven modules below <a href="https://svn.apache.org/repos/asf/sling/trunk/testing/samples";><code>testing/samples</code></a> provide different examples including HTTP-based and server-side teleported tests in a bundle module, running against a full Sling instance setup in the same Maven module.</p> <h2><a href="#org-apache-sling-junit-core-server-side-junit-tests-support" name="org-apache-sling-junit-core-server-side-junit-tests-support">org.apache.sling.junit.core: server-side JUnit tests support</a></h2> <p>This bundle provides a <code>JUnitServlet</code> that runs JUnit tests found in bundles. </p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/osgi-installer.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/osgi-installer.html b/documentation/bundles/osgi-installer.html index ae454f9..5f1fec6 100644 --- a/documentation/bundles/osgi-installer.html +++ b/documentation/bundles/osgi-installer.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> OSGi Installer - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h1><a href="#overview" name="overview">Overview</a></h1> + </h1><div class="tags"><a href="/tags/installer.html" class="label">installer</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h1><a href="#overview" name="overview">Overview</a></h1> <p>The OSGi installer is a central service for handling installs, updates and uninstall of "artifacts". By default, the installer supports bundles and has an extension for handling configurations for the OSGi configuration admin.</p> <p><img src="/documentation/bundles/Slide14.jpg" alt="Apache Sling OSGI Installer Diagram" /></p> <p>The OSGi installer itself is "just" the central service managing the tasks and states of the artifacts. The artifacts can be provided through various providers, e.g. through a file system provider reading artifacts from configured directories or the jcr provider reading artifacts from a JCR repository.</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html b/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html index ba74b26..10228e5 100644 --- a/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html +++ b/documentation/bundles/output-rewriting-pipelines-org-apache-sling-rewriter.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Output Rewriting Pipelines (org.apache.sling.rewriter) - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Apache Sling Rewriter is a module for rewriting the output generated by a usual Sling rendering process. Some possible use cases include rewriting or checking all links in an HTML page, manipulating the HTML page, or using the generated output as the base for further transformation. An example of further transformation is to use XSLT to transform rendered XML to some output format like HTML or XSL:FO for generating PDF.</p> + </h1><div class="tags"><a href="/tags/publishing.html" class="label">publishing</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Apache Sling Rewriter is a module for rewriting the output generated by a usual Sling rendering process. Some possible use cases include rewriting or checking all links in an HTML page, manipulating the HTML page, or using the generated output as the base for further transformation. An example of further transformation is to use XSLT to transform rendered XML to some output format like HTML or XSL:FO for generating PDF.</p> <p>For supporting these use cases, the rewriter uses the concept for a processor. The processor is a component that is injected through a servlet filter into the response. By implementing the <em>Processor</em> interface one is able to rewrite the whole response in one go. A more convenient way of processing the output is by using a so called pipeline; the Apache Sling rewriter basically uses the same concept as the famous Apache Cocoon: an XML based pipeline for further post processing of the output. The pipeline is based on SAX events.</p> <h2><a href="#sax-pipelines" name="sax-pipelines">SAX Pipelines</a></h2> <p>The rewriter allows to configure a pipeline for post processing of the generated response. Depending on how the pipeline is assembled the rewriting process might buffer the whole output in order to do proper post processing - for example this is required if an HTML response is "transformed" to XHTML or if XSLT is used to process the response.</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/rendering-content-default-get-servlets.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/rendering-content-default-get-servlets.html b/documentation/bundles/rendering-content-default-get-servlets.html index fa1737b..698b900 100644 --- a/documentation/bundles/rendering-content-default-get-servlets.html +++ b/documentation/bundles/rendering-content-default-get-servlets.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Rendering Content - Default GET Servlets - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/servlets.html" class="label">servlets</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <div class="note"> Not all features of the <b>org.apache.sling.servlets.get</b> bundle are described below - this http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/repository-initialization.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/repository-initialization.html b/documentation/bundles/repository-initialization.html index 176b4a0..b71793d 100644 --- a/documentation/bundles/repository-initialization.html +++ b/documentation/bundles/repository-initialization.html @@ -1,7 +1,7 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";><html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/> - <title>Apache Sling :: </title> + <title>Apache Sling :: Repository Initalization</title> <link rel="icon" href="/res/favicon.ico"/> <link rel="stylesheet" href="/res/css/site.css"/> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/> @@ -71,8 +71,8 @@ </p> </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> - - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The <code>SlingRepositoryInitializer</code> mechanism allows for running code before the <code>SlingRepository</code> service is registered.</p> + Repository Initalization + </h1><div class="tags"><a href="/tags/repoinit.html" class="label">repoinit</a> <a href="/tags/jcr.html" class="label">jcr</a> <a href="/tags/repository.html" class="label">repository</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The <code>SlingRepositoryInitializer</code> mechanism allows for running code before the <code>SlingRepository</code> service is registered.</p> <p>This is useful for initialization and content migration purposes.</p> <p>Please be aware of potential clustering and coordination issues when using this mechanism, if your environment lets several Sling instances access the same content repository you'll need to implement a synchronization mechanism for such operations.</p> <h2><a href="#slingrepositoryinitializer" name="slingrepositoryinitializer">SlingRepositoryInitializer</a></h2> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/request-analysis.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/request-analysis.html b/documentation/bundles/request-analysis.html index 8eaee12..88aec3a 100644 --- a/documentation/bundles/request-analysis.html +++ b/documentation/bundles/request-analysis.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Request Processing Analyzer (reqanalyzer) - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/requests.html" class="label">requests</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <h2><a href="#introduction" name="introduction">Introduction</a></h2> <p>Sling provides a helpful functionality to track progress of requests being processed: The <a href="http://sling.apache.org/apidocs/sling6/org/apache/sling/api/request/RequestProgressTracker.html";>RequestProgressTracker</a> which is available through the <a href="http://sling.apache.org/apidocs/sling6/org/apache/sling/api/SlingHttpServletRequest.html#getRequestProgressTracker%28%29";>SlingHttpServletRequest</a>.</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/resource-access-security.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/resource-access-security.html b/documentation/bundles/resource-access-security.html index ab9d940..3f74792 100644 --- a/documentation/bundles/resource-access-security.html +++ b/documentation/bundles/resource-access-security.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Resource Access Security - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, W ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p> + </h1><div class="tags"><a href="/tags/security.html" class="label">security</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writin g, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p> <h2><a href="#summary" name="summary">Summary</a></h2> <p>The ResourceAccessSecurity service allows it to restrict access to resources. The access can be granted or denied for read, create, update and delete actions.</p> <p>The ResourceAccessSecurity defines a service API which is used in two different context: for securing resource providers which have no own access control and on the application level to further restrict the access to resources in general. </p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/resource-editor.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/resource-editor.html b/documentation/bundles/resource-editor.html index 37c81d9..85faa39 100644 --- a/documentation/bundles/resource-editor.html +++ b/documentation/bundles/resource-editor.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> The Apache Sling Resource Editor - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, W ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p> + </h1><div class="tags"><a href="/tags/editors.html" class="label">editors</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at . http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p> <p><img src="http://sling.apache.org/documentation/bundles/resource-editor-screenshot.png"; alt="alt text" /></p> <h1><a href="#features" name="features">Features</a></h1> <p>Currently it allows to display the node properties and edit nodes.</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/resource-merger.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/resource-merger.html b/documentation/bundles/resource-merger.html index 44e2554..9f5d2da 100644 --- a/documentation/bundles/resource-merger.html +++ b/documentation/bundles/resource-merger.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Resource Merger (org.apache.sling.resourcemerger) - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/resources.html" class="label">resources</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <h1><a href="#introduction" name="introduction">Introduction</a></h1> <p><strong>This documentation only applies to versions >= 1.2 (due to major changes done in <a href="https://issues.apache.org/jira/browse/SLING-3423";>SLING-3423</a>)</strong></p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/scheduler-service-commons-scheduler.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/scheduler-service-commons-scheduler.html b/documentation/bundles/scheduler-service-commons-scheduler.html index b2bf473..654d242 100644 --- a/documentation/bundles/scheduler-service-commons-scheduler.html +++ b/documentation/bundles/scheduler-service-commons-scheduler.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Scheduler Service (commons scheduler) - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The scheduler is a service for scheduling other services/jobs (it uses the open source Quartz library). The scheduler can be used in two ways, by registering the job through the scheduler API and by leveraging the whiteboard pattern that is supported by the scheduler. In most cases the whiteboard pattern is preferred</p> + </h1><div class="tags"><a href="/tags/scheduling.html" class="label">scheduling</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The scheduler is a service for scheduling other services/jobs (it uses the open source Quartz library). The scheduler can be used in two ways, by registering the job through the scheduler API and by leveraging the whiteboard pattern that is supported by the scheduler. In most cases the whiteboard pattern is preferred</p> <div class="note"> The notion of Job used in this context is a different one than the one used for <a href="/documentation/bundles/apache-sling-eventing-and-job-handling.html">Sling Jobs</a>. The main difference is that a scheduler's job is not persisted. </div> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/scripting.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/scripting.html b/documentation/bundles/scripting.html index f77c09c..cacae15 100644 --- a/documentation/bundles/scripting.html +++ b/documentation/bundles/scripting.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Scripting - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/scripts.html" class="label">scripts</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <p>Sling Scripting allows the easy development and usage of different scripting (aka templating) engines.</p> <h1><a href="#sling-scripting-engines" name="sling-scripting-engines">Sling Scripting Engines</a></h1> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/scripting/scripting-htl.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/scripting/scripting-htl.html b/documentation/bundles/scripting/scripting-htl.html index dc01c22..2076480 100644 --- a/documentation/bundles/scripting/scripting-htl.html +++ b/documentation/bundles/scripting/scripting-htl.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/scripting.html">Sling Scripting</a> » </div> <h1 class="pagetitle"> HTL Scripting Engine - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Apache Sling HTL Scripting Engine, <a href="https://issues.apache.org/jira/browse/SLING-6028";>formerly known as Sightly</a>, is the reference implementation of the <a href="https://github.com/Adobe-Marketing-Cloud/htl-spec";>HTML Template Language</a>.</p> + </h1><div class="tags"><a href="/tags/scripts.html" class="label">scripts</a> <a href="/tags/htl.html" class="label">htl</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Apache Sling HTL Scripting Engine, <a href="https://issues.apache.org/jira/browse/SLING-6028";>formerly known as Sightly</a>, is the reference implementation of the <a href="https://github.com/Adobe-Marketing-Cloud/htl-spec";>HTML Template Language</a>.</p> <p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <h1><a href="#modules" name="modules">Modules</a></h1> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/scripting/scripting-jsp.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/scripting/scripting-jsp.html b/documentation/bundles/scripting/scripting-jsp.html index e26fcf4..718e86d 100644 --- a/documentation/bundles/scripting/scripting-jsp.html +++ b/documentation/bundles/scripting/scripting-jsp.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/scripting.html">Sling Scripting</a> » </div> <h1 class="pagetitle"> JSP Scripting Engine - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Apache Sling JSP Scripting Engine is implemented by the <a href="https://github.com/apache/sling/tree/trunk/bundles/scripting/jsp";><code>org.apache.sling.scripting.jsp</code></a> bundle, based on the Jasper 2 JSP engine.</p> + </h1><div class="tags"><a href="/tags/scripts.html" class="label">scripts</a> <a href="/tags/jsp.html" class="label">jsp</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Apache Sling JSP Scripting Engine is implemented by the <a href="https://github.com/apache/sling/tree/trunk/bundles/scripting/jsp";><code>org.apache.sling.scripting.jsp</code></a> bundle, based on the Jasper 2 JSP engine.</p> <p>On top of that Apache Sling also provides its own JSP Taglib, implemented by the <a href="https://github.com/apache/sling/tree/trunk/bundles/scripting/jsp-taglib";><code>org.apache.sling.scripting.jsp.taglib</code></a> bundle.</p> <p>The Sling Scripting JSP Taglib supports the use of Sling as an application in JSP pages. The Sling Taglib provides the ability to invoke JSP scripts, include Resources and interact with the Sling Repository, all with JSP tags and <a href="http://docs.oracle.com/javaee/6/tutorial/doc/gjddd.html";>Expression Language (EL)</a> functions.</p> <h2><a href="#use" name="use">Use</a></h2> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/scripting/scripting-thymeleaf.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/scripting/scripting-thymeleaf.html b/documentation/bundles/scripting/scripting-thymeleaf.html index 7f37928..8714cbb 100644 --- a/documentation/bundles/scripting/scripting-thymeleaf.html +++ b/documentation/bundles/scripting/scripting-thymeleaf.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/scripting.html">Sling Scripting</a> » </div> <h1 class="pagetitle"> Sling Scripting Thymeleaf - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Sling Scripting Thymeleaf is the scripting engine for <a href="http://www.thymeleaf.org";><em>Thymeleaf</em></a> (3.0) templates.</p> + </h1><div class="tags"><a href="/tags/scripts.html" class="label">scripts</a> <a href="/tags/thymeleaf.html" class="label">thymeleaf</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Sling Scripting Thymeleaf is the scripting engine for <a href="http://www.thymeleaf.org";><em>Thymeleaf</em></a> (3.0) templates.</p> <p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <h1><a href="#features" name="features">Features</a></h1> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/servlet-helpers.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/servlet-helpers.html b/documentation/bundles/servlet-helpers.html index e47eee4..148ade8 100644 --- a/documentation/bundles/servlet-helpers.html +++ b/documentation/bundles/servlet-helpers.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Servlet Helpers - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Sling Servlet Helpers bundle provides mock implementations of the <code>SlingHttpServletRequest</code>, <code>SlingHttpServletResponse</code> and related classes.</p> + </h1><div class="tags"><a href="/tags/servlets.html" class="label">servlets</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The Sling Servlet Helpers bundle provides mock implementations of the <code>SlingHttpServletRequest</code>, <code>SlingHttpServletResponse</code> and related classes.</p> <p>Those mock implementations are meant to be used in tests and also with services like the <code>SlingRequestProcessor</code> when making requests to that service outside of an HTTP request processing context.</p> <p>See the <a href="https://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/servlet-helpers";>automated tests</a> of the <code>servlet-helpers</code> module for more info.</p> <h2><a href="#usage" name="usage">Usage</a></h2> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-health-check-tool.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-health-check-tool.html b/documentation/bundles/sling-health-check-tool.html index 5f9b0cc..5af9592 100644 --- a/documentation/bundles/sling-health-check-tool.html +++ b/documentation/bundles/sling-health-check-tool.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Health Check Tools - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Based on simple <code>HealthCheck</code> OSGi services, the Sling Health Check Tools ("hc" in short form) are used to check the health of live Sling systems, based on inputs like JMX MBean attribute values, OSGi framework information, Sling requests status, etc.</p> + </h1><div class="tags"><a href="/tags/healthchecks.html" class="label">healthchecks</a> <a href="/tags/operations.html" class="label">operations</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Based on simple <code>HealthCheck</code> OSGi services, the Sling Health Check Tools ("hc" in short form) are used to check the health of live Sling systems, based on inputs like JMX MBean attribute values, OSGi framework information, Sling requests status, etc.</p> <p>Health checks are easily extensible either by configuring the supplied default <code>HealthCheck</code> services, or by implementing your own <code>HealthCheck</code> services to cater for project specific requirements.</p> <p>However for simple setups, the out of the box health checks are often sufficient. <a href="#executing-health-checks">Executing Health Checks</a> is a good starting point to run existing checks and to get familiar with how health checks work.</p> <p>See also:</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-oak-restrictions.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-oak-restrictions.html b/documentation/bundles/sling-oak-restrictions.html index 1f23710..5e5635d 100644 --- a/documentation/bundles/sling-oak-restrictions.html +++ b/documentation/bundles/sling-oak-restrictions.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Oak Restrictions - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/oak.html" class="label">oak</a> <a href="/tags/jcr.html" class="label">jcr</a> <a href="/tags/security.html" class="label">security</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <h2><a href="#introduction" name="introduction">Introduction</a></h2> <p>Oak introduced plugability of restrictions as described in <a href="https://jackrabbit.apache.org/oak/docs/security/authorization/restriction.html#Pluggability";>Oak Restriction Management</a>. The bundle sling-oak-restrictions provides additional restrictions that generally make sense for sling applications. Currently sling restrictions for exact resource type match and resource type match including all descendants are supplied.</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-pipes.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-pipes.html b/documentation/bundles/sling-pipes.html index e0cb63d..83bac9a 100644 --- a/documentation/bundles/sling-pipes.html +++ b/documentation/bundles/sling-pipes.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Pipes - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>tool set for doing extract - transform - load operations by chaining proven code bits.</p> + </h1><div class="tags"><a href="/tags/pipes.html" class="label">pipes</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>tool set for doing extract - transform - load operations by chaining proven code bits.</p> <p>often one-shot data transformations need sample code to be written & executed. This tiny tool set intends to provide ability to do such transformations with proven & reusable blocks called pipes, streaming resources from one to the other.</p> <h2><a href="#what-is-a-pipe" name="what-is-a-pipe">What is a pipe</a></h2> <pre><code> getOutputBinding http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query.html b/documentation/bundles/sling-query.html index 4e1829f..61d41ea 100644 --- a/documentation/bundles/sling-query.html +++ b/documentation/bundles/sling-query.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Query - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>SlingQuery is a Sling resource tree traversal tool inspired by the <a href="http://api.jquery.com/category/traversing/tree-traversal/";>jQuery</a> JavaScript API.</p> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>SlingQuery is a Sling resource tree traversal tool inspired by the <a href="http://api.jquery.com/category/traversing/tree-traversal/";>jQuery</a> JavaScript API.</p> <h2><a href="#introduction" name="introduction">Introduction</a></h2> <p>The recommended way to find resources in the Sling repository is using tree-traversal methods, like <code>listChildren()</code> and <code>getParent()</code> rather than JCR queries. The latter are great for listing resources with given properties, but we can't leverage the repository tree structure with such queries. On the other hand, using tree-traversal method is quite verbose. Consider following code that takes an resource and returns its first ancestor, being <code>cq:Page</code>, with given <code>jcr:content/cq:template</code> attribute:</p> <pre><code>Resource resource = ...; http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/basic-ideas.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/basic-ideas.html b/documentation/bundles/sling-query/basic-ideas.html index dbecfe3..9f472f0 100644 --- a/documentation/bundles/sling-query/basic-ideas.html +++ b/documentation/bundles/sling-query/basic-ideas.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Basic Ideas - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3><a href="#collections" name="collections">Collections</a></h3> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3><a href="#collections" name="collections">Collections</a></h3> <p><code>SlingQuery</code> class represents a collection of resources. Basic collection can be created explicitly via a dollar method:</p> <pre><code>$(resource1, resource2, resource3) </code></pre> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/examples.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/examples.html b/documentation/bundles/sling-query/examples.html index 12891b3..d4cf316 100644 --- a/documentation/bundles/sling-query/examples.html +++ b/documentation/bundles/sling-query/examples.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Examples - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Get containing page (like [PageManager#getContainingPage](https://docs.adobe.com/docs/en/aem/6-3/develop/ref/javadoc/com/day/cq/wcm/api/PageManager.html#getContainingPage(org.apache.sling.api.resource.Resource)))</p> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Get containing page (like [PageManager#getContainingPage](https://docs.adobe.com/docs/en/aem/6-3/develop/ref/javadoc/com/day/cq/wcm/api/PageManager.html#getContainingPage(org.apache.sling.api.resource.Resource)))</p> <pre><code>$(resource).closest("cq:Page") </code></pre> <p>Get first ancestor with a given template</p> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/hierarchy-operators.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/hierarchy-operators.html b/documentation/bundles/sling-query/hierarchy-operators.html index 89fb47f..f69bb3d 100644 --- a/documentation/bundles/sling-query/hierarchy-operators.html +++ b/documentation/bundles/sling-query/hierarchy-operators.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Hierarchy operators - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3>Child operator (<code>parent > child</code>)</h3> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3>Child operator (<code>parent > child</code>)</h3> <p>Select all direct child resources specified by <code>child</code> of resources specified by <code>parent</code></p> <pre><code>// find all richtext components placed directly into parsys resources $(resource).find('foundation/components/parsys > foundation/components/richtext') http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/methods.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/methods.html b/documentation/bundles/sling-query/methods.html index 449889e..4a72262 100644 --- a/documentation/bundles/sling-query/methods.html +++ b/documentation/bundles/sling-query/methods.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Method list - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3><a href="#resource-resources-" name="resource-resources-">$(Resource... resources)</a></h3> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3><a href="#resource-resources-" name="resource-resources-">$(Resource... resources)</a></h3> <p>Create a new SlingQuery object, using passed resources as an initial collection. Example:</p> <pre><code>$(resource); // a simple SlingQuery collection containing one resource </code></pre> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/modifiers.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/modifiers.html b/documentation/bundles/sling-query/modifiers.html index 49f8f64..d16cf1e 100644 --- a/documentation/bundles/sling-query/modifiers.html +++ b/documentation/bundles/sling-query/modifiers.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Modifiers - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3><a href="#eq-index-" name="eq-index-">:eq(index)</a></h3> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3><a href="#eq-index-" name="eq-index-">:eq(index)</a></h3> <p>Reduce the set of matched elements to the one at the specified 0-based index. Example:</p> <pre><code>$(...).find("foundation/components/richtext:eq(2)"); // find the third richtext in the subtree </code></pre> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/operators.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/operators.html b/documentation/bundles/sling-query/operators.html index 69d4913..e08428e 100644 --- a/documentation/bundles/sling-query/operators.html +++ b/documentation/bundles/sling-query/operators.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Operators - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3>Contains <code>[name*=value]</code></h3> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h3>Contains <code>[name*=value]</code></h3> <p>Select resources that have property <code>name</code> containing <code>value</code>:</p> <pre><code>// select children pages titled 'foo', 'foo bar', 'bar foo bar', 'foofoofoo', etc. $(resources).children("cq:Page[jcr:content/jcr:title*=foo]") http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/selectors.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/selectors.html b/documentation/bundles/sling-query/selectors.html index d2c8cc1..bf21fc2 100644 --- a/documentation/bundles/sling-query/selectors.html +++ b/documentation/bundles/sling-query/selectors.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Selectors - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Selector string are something between filters and content descriptors. Selector can filter resources by their <a href="#resource-type">type</a>, <a href="#resource-name">name</a>, <a href="#attributes">attributes</a> and <a href="#modifiers">additional modifiers</a>. They can be also <a href="#joining-selectors">chained together</a> to describe more sophisticated hierarchy structure or <a href="#combining-selectors">combined with comma</a>.</p> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Selector string are something between filters and content descriptors. Selector can filter resources by their <a href="#resource-type">type</a>, <a href="#resource-name">name</a>, <a href="#attributes">attributes</a> and <a href="#modifiers">additional modifiers</a>. They can be also <a href="#joining-selectors">chained together</a> to describe more sophisticated hierarchy structure or <a href="#combining-selectors">combined with comma</a>.</p> <h2><a href="#syntax" name="syntax">Syntax</a></h2> <p>Selector consists of four parts:</p> <h3><a href="#resource-type" name="resource-type">Resource type</a></h3> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-query/vs-jcr.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-query/vs-jcr.html b/documentation/bundles/sling-query/vs-jcr.html index 9c387f1..a461844 100644 --- a/documentation/bundles/sling-query/vs-jcr.html +++ b/documentation/bundles/sling-query/vs-jcr.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » <a href="/documentation/bundles/sling-query.html">Sling Query</a> » </div> <h1 class="pagetitle"> Sling Query vs JCR - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Sling Query is not meant to replace JCR queries (XPath, JCR-SQL, JCR-SQL2). It doesn't use indexes and generally in queries traversing large subtrees (like <code>/</code> or <code>/content</code> or <code>/content/mysite/en</code>) it'll be much slower than well written JCR query.</p> + </h1><div class="tags"><a href="/tags/slingquery.html" class="label">slingquery</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>Sling Query is not meant to replace JCR queries (XPath, JCR-SQL, JCR-SQL2). It doesn't use indexes and generally in queries traversing large subtrees (like <code>/</code> or <code>/content</code> or <code>/content/mysite/en</code>) it'll be much slower than well written JCR query.</p> <p>Purpose of the SlingQuery is to provide a convenient way to traverse resource tree. All SlingQuery operations are eventually transformed into a series of <code>listChildren()</code> and <code>getParent()</code> operations [1].</p> <p>As a rule of thumb - if you have a complex Java loop reading resource children or parents and processing them somehow, rewritting it to SlingQuery will be a good choice. If you have a recursive method trying to get some resource ancestor, using SlingQuery will be a good choice. On the other hand, if you have a large resource subtree and want to find all <code>cq:Page</code>s, using SlingQuery is a bad choice.</p> <table> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/sling-settings-org-apache-sling-settings.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/sling-settings-org-apache-sling-settings.html b/documentation/bundles/sling-settings-org-apache-sling-settings.html index 4dae239..0f3ee0c 100644 --- a/documentation/bundles/sling-settings-org-apache-sling-settings.html +++ b/documentation/bundles/sling-settings-org-apache-sling-settings.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Settings and Run Modes (org.apache.sling.settings) - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h1><a href="#overview" name="overview">Overview</a></h1> + </h1><div class="tags"><a href="/tags/configuration.html" class="label">configuration</a> <a href="/tags/runmodes.html" class="label">runmodes</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><h1><a href="#overview" name="overview">Overview</a></h1> <p>The Sling Settings Bundle exposes the <code>SlingSettingsService</code> which allows access to the following information pertinent to a Sling instance:</p> <table> <thead> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/subsystem-installer-factory.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/subsystem-installer-factory.html b/documentation/bundles/subsystem-installer-factory.html index b8206c7..9ea8673 100644 --- a/documentation/bundles/subsystem-installer-factory.html +++ b/documentation/bundles/subsystem-installer-factory.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Subsystems Installer Factory - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The subsystems installer factory provides support for subsystems to the <a href="/documentation/bundles/osgi-installer.html">OSGI installer</a>. The provisioning of artifacts is handled by installer providers like the file installer or the JCR installer.</p> + </h1><div class="tags"><a href="/tags/installer.html" class="label">installer</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p>The subsystems installer factory provides support for subsystems to the <a href="/documentation/bundles/osgi-installer.html">OSGI installer</a>. The provisioning of artifacts is handled by installer providers like the file installer or the JCR installer.</p> <h2><a href="#subsystems" name="subsystems">Subsystems</a></h2> <p>The subsystem file must end with ".esa" and the manifest must at least contain the subsystem symbolic name "Subsystem-SymbolicName" header.</p> <h1><a href="#project-info" name="project-info">Project Info</a></h1> http://git-wip-us.apache.org/repos/asf/sling-site/blob/19197fc5/documentation/bundles/validation.html ---------------------------------------------------------------------- diff --git a/documentation/bundles/validation.html b/documentation/bundles/validation.html index 97b43a1..6022591 100644 --- a/documentation/bundles/validation.html +++ b/documentation/bundles/validation.html @@ -72,7 +72,7 @@ </div> <div class="main"> <div class="breadcrumbs"><a href="/">Home</a> » <a href="/documentation.html">Documentation</a> » <a href="/documentation/bundles.html">Bundles</a> » </div> <h1 class="pagetitle"> Sling Validation - </h1><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> + </h1><div class="tags"><a href="/tags/validation.html" class="label">validation</a> </div><div id="generatedToC"></div><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=pagetitle],h2,h3'}); } );</script><div class="row"><div class="small-12 columns"><section class="wrap"><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> </p> <p>Many Sling projects want to be able to validate both Resources and request parameters. Through the Sling Validation framework this is possible with the help of validation model resources which define validation rules for a certain resourceType.</p> <h1><a href="#prerequisites" name="prerequisites">Prerequisites</a></h1> @@ -135,7 +135,7 @@ <th>Type </th> <th>Description </th> <th>Mandatory </th> - <th>Example</th> + <th>Example Value</th> </tr> </thead> <tbody> @@ -163,9 +163,96 @@ <td>no </td> <td><code>/content/mysite</code></td> </tr> + <tr> + <td><code>properties\<propertyName></code> </td> + <td>Resource </td> + <td>n/a </td> + <td>This resource ensures that the property with the name <code><propertyName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. </td> + <td>no </td> + <td>n/a</td> + </tr> + <tr> + <td><code>properties\<propertyName>\optional</code> </td> + <td>Property </td> + <td><code>Boolean</code> </td> + <td>If <code>true</code> it is not an error if there is no property with the given <code><propertyName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the property must be there. </td> + <td>no </td> + <td><code>false</code></td> + </tr> + <tr> + <td><code>properties\<propertyName>\propertyMultiple</code> </td> + <td>Property </td> + <td><code>Boolean</code> </td> + <td>If <code>true</code> only multivalue properties are allowed with the name <code><propertyName></code> or matching the <code>nameRegex</code>. If not set or <code>false</code>, multi- and single-value properties are accepted. </td> + <td>no </td> + <td><code>false</code></td> + </tr> + <tr> + <td><code>properties\<propertyName>\nameRegex</code> </td> + <td>Property </td> + <td><code>String</code> </td> + <td>If set the <code><propertyName></code> has no longer a meaning. Rather all properties which match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. </td> + <td>no </td> + <td><code>property[0-8]</code></td> + </tr> + <tr> + <td><code>properties\<propertyName>\validators\<validatorId></code> </td> + <td>Resource </td> + <td>n/a </td> + <td>The <code><validatorId></code> must be the id of a validator. The id is given by the OSGi service property <code>validator.id</code> set in the validator. Each validators node might have arbitrarily many child resources (one per validator). </td> + <td>no </td> + <td>n/a</td> + </tr> + <tr> + <td><code>properties\<propertyName>\validators\<validatorId>\validatorArguments</code> </td> + <td>Property </td> + <td><code>String[]</code> </td> + <td>The parametrization for the validator with the id <code><validatorId></code>. Each value must have the pattern <code>key=value</code>. The parametrization differs per validator. </td> + <td>no </td> + <td><code>regex=^[a-z]*$</code></td> + </tr> + <tr> + <td><code>properties\<propertyName>\validators\<validatorId>\severity</code> </td> + <td>Property </td> + <td><code>Integer</code> </td> + <td>The severity which should be set on all emitted validation failures by this validator. </td> + <td>no </td> + <td><code>0</code></td> + </tr> + <tr> + <td><code>children\<resourceName></code> </td> + <td>Resource </td> + <td>n/a </td> + <td>This resource ensures that the resource with the name <code><resourceName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. </td> + <td>no </td> + <td>n/a</td> + </tr> + <tr> + <td><code>children\<resourceName>\nameRegex</code> </td> + <td>Property </td> + <td><code>String</code> </td> + <td>If set the <code><resourceName></code> has no longer a meaning. Rather all resources whose name match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. </td> + <td>no </td> + <td><code>child[1-9]</code></td> + </tr> + <tr> + <td><code>children\<resourceName>\optional</code> </td> + <td>Property </td> + <td><code>Boolean</code> </td> + <td>If <code>true</code> it is not an error if there is no resource with the given <code><resourceName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the resource must be there. </td> + <td>no </td> + <td><code>false</code></td> + </tr> + <tr> + <td><code>children\<resourceName>\properties</code> </td> + <td>Resource </td> + <td>n/a </td> + <td>The properties can be configured on the child level in the same way as on the root level. </td> + <td>no </td> + <td>n/a</td> + </tr> </tbody> </table> -<p><code>properties\<propertyName></code> | Resource | - | This resource ensures that the property with the name <code><propertyName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. | no | <code>false</code> <code>properties\<propertyName>\optional</code> | Property | <code>Boolean</code> | If <code>true</code> it is not an error if there is no property with the given <code><propertyName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the property must be there. | no | <code>false</code> <code>properties\<propertyName>\propertyMultiple</code> | Property | <code>Boolean</code> | If <code>true</code> only multivalue properties are allowed with the name <code><propertyName></code> or matching the <code>nameRegex</code>. If not set or <code>false</code>, multi- and single-value properties are accepted. | no | <code>false</code> <code>properties \<propertyName>\nameRegex</code> | Property | <code>String</code> | If set the <code><propertyName></code> has no longer a meaning. Rather all properties which match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. | no | <code>property[0-8]</code><br/><code>properties\<propertyName>\validators\<validatorId></code> | Resource | - | The <code><validatorId></code> must be the id of a validator. The id is given by the OSGi service property <code>validator.id</code> set in the validator. Each validators node might have arbitrarily many child resources (one per validator). | no | <code>false</code><br/><code>properties\<propertyName>\validators\<validatorId>\validatorArguments</code> | Property | <code>String[]</code> | The parametrization for the validator with the id <code><validatorId></code>. Each value must have the pattern <code>key=value</cod e>. The parametrization differs per validator. | no | <code>regex=^[a-z]*$</code> <code>properties\<propertyName>\validators\<validatorId>\severity</code> | Property | <code>Integer</code> | The severity which should be set on all emitted validation failures by this validator. | no | <code>0</code> <code>children\<resourceName></code> | Resource | - | This resource ensures that the resource with the name <code><resourceName></code> is there. The resource name has no longer a meaning if the property <code>nameRegex</code> is set on this node. | no | <code>child1</code> <code>children\<resourceName>\nameRegex</code> | Property | <code>String</code> | If set the <code><resourceName></code> has no longer a meaning. Rather all resources whose name match the given regular expression are considered. At least one match is required, otherwise the validated resource/valuemap is considered invalid. | no | <code>child[1-9]</code> <code>children\<resourceNa me>\optional</code> | Property | <code>Boolean</code> | If <code>true</code> it is not an error if there is no resource with the given <code><resourceName></code> or none matching the <code>nameRegex</code>. If not set or <code>false</code> the resource must be there. | no | <code>false</code> <code>children\<resourceName>\properties</code> | Resource | - | The properties can be configured on the child level in the same way as on the root level. | no | -</p> <h2><a href="#validation-model-inheritance" name="validation-model-inheritance">Validation Model Inheritance</a></h2> <p>Sling Validation optionally supports the inheritance of Sling Validation Models. This means not only the model for exactly the given resource type is considered, but also the models for all resource super types. To overwrite some property or child from one of the super type models, just define a property/child on the same level and with the same name in a model for a resource type which is more specific. That way the property/child on the super validation model is no longer effective.</p> <h2><a href="#precedence-of-validation-models" name="precedence-of-validation-models">Precedence of Validation Models</a></h2>
![http://sling.apache.org/documentation/bundles/resource-editor-screenshot.png"](http://sling.apache.org/documentation/bundles/resource-editor-screenshot.png"){kind=link}