You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bd...@apache.org on 2017/06/21 07:22:22 UTC
[16/25] sling-site git commit: Testing with /ng/ context path for
temporary https://sling.apache.org/ng/ setup
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/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 644c84f..2603ff9 100644
--- a/documentation/bundles/rendering-content-default-get-servlets.html
+++ b/documentation/bundles/rendering-content-default-get-servlets.html
@@ -2,22 +2,22 @@
<head>
<meta charset="utf-8"/>
<title>Apache Sling on JBake</title>
- <link rel="stylesheet" href="/res/css/site.css"/>
- <link rel="stylesheet" href="/res/css/codehilite.css"/>
+ <link rel="stylesheet" href="/ng/res/css/site.css"/>
+ <link rel="icon" href="/ng/res/favicon.ico"/>
<div class="title">
<div class="logo">
<a href="http://sling.apache.org">
- <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/>
+ <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/>
</a>
</div><div class="header">
<a href="http://www.apache.org">
- <img border="0" alt="Apache" src="/res/logos/apache.png"/>
+ <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/>
</a>
</div>
</div>
</head><body>
<div class="menu">
- <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h
ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.org/">Donate!</a><br/><a href="http://www.apache.org/foun
dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong>
+ <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p
><strong>Project info</strong><br/><a href="/ng/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/ng/contributing.html">Contributing</a><br/><a href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a href="/ng/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.
org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong>
</div> <div class="main">
<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Rendering Content - Default GET Servlets</h1></header><p>[TOC]</p>
<div class="note">
@@ -28,7 +28,7 @@ page needs more work.
<p>Sling provides a number of default GET and HEAD servlets, in the <code>org.apache.sling.servlets.get</code> bundle.</p>
<p>This provides useful functionality out of the box: JSON rendering of content for example, usually does not require custom code.</p>
<p>This page provides an overview of these default servlets.</p>
-<p>Currently, only the <code>DefaultGetServlet</code> has configuration parameters. Those are found at <code>/system/console/configMgr/org.apache.sling.servlets.get.DefaultGetServlet</code> on a standard Sling setup, and should be self-explaining. One common use is to disable some of the default renderings listed below, as they might not be useful or desired on production systems.</p>
+<p>Currently, only the <code>DefaultGetServlet</code> has configuration parameters. Those are found at <code>/system/console/configMgr/org.apache.sling.servlets.get.DefaultGetServlet</code> on a standard Sling setup, and should be self-explaining. One common use is to disable some of the default renderings listed below, as they might not be useful or desired on production systems. </p>
<h1>Default renderings</h1>
<h2>Default JSON rendering</h2>
<p>Adding a .json extension to a request triggers the default Sling GET servlet in JSON mode, unless a more specific servlet or script is provided for the current resource.</p>
@@ -53,7 +53,7 @@ page needs more work.
<p>This is not to be confused with the <code>sling:redirect</code> property used under <code>/etc/map</code>, which is described in <a href="/documentation/the-sling-engine/mappings-for-resource-resolution.html">Mappings for Resource Resolution</a></p>
<h2>SlingInfoServlet</h2>
<p>The <code>SlingInfoServlet</code> provides info on the current JCR session, for requests that map to JCR nodes.</p>
-<p>It is available at <code>/system/sling/info.sessionInfo</code> by default, and supports <code>.json</code> and <code>.txt</code> extensions.</p></section></div></div>
+<p>It is available at <code>/system/sling/info.sessionInfo</code> by default, and supports <code>.json</code> and <code>.txt</code> extensions. </p></section></div></div>
<div class="footer">
<div class="timestamp">
TODO display revision number here
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/repository-initialization.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/repository-initialization.html b/documentation/bundles/repository-initialization.html
index b39ef69..6156d65 100644
--- a/documentation/bundles/repository-initialization.html
+++ b/documentation/bundles/repository-initialization.html
@@ -2,29 +2,32 @@
<head>
<meta charset="utf-8"/>
<title>Apache Sling on JBake</title>
- <link rel="stylesheet" href="/res/css/site.css"/>
- <link rel="stylesheet" href="/res/css/codehilite.css"/>
+ <link rel="stylesheet" href="/ng/res/css/site.css"/>
+ <link rel="icon" href="/ng/res/favicon.ico"/>
<div class="title">
<div class="logo">
<a href="http://sling.apache.org">
- <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/>
+ <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/>
</a>
</div><div class="header">
<a href="http://www.apache.org">
- <img border="0" alt="Apache" src="/res/logos/apache.png"/>
+ <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/>
</a>
</div>
</div>
</head><body>
<div class="menu">
- <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h
ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.org/">Donate!</a><br/><a href="http://www.apache.org/foun
dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong>
+ <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p
><strong>Project info</strong><br/><a href="/ng/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/ng/contributing.html">Contributing</a><br/><a href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a href="/ng/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.
org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong>
</div> <div class="main">
<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1></h1></header><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>SlingRepositoryInitializer</h2>
<p>The <code>SlingRepositoryInitializer</code> is a very simple service interface, available from version 2.4.0 of the <code>org.apache.sling.jcr.api</code> and <code>org.apache.sling.jcr.base</code> bundles.</p>
-<p>public interface SlingRepositoryInitializer { public void processRepository(SlingRepository repo) throws Exception; }</p>
+<pre><code>public interface SlingRepositoryInitializer {
+ public void processRepository(SlingRepository repo) throws Exception;
+}
+</code></pre>
<p>Services that implement this interface are called when setting up the JCR-based <code>SlingRepository</code> service, before registering it as an OSGi service.</p>
<p>They are called in increasing order of their <code>service.ranking</code> service property, which needs to be an <code>Integer</code> as usual.</p>
<p>If any of them throws an Exception, the <code>SlingRepository</code> service is not registered.</p>
@@ -32,39 +35,77 @@
<p>The <code>org.apache.sling.repoinit.parser</code> implements a mini-language meant to create paths, service users and Access Control Lists in a content repository, as well as registering JCR namespaces and node types.</p>
<p>The language grammar is defined (using the JavaCC compiler-compiler, which has no runtime dependencies) in the <code>RepoInitGrammar.jjt</code> file in that module, and the automated tests provide a number of <a href="https://svn.apache.org/repos/asf/sling/trunk/bundles/extensions/repoinit/parser/src/test/resources/testcases">test cases</a> which demonstrate various features.</p>
<p>The companion <code>org.apache.sling.jcr.repoinit</code> module implements those operations on an Oak JCR repository, using a <code>SlingRepositoryInitializer</code> registered by default with a service ranking of 100. It also provides a <code>JcrRepoInitOpsProcessor</code> service to explicitly apply the output of the repoinit parser to a JCR repository.</p>
-<p>Here's a current example from the test cases mentioned above, that uses all language features as of version 1.0.2 of the parser module.</p>
+<p>Here's a current example from the test cases mentioned above, that uses all language features as of version 1.0.2 of the parser module. </p>
<p>The language is self-explaining but please refer to the actual test cases for details that are guaranteed to be up to date, assuming the tests pass.</p>
-<p>create service user user1, u-ser_2 set ACL on /libs,/apps allow jcr:read for user1,u-ser_2</p>
-<p>deny jcr:write for u-ser_2 deny jcr:lockManagement for user1 remove jcr:understand,some:other for u3 end</p>
-<p>create service user bob_the_service</p>
-<p>set ACL on /tmp allow some:otherPrivilege for bob_the_service end</p>
-<h1>Nodetypes inside the path apply to just that path element</h1>
-<p>create path /content/example.com(sling:Folder)</p>
-<h1>A nodetype in front is used as the default for all path elements</h1>
-<p>create path (nt:unstructured) /var</p>
-<p>set ACL for alice, bob,fred</p>
-<h1>remove is currently not supported by the jcr.repoinit module</h1>
-<p>remove * on / allow jcr:read on /content,/var deny jcr:write on /content/example.com deny jcr:all on / nodetypes example:Page end</p>
-<p>set ACL for restrictions_examples deny jcr:modifyProperties on /apps, /content nodetypes sling:Folder, nt:unstructured restriction(rep:itemNames,prop1,prop2) allow jcr:addChildNodes on /apps restriction(rep:ntNames,sling:Folder,nt:unstructured) allow jcr:modifyProperties on /apps restriction(rep:ntNames,sling:Folder,nt:unstructured) restriction(rep:itemNames,prop1,prop2) allow jcr:addChildNodes on /apps,/content restriction(rep:glob,/cat/*,*/cat,*cat/*) end</p>
-<h1>register namespace requires</h1>
-<h1>o.a.s.repoinit.parser 1.0.4</h1>
-<h1>and o.a.s.jcr.repoinit 1.0.2</h1>
-<p>register namespace ( NSprefix ) uri:someURI/v1.42</p>
-<h1>register nodetypes in CND format</h1>
-<h1>(same bundle requirements as register namespaces)</h1>
-<p>#</p>
-<h1>The optional << markers are used when embedding</h1>
-<h1>this in a Sling provisioning model, to avoid syntax errors</h1>
-<p>#</p>
-<h1>The CND instructions are passed as is to the JCR</h1>
-<h1>modules, so the full CND syntax is supported.</h1>
-<p># register nodetypes <<=== << <slingevent='http://sling.apache.org/jcr/event/1.0'> << << [slingevent:Event] > nt:unstructured, nt:hierarchyNode << - slingevent:topic (string) << - slingevent:properties (binary) ===>></p>
-<p>create user demoUser with password {SHA-256} dc460da4ad72c482231e28e688e01f2778a88ce31a08826899d54ef7183998b5</p>
-<p>create service user the-last-one</p>
+<pre><code>create service user user1, u-ser_2
+set ACL on /libs,/apps
+ allow jcr:read for user1,u-ser_2
+
+ deny jcr:write for u-ser_2
+ deny jcr:lockManagement for user1
+ remove jcr:understand,some:other for u3
+end
+
+create service user bob_the_service
+
+set ACL on /tmp
+ allow some:otherPrivilege for bob_the_service
+end
+
+# Nodetypes inside the path apply to just that path element
+create path /content/example.com(sling:Folder)
+
+# A nodetype in front is used as the default for all path elements
+create path (nt:unstructured) /var
+
+set ACL for alice, bob,fred
+ # remove is currently not supported by the jcr.repoinit module
+ remove * on /
+ allow jcr:read on /content,/var
+ deny jcr:write on /content/example.com
+ deny jcr:all on / nodetypes example:Page
+end
+
+set ACL for restrictions_examples
+ deny jcr:modifyProperties on /apps, /content nodetypes sling:Folder, nt:unstructured restriction(rep:itemNames,prop1,prop2)
+ allow jcr:addChildNodes on /apps restriction(rep:ntNames,sling:Folder,nt:unstructured)
+ allow jcr:modifyProperties on /apps restriction(rep:ntNames,sling:Folder,nt:unstructured) restriction(rep:itemNames,prop1,prop2)
+ allow jcr:addChildNodes on /apps,/content restriction(rep:glob,/cat/*,*/cat,*cat/*)
+end
+
+# register namespace requires
+# o.a.s.repoinit.parser 1.0.4
+# and o.a.s.jcr.repoinit 1.0.2
+register namespace ( NSprefix ) uri:someURI/v1.42
+
+# register nodetypes in CND format
+# (same bundle requirements as register namespaces)
+#
+# The optional << markers are used when embedding
+# this in a Sling provisioning model, to avoid syntax errors
+#
+# The CND instructions are passed as is to the JCR
+# modules, so the full CND syntax is supported.
+#
+register nodetypes
+<<===
+<< <slingevent='http://sling.apache.org/jcr/event/1.0'>
+<<
+<< [slingevent:Event] > nt:unstructured, nt:hierarchyNode
+<< - slingevent:topic (string)
+<< - slingevent:properties (binary)
+===>>
+
+create user demoUser with password {SHA-256} dc460da4ad72c482231e28e688e01f2778a88ce31a08826899d54ef7183998b5
+
+create service user the-last-one
+</code></pre>
<h2>Providing repoinit statements from the Sling provisioning model or other URLs</h2>
<p>All bundles required for this feature need to be active before the <code>SlingRepository</code> service starts.</p>
<p>From version 1.0.2 of the <code>org.apache.sling.jcr.repoinit</code> bundle, the <code>o.a.s.jcr.repoinit.RepositoryInitializer</code> component uses an OSGi configuration as shown in this example to define where to read repoinit statements:</p>
-<p>org.apache.sling.jcr.repoinit.impl.RepositoryInitializer references=["model:context:/resources/provisioning/model.txt","model@repoinitTwo:context:/resources/provisioning/model.txt"]</p>
+<pre><code>org.apache.sling.jcr.repoinit.impl.RepositoryInitializer
+ references=["model:context:/resources/provisioning/model.txt","model@repoinitTwo:context:/resources/provisioning/model.txt"]
+</code></pre>
<p>This example defines two <em>references</em> to URLs that supply repoinit statements. Their syntax is described below.</p>
<p>By default the <code>RepositoryInitializer</code> uses the first URL shown in the above example, which points to the provisioning model that's embedded by default in the Sling Launchpad runnable jar.</p>
<p>Note that previous versions of the <code>org.apache.sling.jcr.repoinit</code> bundle used different configuration parameters. From version 1.0.2 on, warnings are logged if those old parameters (_text.url,text.format,model.section.name_) are used.</p>
@@ -72,16 +113,21 @@
<p>The <code>slingstart-maven-plugin</code>, from V1.4.2 on, allows for embedding so-called "additional sections" in the Sling provisioning model by starting their name with a colon.</p>
<p>At runtime this requires the <code>org.apache.sling.provisioning.model</code> bundle, version 1.4.2 or later.</p>
<p>The <code>o.a.s.jcr.repoinit</code> bundle can use this feature to execute <code>repoinit</code> statements provided by Sling provisioning models, as in this provisioning model example fragment:</p>
-<p>[:repoinit] create path /repoinit/provisioningModelTest</p>
-<p>create service user provisioningModelUser</p>
+<pre><code>[:repoinit]
+create path /repoinit/provisioningModelTest
+
+create service user provisioningModelUser
+</code></pre>
<p>To read repoinit statements from such an additional provisioning model section, the <code>RepositoryInitializer</code> configuration shown above uses references like</p>
-<p>model@repoinitTwo:context:/resources/provisioning/model.txt</p>
+<pre><code>model@repoinitTwo:context:/resources/provisioning/model.txt
+</code></pre>
<p>Where <em>model</em> means "use the provisioning model format", <em>repoinitTwo</em> is the name of the additional section to read statements from in the provisioning model (without the leading colon) and <em>context:/resources/...</em> is the URL to use to retrieve the provisioning model.</p>
<p>In this example the URL uses the <em>context</em> scheme defined by the Sling Launchpad, but any scheme can be used provided a suitable URL handler is active.</p>
<p>The section name in that reference is optional and defaults to <em>repoinit</em>. If it's not specified the <code>@</code> should be omitted as well.</p>
<h3>References to URLs providing raw repoinit statements</h3>
<p>Using a <code>RepositoryInitializer</code> reference like in this example, with the <em>raw</em> prefix, means that its content is passed as is to the repoinit parser:</p>
-<p>raw:classpath://some-repoinit-file.txt</p>
+<pre><code>raw:classpath://some-repoinit-file.txt
+</code></pre>
<p>Which points to a <code>classpath:</code> URL to provide the raw repoinit statements in this example, but again any valid URL scheme can be used.</p></section></div></div>
<div class="footer">
<div class="timestamp">
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/request-analysis.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/request-analysis.html b/documentation/bundles/request-analysis.html
index 75287b2..bd65659 100644
--- a/documentation/bundles/request-analysis.html
+++ b/documentation/bundles/request-analysis.html
@@ -2,22 +2,22 @@
<head>
<meta charset="utf-8"/>
<title>Apache Sling on JBake</title>
- <link rel="stylesheet" href="/res/css/site.css"/>
- <link rel="stylesheet" href="/res/css/codehilite.css"/>
+ <link rel="stylesheet" href="/ng/res/css/site.css"/>
+ <link rel="icon" href="/ng/res/favicon.ico"/>
<div class="title">
<div class="logo">
<a href="http://sling.apache.org">
- <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/>
+ <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/>
</a>
</div><div class="header">
<a href="http://www.apache.org">
- <img border="0" alt="Apache" src="/res/logos/apache.png"/>
+ <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/>
</a>
</div>
</div>
</head><body>
<div class="menu">
- <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h
ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.org/">Donate!</a><br/><a href="http://www.apache.org/foun
dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong>
+ <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p
><strong>Project info</strong><br/><a href="/ng/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/ng/contributing.html">Contributing</a><br/><a href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a href="/ng/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.
org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong>
</div> <div class="main">
<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Request Processing Analyzer (reqanalyzer)</h1></header><p>[TOC]</p>
<h2>Introduction</h2>
@@ -44,7 +44,8 @@
<p>The option to launch the Swing-based GUI is only available if the Sling application is not running in headless mode and if the Web Console is accessed on <em>localhost</em>, that is on the same host as the Sling instance is running.</p>
<h2>Analyzing the <code>requesttracker.txt</code> file</h2>
<p>To analyze the <code>requesttracker.txt</code> file the <em>Request Processing Analyzer</em> module can also be used as a standalone Java application. Just start the module using the <code>java</code> command:</p>
-<p>$ java -jar org.apache.sling.reqanalyzer-0.0.1-SNAPSHOT.jar requesttracker.txt</p>
+<pre><code>$ java -jar org.apache.sling.reqanalyzer-0.0.1-SNAPSHOT.jar requesttracker.txt
+</code></pre>
<p>The command supports two command line arguments:</p>
<ol>
<li>The tracker file (required)</li>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/resource-access-security.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/resource-access-security.html b/documentation/bundles/resource-access-security.html
index 076eedf..97135cc 100644
--- a/documentation/bundles/resource-access-security.html
+++ b/documentation/bundles/resource-access-security.html
@@ -2,30 +2,30 @@
<head>
<meta charset="utf-8"/>
<title>Apache Sling on JBake</title>
- <link rel="stylesheet" href="/res/css/site.css"/>
- <link rel="stylesheet" href="/res/css/codehilite.css"/>
+ <link rel="stylesheet" href="/ng/res/css/site.css"/>
+ <link rel="icon" href="/ng/res/favicon.ico"/>
<div class="title">
<div class="logo">
<a href="http://sling.apache.org">
- <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/>
+ <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/>
</a>
</div><div class="header">
<a href="http://www.apache.org">
- <img border="0" alt="Apache" src="/res/logos/apache.png"/>
+ <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/>
</a>
</div>
</div>
</head><body>
<div class="menu">
- <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h
ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.org/">Donate!</a><br/><a href="http://www.apache.org/foun
dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong>
+ <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p
><strong>Project info</strong><br/><a href="/ng/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/ng/contributing.html">Contributing</a><br/><a href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a href="/ng/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.
org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong>
</div> <div class="main">
-<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Resource Access Security</h1></header><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>
+<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Resource Access Security</h1></header><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>
<h2>Summary</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>
-<p>A resource access security service is registered with the service property “context”. Allowed values are “application” and “provider”. If the value is missing or invalid, the service will be ignored.</p>
-<p>In the context of resource providers, this service might be used for implementations of resource providers where the underlying persistence layer does not implement access control. The goal is to make it easy to implement a lightweight access control for such providers. For example, a JCR resource providers should not use the provider context resource access security - in a JCR context, security is fully delegated to the underlying repository, and mixing security models would be a bad idea.</p>
-<p>In the context of the application, this service might be used to add additional or temporary constraints across the whole resource tree.</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>
+<p>A resource access security service is registered with the service property “context”. Allowed values are “application” and “provider”. If the value is missing or invalid, the service will be ignored. </p>
+<p>In the context of resource providers, this service might be used for implementations of resource providers where the underlying persistence layer does not implement access control. The goal is to make it easy to implement a lightweight access control for such providers. For example, a JCR resource providers should not use the provider context resource access security - in a JCR context, security is fully delegated to the underlying repository, and mixing security models would be a bad idea. </p>
+<p>In the context of the application, this service might be used to add additional or temporary constraints across the whole resource tree. </p>
<h2>How to use ResourceAccessSecurity</h2>
<p>To use the ResourceAccessSecurity service you don’t have to implement the interface ResourceAccessSecurity. Simply add the resourceaccesssecurity bundle to your sling instance. This adds an implementation of the ResourceAccessSecurity service for the provider context (“provider”) and also the application context (“application”).</p>
<p>Furthermore the implementation of ResourceAccessSecurity defines a service provider interface named ResourceAccessGate. This is the service interface which you can implement and register to control the access to the resources.</p>
@@ -59,9 +59,25 @@
</table>
<h3>How to implement ResourceAccessGate</h3>
<p>The implementation is straightforward. The easiest way is to extend <code>AllowingResourceAccessGate</code> which is exported by the resourceaccesssecurity bundle and does not deny any access. So if you wan’t restrict access on resources for read operations you have to implement to following two methods:</p>
-<p>::java @Override public boolean hasReadRestrictions(final ResourceResolver resourceResolver) { return true; }</p>
-<p>@Override public GateResult canRead(final Resource resource) { GateResult returnValue = GateResult.CANT_DECIDE; if( whatever-condition ) { returnValue = GateResult.GRANTED; } else { returnValue = GateResult.DENIED; }</p>
-<p>return returnValue; }</p>
+<pre><code>::java
+@Override
+public boolean hasReadRestrictions(final ResourceResolver resourceResolver) {
+ return true;
+}
+
+@Override
+public GateResult canRead(final Resource resource) {
+ GateResult returnValue = GateResult.CANT_DECIDE;
+ if( whatever-condition ) {
+ returnValue = GateResult.GRANTED;
+ }
+ else {
+ returnValue = GateResult.DENIED;
+ }
+
+ return returnValue;
+}
+</code></pre>
<p>And you have to register the ResourceAccessGate with the path where you wan’t to restrict access and the operation property set to “read”. Furthermore you have to decide if the ResourceAccessGate should operate on all resource providers (context=”application”) or only on the resourceproviders flagged with the property useResourceAccessSecurity=true (context=”provider”).</p>
<p>Tip: We do not recommend to mix up application and provider context in the same application. This can lead to confusing configurations in the ResourceAccessGate implementations.</p>
<h3>GateResult</h3>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/resource-editor.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/resource-editor.html b/documentation/bundles/resource-editor.html
index abcaacd..51ccbcf 100644
--- a/documentation/bundles/resource-editor.html
+++ b/documentation/bundles/resource-editor.html
@@ -2,24 +2,24 @@
<head>
<meta charset="utf-8"/>
<title>Apache Sling on JBake</title>
- <link rel="stylesheet" href="/res/css/site.css"/>
- <link rel="stylesheet" href="/res/css/codehilite.css"/>
+ <link rel="stylesheet" href="/ng/res/css/site.css"/>
+ <link rel="icon" href="/ng/res/favicon.ico"/>
<div class="title">
<div class="logo">
<a href="http://sling.apache.org">
- <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/>
+ <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/>
</a>
</div><div class="header">
<a href="http://www.apache.org">
- <img border="0" alt="Apache" src="/res/logos/apache.png"/>
+ <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/>
</a>
</div>
</div>
</head><body>
<div class="menu">
- <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h
ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.org/">Donate!</a><br/><a href="http://www.apache.org/foun
dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong>
+ <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p
><strong>Project info</strong><br/><a href="/ng/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/ng/contributing.html">Contributing</a><br/><a href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a href="/ng/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.
org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong>
</div> <div class="main">
-<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>The Apache Sling Resource Editor</h1></header><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>
+<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>The Apache Sling Resource Editor</h1></header><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>Features</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/3a935d04/documentation/bundles/resource-merger.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/resource-merger.html b/documentation/bundles/resource-merger.html
index 9d50e7b..cd16075 100644
--- a/documentation/bundles/resource-merger.html
+++ b/documentation/bundles/resource-merger.html
@@ -2,22 +2,22 @@
<head>
<meta charset="utf-8"/>
<title>Apache Sling on JBake</title>
- <link rel="stylesheet" href="/res/css/site.css"/>
- <link rel="stylesheet" href="/res/css/codehilite.css"/>
+ <link rel="stylesheet" href="/ng/res/css/site.css"/>
+ <link rel="icon" href="/ng/res/favicon.ico"/>
<div class="title">
<div class="logo">
<a href="http://sling.apache.org">
- <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/>
+ <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/>
</a>
</div><div class="header">
<a href="http://www.apache.org">
- <img border="0" alt="Apache" src="/res/logos/apache.png"/>
+ <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/>
</a>
</div>
</div>
</head><body>
<div class="menu">
- <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h
ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.org/">Donate!</a><br/><a href="http://www.apache.org/foun
dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong>
+ <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p
><strong>Project info</strong><br/><a href="/ng/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/ng/contributing.html">Contributing</a><br/><a href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a href="/ng/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.
org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong>
</div> <div class="main">
<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Resource Merger (org.apache.sling.resourcemerger)</h1></header><p>[TOC]</p>
<h1>Introduction</h1>
@@ -28,14 +28,14 @@
<li><code>CRUDMergingResourceProvider</code> (for reading and writing)</li>
</ul>
<p>Those providers give access to virtual resources which provide a merged view on multiple other resources.</p>
-<p>Each <code>MergedResourcePicker</code> service implementation in the system provides one unique mount point/root path (usually starting with <code>/mnt</code>) exposing a view on merged resources from at least two different locations.</p>
+<p>Each <code>MergedResourcePicker</code> service implementation in the system provides one unique mount point/root path (usually starting with <code>/mnt</code>) exposing a view on merged resources from at least two different locations. </p>
<p>The exact merging mechanism depends on the resource picker implementation (see below). The order of the merging is important as the overlying resource may overwrite properties/child resources from the underlying resource (but not vice-versa). It is possible to</p>
<ul>
<li>remove existing resource/properties from the underlying resources,</li>
<li>modify existing properties/child resources of the underlying resources and</li>
<li>add new properties/child resources</li>
</ul>
-<p>You may use any of the merge properties described below to influence the merging behaviour. All those special properties are not exposed below the mount point.</p>
+<p>You may use any of the merge properties described below to influence the merging behaviour. All those special properties are not exposed below the mount point. </p>
<p>The <code>CRUDMergingResourceProvider</code> not only gives read-access to the merged resources but even allows to write. This provider always writes inside the topmost resource path (being returned as last item by the resource picker). Currently both resource pickers shipped with the Sling Resource Merger bundle do not allow to write though. Further details can be found in the description of <a href="https://issues.apache.org/jira/browse/SLING-3909">SLING-3909</a>.</p>
<h1>Merge Properties</h1>
<table>
@@ -72,9 +72,18 @@
<h1>Child Resource Order</h1>
<p>For a merged resource the order of its child resources is the following: First the ones from the base resource, then the ones from the overlaying resources. The children only defined by the topmost resource come last.</p>
<p>In case the same child is defined in more than one resource, its position is taken from the highest overlaying resource (since version 1.3.2, see also <a href="https://issues.apache.org/jira/browse/SLING-4915">SLING-4915</a>). For example:</p>
-<p>base/ +--child1 +--child2 +--child3</p>
-<p>overlay/ +--child4 +--child2 +--child3</p>
-<p>resulting order: child1, child4, child2, child3</p>
+<pre><code>base/
+ +--child1
+ +--child2
+ +--child3
+
+overlay/
+ +--child4
+ +--child2
+ +--child3
+
+resulting order: child1, child4, child2, child3
+</code></pre>
<p>You can overwrite that behaviour by leveraging the <code>sling:orderBefore</code> property.</p>
<h1>Resource Pickers</h1>
<h2>Merging Resource Picker (Overlay approach)</h2>
@@ -100,9 +109,35 @@
</table>
<p>This picker is thought for globally overlaying content by placing the diff-resource in "/apps" without actually touching anything in "/libs" (since this is only thought for Sling itself). This should be used whenever some deviation of content is desired which is initially shipped with Sling. The client (i.e. the code using the merged resource) does not have to know if there is an overlay in place.</p>
<h3>Example</h3>
-<p>/libs/sling/example (nt:folder) +-- sling:resourceType = "some/resource/type" +-- child1 (nt:folder) | +-- property1 = "property from /libs/sling/example/child1" +-- child2 (nt:folder) | +-- property1 = "property from /libs/sling/example/child2" +-- child3 (nt:folder) | +-- property1 = "property from /libs/sling/example/child3"</p>
-<p>/apps/sling/example (sling:Folder) +-- property1 = "property added in apps" +-- child1 (nt:folder) | +-- sling:hideResource = true +-- child2 (nt:folder) | +-- property1 = "property from /apps/sling/example/child2" +-- child3 (nt:folder) | +-- property2 = "property from /apps/sling/example/child3"</p>
-<p>/mnt/overlay/sling/example (sling:Folder) +-- sling:resourceType = "some/resource/type" +-- property1 = "property added in apps" +-- child2 (nt:folder) | +-- property1 = "property from /apps/sling/example/child2" +-- child3 (nt:folder) | +-- property1 = "property from /libs/sling/example/child3" | +-- property2 = "property from /apps/sling/example/child3"</p>
+<pre><code>/libs/sling/example (nt:folder)
+ +-- sling:resourceType = "some/resource/type"
+ +-- child1 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child1"
+ +-- child2 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child2"
+ +-- child3 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child3"
+
+
+/apps/sling/example (sling:Folder)
+ +-- property1 = "property added in apps"
+ +-- child1 (nt:folder)
+ | +-- sling:hideResource = true
+ +-- child2 (nt:folder)
+ | +-- property1 = "property from /apps/sling/example/child2"
+ +-- child3 (nt:folder)
+ | +-- property2 = "property from /apps/sling/example/child3"
+
+
+/mnt/overlay/sling/example (sling:Folder)
+ +-- sling:resourceType = "some/resource/type"
+ +-- property1 = "property added in apps"
+ +-- child2 (nt:folder)
+ | +-- property1 = "property from /apps/sling/example/child2"
+ +-- child3 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child3"
+ | +-- property2 = "property from /apps/sling/example/child3"
+</code></pre>
<h2>Overriding Resource Picker (Override approach)</h2>
<table>
<thead>
@@ -126,9 +161,35 @@
</table>
<p>This picker is thought for extending content of another already existing resource (which should not be modified). The client (i.e. the code using the merged resource) must directly reference the most specific resource type (i.e. it must be aware of the sub resource type).</p>
<h3>Example</h3>
-<p>/apps/sling/base (nt:folder) +-- child1 (nt:folder) | +-- property1 = "property from /libs/sling/example/child1" +-- child2 (nt:folder) | +-- property1 = "property from /libs/sling/example/child2" +-- child3 (nt:folder) | +-- property1 = "property from /libs/sling/example/child3"</p>
-<p>/apps/sling/example (sling:Folder) +-- sling:resourceSuperType = "/apps/sling/base" +-- property1 = "property added in /apps/sling/example" +-- child1 (nt:folder) | +-- sling:hideResource = true +-- child2 (nt:folder) | +-- property1 = "property from /apps/sling/example/child2" +-- child3 (nt:folder) | +-- property2 = "property from /apps/sling/example/child3"</p>
-<p>/mnt/override/apps/sling/example (sling:Folder) +-- sling:resourceSuperType = "/apps/sling/base" +-- property1 = "property added in /apps/sling/example" +-- child2 (nt:folder) | +-- property1 = "property from /apps/sling/example/child2" +-- child3 (nt:folder) | +-- property1 = "property from /libs/sling/example/child3" | +-- property2 = "property from /apps/sling/example/child3"</p></section></div></div>
+<pre><code>/apps/sling/base (nt:folder)
+ +-- child1 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child1"
+ +-- child2 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child2"
+ +-- child3 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child3"
+
+
+/apps/sling/example (sling:Folder)
+ +-- sling:resourceSuperType = "/apps/sling/base"
+ +-- property1 = "property added in /apps/sling/example"
+ +-- child1 (nt:folder)
+ | +-- sling:hideResource = true
+ +-- child2 (nt:folder)
+ | +-- property1 = "property from /apps/sling/example/child2"
+ +-- child3 (nt:folder)
+ | +-- property2 = "property from /apps/sling/example/child3"
+
+
+/mnt/override/apps/sling/example (sling:Folder)
+ +-- sling:resourceSuperType = "/apps/sling/base"
+ +-- property1 = "property added in /apps/sling/example"
+ +-- child2 (nt:folder)
+ | +-- property1 = "property from /apps/sling/example/child2"
+ +-- child3 (nt:folder)
+ | +-- property1 = "property from /libs/sling/example/child3"
+ | +-- property2 = "property from /apps/sling/example/child3"
+</code></pre></section></div></div>
<div class="footer">
<div class="timestamp">
TODO display revision number here
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/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 b7a4f3c..efd607b 100644
--- a/documentation/bundles/scheduler-service-commons-scheduler.html
+++ b/documentation/bundles/scheduler-service-commons-scheduler.html
@@ -2,22 +2,22 @@
<head>
<meta charset="utf-8"/>
<title>Apache Sling on JBake</title>
- <link rel="stylesheet" href="/res/css/site.css"/>
- <link rel="stylesheet" href="/res/css/codehilite.css"/>
+ <link rel="stylesheet" href="/ng/res/css/site.css"/>
+ <link rel="icon" href="/ng/res/favicon.ico"/>
<div class="title">
<div class="logo">
<a href="http://sling.apache.org">
- <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/>
+ <img border="0" alt="Apache Sling" src="/ng/res/logos/sling.svg"/>
</a>
</div><div class="header">
<a href="http://www.apache.org">
- <img border="0" alt="Apache" src="/res/logos/apache.png"/>
+ <img border="0" alt="Apache" src="/ng/res/logos/apache.png"/>
</a>
</div>
</div>
</head><body>
<div class="menu">
- <strong><a href="/documentation.html">Documentation</a></strong><br/><a href="/documentation/getting-started.html">Getting Started</a><br/><a href="/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/documentation/development.html">Development</a><br/><a href="/documentation/bundles.html">Bundles</a><br/><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/apidocs/sling9/index.html">Sling 9</a><br/><a href="/apidocs/sling8/index.html">Sling 8</a><br/><a href="/apidocs/sling7/index.html">Sling 7</a><br/><a href="/apidocs/sling6/index.html">Sling 6</a><br/><a href="/apidocs/sling5/index.html">Sling 5</a><br/><a href="/javadoc-io.html">Archive at javadoc.io</a><br/><p></p><strong>Project info</strong><br/><a h
ref="/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/contributing.html">Contributing</a><br/><a href="/news.html">News</a><br/><a href="/links.html">Links</a><br/><a href="/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.org/">Donate!</a><br/><a href="http://www.apache.org/foun
dation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/sitemap.html">Site Map</a></strong>
+ <strong><a href="/ng/documentation.html">Documentation</a></strong><br/><a href="/ng/documentation/getting-started.html">Getting Started</a><br/><a href="/ng/documentation/the-sling-engine.html">The Sling Engine</a><br/><a href="/ng/documentation/development.html">Development</a><br/><a href="/ng/documentation/bundles.html">Bundles</a><br/><a href="/ng/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a><br/><a href="/ng/documentation/configuration.html">Configuration</a><p></p><a href="http://s.apache.org/sling.wiki">Wiki</a><br/><a href="http://s.apache.org/sling.faq">FAQ</a><br/><p></p><strong>API Docs</strong><br/><a href="/ng/apidocs/sling9/index.html">Sling 9</a><br/><a href="/ng/apidocs/sling8/index.html">Sling 8</a><br/><a href="/ng/apidocs/sling7/index.html">Sling 7</a><br/><a href="/ng/apidocs/sling6/index.html">Sling 6</a><br/><a href="/ng/apidocs/sling5/index.html">Sling 5</a><br/><a href="/ng/javadoc-io.html">Archive at javadoc.io</a><br/><p></p
><strong>Project info</strong><br/><a href="/ng/downloads.cgi">Downloads</a><br/><a href="http://www.apache.org/licenses/">License</a><br/><a href="/ng/contributing.html">Contributing</a><br/><a href="/ng/news.html">News</a><br/><a href="/ng/links.html">Links</a><br/><a href="/ng/project-information.html">Project Information</a><br/><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a><br/><a href="http://ci.apache.org/builders/sling-trunk">Build Server</a><br/><a href="/ng/project-information/security.html">Security</a><br/><p></p><strong>Source</strong><br/><a href="http://svn.apache.org/viewvc/sling/trunk">Subversion</a><br/><a href="git://git.apache.org/sling.git">Git</a><br/><a href="https://github.com/apache/sling">Github Mirror</a><br/><p></p><strong>Sponsorship</strong><br/><a href="http://www.apache.org/foundation/thanks.html">Thanks</a><br/><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a><br/><a href="https://donate.apache.
org/">Donate!</a><br/><a href="http://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a><br/><p></p><strong><a href="/ng/sitemap.html">Site Map</a></strong>
</div> <div class="main">
<div class="row"><div class="small-12 columns"><section class="wrap"><header><h1>Scheduler Service (commons scheduler)</h1></header><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">
@@ -27,26 +27,63 @@ The notion of Job used in this context is a different one than the one used for
<p>The following examples show you how to define and schedule a job by leveraging the whiteboard pattern.</p>
<h3>Scheduling with a cron expression</h3>
<p>The following job is executed every minute by setting <em>scheduler.expression</em> to the cron expression <em>"0 * * * * ?"</em>:</p>
-<p>package sling.docu.examples;</p>
-<p>import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Service; import org.apache.felix.scr.annotations.Property;</p>
-<p>@Component @Service(value = Runnable.class) @Property( name = "scheduler.expression", value = "0 * * * * ?") public class ScheduledCronJob implements Runnable {</p>
-<p>/** Default log. */ protected final Logger log = LoggerFactory.getLogger(this.getClass());</p>
-<p>public void run() { log.info("Executing a cron job (job#1) through the whiteboard pattern"); } // }</p>
+<pre><code>package sling.docu.examples;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Service;
+import org.apache.felix.scr.annotations.Property;
+
+@Component
+@Service(value = Runnable.class)
+@Property( name = "scheduler.expression", value = "0 * * * * ?")
+public class ScheduledCronJob implements Runnable {
+
+ /** Default log. */
+ protected final Logger log = LoggerFactory.getLogger(this.getClass());
+
+ public void run() {
+ log.info("Executing a cron job (job#1) through the whiteboard pattern");
+ }
+//
+}
+</code></pre>
<h3>Scheduling at periodic times</h3>
<p>The following job is executed every ten seconds by setting <em>scheduler.period</em> to <em>10</em>:</p>
-<p>package sling.docu.examples;</p>
-<p>import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Service; import org.apache.felix.scr.annotations.Property;</p>
-<p>@Component @Service(value = Runnable.class) @Property( name = "scheduler.period", longValue = 10) public class ScheduledPeriodicJob implements Runnable {</p>
-<p>/** Default log. */ protected final Logger log = LoggerFactory.getLogger(this.getClass());</p>
-<p>public void run() { log.info("Executing a perodic job (job#2) through the whiteboard pattern"); } // }</p>
+<pre><code>package sling.docu.examples;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Service;
+import org.apache.felix.scr.annotations.Property;
+
+@Component
+@Service(value = Runnable.class)
+@Property( name = "scheduler.period", longValue = 10)
+public class ScheduledPeriodicJob implements Runnable {
+
+ /** Default log. */
+ protected final Logger log = LoggerFactory.getLogger(this.getClass());
+
+ public void run() {
+ log.info("Executing a perodic job (job#2) through the whiteboard pattern");
+ }
+//
+}
+</code></pre>
<h3>Preventing concurrent execution</h3>
<p>By default, jobs can be concurrently executed. To prevent this, set the <em>scheduler.concurrent</em> property to <em>false</em>:</p>
-<p>@Property(name="scheduler.concurrent", boolValue=false)</p>
+<pre><code>@Property(name="scheduler.concurrent", boolValue=false)
+</code></pre>
<h3>Scheduling the job just once in a cluster</h3>
<p>If the same code/same services is executed on multiple nodes within a cluster, the same job might be scheduled on each instance. If this is not desired, the job can either be bound to the leader of the topology or a single instance (which one this is, is not further defined):</p>
-<p>@Property(name="scheduler.runOn", value="LEADER");</p>
+<pre><code>@Property(name="scheduler.runOn", value="LEADER");
+</code></pre>
<p>or</p>
-<p>@Property(name="scheduler.runOn", value="SINGLE");</p>
+<pre><code>@Property(name="scheduler.runOn", value="SINGLE");
+</code></pre>
<p>Since in contrast to <a href="/documentation/bundles/apache-sling-eventing-and-job-handling.html">Sling Jobs</a> the scheduler queue is only held in memory, there will be no distribution of jobs. So if job '1' was scheduled on instance 'a' with the option to run on the leader only, but the leader is instance 'b', which hasn't the job in the queue, the job will never be executed by any instance!</p>
<h2>The Scheduler API</h2>
<p>The scheduler has methods to execute jobs periodically, based on a cron expression or at a given time. For more details please refer to the <a href="http://sling.apache.org/apidocs/sling6/org/apache/sling/commons/scheduler/Scheduler.html">javadocs</a>.</p>
@@ -54,30 +91,117 @@ The notion of Job used in this context is a different one than the one used for
<p>The following examples show you how to define and schedule a job that is registered through the scheduler api.</p>
<h3>Defining the job</h3>
<p>The following code sample defines a <em>job</em> object that writes a message in the logs:</p>
-<p>final Runnable job = new Runnable() { public void run() { log.info("Executing the job"); } };</p>
+<pre><code>final Runnable job = new Runnable() {
+ public void run() {
+ log.info("Executing the job");
+ }
+};
+</code></pre>
<h3>Scheduling with a cron expression</h3>
<p>To execute the job as defined above at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday, you can use the <em>addJob()</em> method with the following parameters:</p>
-<p>String schedulingExpression = "0 15 10 ? * MON-FRI"; this.scheduler.addJob("myJob", job, null, schedulingExpression, true);</p>
-<p>Refer to http://www.docjar.com/docs/api/org/quartz/CronTrigger.html to define more scheduling expressions.</p>
+<pre><code>String schedulingExpression = "0 15 10 ? * MON-FRI";
+this.scheduler.addJob("myJob", job, null, schedulingExpression, true);
+</code></pre>
+<p>Refer to http://www.docjar.com/docs/api/org/quartz/CronTrigger.html to define more scheduling expressions.</p>
<h3>Scheduling at periodic times</h3>
<p>To execute the job as defined above every 3 minutes (180 seconds), you can use the <em>addPeriodicJob()</em> method with the following parameters:</p>
-<p>long period = 3*60; //the period is expressed in seconds this.scheduler.addPeriodicJob("myJob", job, null, period, true);</p>
+<pre><code>long period = 3*60; //the period is expressed in seconds
+this.scheduler.addPeriodicJob("myJob", job, null, period, true);
+</code></pre>
<h3>Scheduling at a given time</h3>
<p>To execute the job as defined above at a specific date (on January 10th 2020), you can use the <em>fireJobAt()</em> method with the following parameters:</p>
-<p>SimpleDateFormat formatter = new SimpleDateFormat("yyyy/MM/dd"); String date = "2020/01/10"; java.util.Date fireDate = formatter.parse(date); this.scheduler.fireJobAt("myJob", job, null, fireDate);</p>
+<pre><code>SimpleDateFormat formatter = new SimpleDateFormat("yyyy/MM/dd");
+String date = "2020/01/10";
+java.util.Date fireDate = formatter.parse(date);
+this.scheduler.fireJobAt("myJob", job, null, fireDate);
+</code></pre>
<h3>A service scheduling the job based on 3 different kinds of scheduling</h3>
<p>The code implementing a service that simultaneously executes the job based on 3 different kinds of scheduling can look as follows:</p>
-<p>package sling.docu.examples;</p>
-<p>import java.io.Serializable; import java.util.Date; import java.util.HashMap; import java.util.Map;</p>
-<p>import org.apache.sling.commons.scheduler.Scheduler; import org.osgi.service.component.ComponentContext; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.apache.felix.scr.annotations.Component; import org.apache.felix.scr.annotations.Reference;</p>
-<p>/** * This service executes scheduled jobs * */ @Component public class HelloWorldScheduledService {</p>
-<p>/** Default log. */ protected final Logger log = LoggerFactory.getLogger(this.getClass());</p>
-<p>/** The scheduler for rescheduling jobs. */ @Reference private Scheduler scheduler;</p>
-<p>protected void activate(ComponentContext componentContext) throws Exception { //case 1: with addJob() method: executes the job every minute String schedulingExpression = "0 * * * * ?"; String jobName1 = "case1"; Map<String, Serializable> config1 = new HashMap<String, Serializable>(); boolean canRunConcurrently = true; final Runnable job1 = new Runnable() { public void run() { log.info("Executing job1"); } }; try { this.scheduler.addJob(jobName1, job1, config1, schedulingExpression, canRunConcurrently); } catch (Exception e) { job1.run(); }</p>
-<p>//case 2: with addPeriodicJob(): executes the job every 3 minutes String jobName2 = "case2"; long period = 180; Map<String, Serializable> config2 = new HashMap<String, Serializable>(); final Runnable job2 = new Runnable() { public void run() { log.info("Executing job2"); } }; try { this.scheduler.addPeriodicJob(jobName2, job2, config2, period, canRunConcurrently); } catch (Exception e) { job2.run(); }</p>
-<p>//case 3: with fireJobAt(): executes the job at a specific date (date of deployment + delay of 30 seconds) String jobName3 = "case3"; final long delay = 30*1000; final Date fireDate = new Date(); fireDate.setTime(System.currentTimeMillis() + delay); Map<String, Serializable> config3 = new HashMap<String, Serializable>(); final Runnable job3 = new Runnable() { public void run() { log.info("Executing job3 at date: {} with a delay of: {} seconds", fireDate, delay/1000); } }; try { this.scheduler.fireJobAt(jobName3, job3, config3, fireDate); } catch (Exception e) { job3.run(); } }</p>
-<p>protected void deactivate(ComponentContext componentContext) { log.info("Deactivated, goodbye!"); }</p>
-<p>}</p></section></div></div>
+<pre><code>package sling.docu.examples;
+
+import java.io.Serializable;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+
+import org.apache.sling.commons.scheduler.Scheduler;
+import org.osgi.service.component.ComponentContext;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Reference;
+
+/**
+ * This service executes scheduled jobs
+ *
+ */
+@Component
+public class HelloWorldScheduledService {
+
+ /** Default log. */
+ protected final Logger log = LoggerFactory.getLogger(this.getClass());
+
+ /** The scheduler for rescheduling jobs. */
+ @Reference
+ private Scheduler scheduler;
+
+
+ protected void activate(ComponentContext componentContext) throws Exception {
+ //case 1: with addJob() method: executes the job every minute
+ String schedulingExpression = "0 * * * * ?";
+ String jobName1 = "case1";
+ Map<String, Serializable> config1 = new HashMap<String, Serializable>();
+ boolean canRunConcurrently = true;
+ final Runnable job1 = new Runnable() {
+ public void run() {
+ log.info("Executing job1");
+ }
+ };
+ try {
+ this.scheduler.addJob(jobName1, job1, config1, schedulingExpression, canRunConcurrently);
+ } catch (Exception e) {
+ job1.run();
+ }
+
+ //case 2: with addPeriodicJob(): executes the job every 3 minutes
+ String jobName2 = "case2";
+ long period = 180;
+ Map<String, Serializable> config2 = new HashMap<String, Serializable>();
+ final Runnable job2 = new Runnable() {
+ public void run() {
+ log.info("Executing job2");
+ }
+ };
+ try {
+ this.scheduler.addPeriodicJob(jobName2, job2, config2, period, canRunConcurrently);
+ } catch (Exception e) {
+ job2.run();
+ }
+
+ //case 3: with fireJobAt(): executes the job at a specific date (date of deployment + delay of 30 seconds)
+ String jobName3 = "case3";
+ final long delay = 30*1000;
+ final Date fireDate = new Date();
+ fireDate.setTime(System.currentTimeMillis() + delay);
+ Map<String, Serializable> config3 = new HashMap<String, Serializable>();
+ final Runnable job3 = new Runnable() {
+ public void run() {
+ log.info("Executing job3 at date: {} with a delay of: {} seconds", fireDate, delay/1000);
+ }
+ };
+ try {
+ this.scheduler.fireJobAt(jobName3, job3, config3, fireDate);
+ } catch (Exception e) {
+ job3.run();
+ }
+ }
+
+ protected void deactivate(ComponentContext componentContext) {
+ log.info("Deactivated, goodbye!");
+ }
+
+}
+</code></pre></section></div></div>
<div class="footer">
<div class="timestamp">
TODO display revision number here