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:20 UTC
[14/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/servlet-helpers.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/servlet-helpers.html b/documentation/bundles/servlet-helpers.html
index 1afcb14..b9dcbe0 100644
--- a/documentation/bundles/servlet-helpers.html
+++ b/documentation/bundles/servlet-helpers.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>Sling Servlet Helpers</h1></header><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>
@@ -25,26 +25,65 @@
<h2>Usage</h2>
<h3>SlingHttpServletRequest</h3>
<p>Example for preparing a sling request with custom request data:</p>
-<h1>!java</h1>
-<p>// prepare sling request MockSlingHttpServletRequest request = new MockSlingHttpServletRequest(resourceResolver);</p>
-<p>// simulate query string request.setQueryString("param1=aaa&param2=bbb");</p>
-<p>// alternative - set query parameters as map request.setParameterMap(ImmutableMap.<String,Object>builder() .put("param1", "aaa") .put("param2", "bbb") .build());</p>
-<p>// set current resource request.setResource(resourceResolver.getResource("/content/sample"));</p>
-<p>// set sling request path info properties MockRequestPathInfo requestPathInfo = (MockRequestPathInfo)request.getRequestPathInfo(); requestPathInfo.setSelectorString("selector1.selector2"); requestPathInfo.setExtension("html");</p>
-<p>// set method request.setMethod(HttpConstants.METHOD_POST);</p>
-<p>// set attributes request.setAttribute("attr1", "value1");</p>
-<p>// set headers request.addHeader("header1", "value1");</p>
-<p>// set cookies request.addCookie(new Cookie("cookie1", "value1"));</p>
+<pre><code>#!java
+// prepare sling request
+MockSlingHttpServletRequest request = new MockSlingHttpServletRequest(resourceResolver);
+
+// simulate query string
+request.setQueryString("param1=aaa&param2=bbb");
+
+// alternative - set query parameters as map
+request.setParameterMap(ImmutableMap.<String,Object>builder()
+ .put("param1", "aaa")
+ .put("param2", "bbb")
+ .build());
+
+// set current resource
+request.setResource(resourceResolver.getResource("/content/sample"));
+
+// set sling request path info properties
+MockRequestPathInfo requestPathInfo = (MockRequestPathInfo)request.getRequestPathInfo();
+requestPathInfo.setSelectorString("selector1.selector2");
+requestPathInfo.setExtension("html");
+
+// set method
+request.setMethod(HttpConstants.METHOD_POST);
+
+// set attributes
+request.setAttribute("attr1", "value1");
+
+// set headers
+request.addHeader("header1", "value1");
+
+// set cookies
+request.addCookie(new Cookie("cookie1", "value1"));
+</code></pre>
<h3>SlingHttpServletResponse</h3>
<p>Example for preparing a sling response which can collect the data that was written to it:</p>
-<h1>!java</h1>
-<p>// prepare sling response MockSlingHttpServletResponse response = new MockSlingHttpServletResponse();</p>
-<p>// execute the code that writes to the response...</p>
-<p>// validate status code assertEquals(HttpServletResponse.SC_OK, response.getStatus());</p>
-<p>// validate content type and content length assertEquals("text/plain;charset=UTF-8", response.getContentType()); assertEquals(CharEncoding.UTF_8, response.getCharacterEncoding()); assertEquals(55, response.getContentLength());</p>
-<p>// validate headers assertTrue(response.containsHeader("header1")); assertEquals("5", response.getHeader("header2"));</p>
-<p>// validate response body as string assertEquals(TEST_CONTENT, response.getOutputAsString());</p>
-<p>// validate response body as binary data assertArrayEquals(TEST_DATA, response.getOutput());</p></section></div></div>
+<pre><code>#!java
+// prepare sling response
+MockSlingHttpServletResponse response = new MockSlingHttpServletResponse();
+
+// execute the code that writes to the response...
+
+// validate status code
+assertEquals(HttpServletResponse.SC_OK, response.getStatus());
+
+// validate content type and content length
+assertEquals("text/plain;charset=UTF-8", response.getContentType());
+assertEquals(CharEncoding.UTF_8, response.getCharacterEncoding());
+assertEquals(55, response.getContentLength());
+
+// validate headers
+assertTrue(response.containsHeader("header1"));
+assertEquals("5", response.getHeader("header2"));
+
+// validate response body as string
+assertEquals(TEST_CONTENT, response.getOutputAsString());
+
+// validate response body as binary data
+assertArrayEquals(TEST_DATA, response.getOutput());
+</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/sling-health-check-tool.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/sling-health-check-tool.html b/documentation/bundles/sling-health-check-tool.html
index f851518..31a9984 100644
--- a/documentation/bundles/sling-health-check-tool.html
+++ b/documentation/bundles/sling-health-check-tool.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>Sling Health Check Tools</h1></header><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>
@@ -46,22 +46,53 @@
<p>The out of the box health check services also allow for using them as JMX aggregators and processors, which take JMX attribute values as input and make the results accessible via JMX MBeans.</p>
<h2>What's a <code>HealthCheck</code> ?</h2>
<p>A <code>HealthCheck</code> is just an OSGi service that returns a <code>Result</code>.</p>
-<p>public interface HealthCheck {</p>
-<p>/** Execute this health check and return a {@link Result} * This is meant to execute quickly, access to external * systems, for example, should be managed asynchronously. */ public Result execute(); }</p>
+<pre><code>public interface HealthCheck {
+
+ /** Execute this health check and return a {@link Result}
+ * This is meant to execute quickly, access to external
+ * systems, for example, should be managed asynchronously.
+ */
+ public Result execute();
+}
+</code></pre>
<p>Where <code>Result</code> is a simple immutable class that provides a <code>Status</code> (OK, WARN, CRITICAL etc.) and one or more log-like messages that can provide more info about what, if anything, went wrong.</p>
-<p>public class Result implements Iterable <ResultLog.Entry> {</p>
-<p>public boolean isOk() { return getStatus().equals(Status.OK); }</p>
-<p>public Status getStatus() { return resultLog.getAggregateStatus(); }</p>
-<p>@Override public Iterator<ResultLog.Entry> iterator() { return resultLog.iterator(); }</p>
-<p>... details omitted }</p>
+<pre><code>public class Result implements Iterable <ResultLog.Entry> {
+
+ public boolean isOk() {
+ return getStatus().equals(Status.OK);
+ }
+
+ public Status getStatus() {
+ return resultLog.getAggregateStatus();
+ }
+
+ @Override
+ public Iterator<ResultLog.Entry> iterator() {
+ return resultLog.iterator();
+ }
+
+ ... details omitted
+}
+</code></pre>
<h3>SlingHealthCheck annotation</h3>
<p>The <code>SlingHealthCheck</code> annotation makes it easier to specify the required <code>HealthCheck</code> service properties.</p>
<p>Here's an example from the <code>samples</code> module - see the <code>annotations</code> module for more details.</p>
-<p>@SlingHealthCheck( name="Annotated Health Check Sample", mbeanName="annotatedHC", description="Sample Health Check defined by a java annotation", tags={"sample","annotation"})</p>
-<p>public class AnnotatedHealthCheckSample implements HealthCheck {</p>
-<p>@Override public Result execute() { ...health check code } }</p>
+<pre><code>@SlingHealthCheck(
+ name="Annotated Health Check Sample",
+ mbeanName="annotatedHC",
+ description="Sample Health Check defined by a java annotation",
+ tags={"sample","annotation"})
+
+public class AnnotatedHealthCheckSample implements HealthCheck {
+
+ @Override
+ public Result execute() {
+ ...health check code
+ }
+}
+</code></pre>
<h2>Executing Health Checks</h2>
-<p>Health Checks can be executed via a <a href="#webconsole-plugin">webconsole plugin</a>, the <a href="#health-check-servlet">health check servlet</a> or via <a href="#jmx-access-to-health-checks">JMX</a>. <code>HealthCheck</code> services can be selected for execution based on their <code>hc.tags</code> multi-value service property.</p>
+<p>Health Checks can be executed via a <a href="#webconsole-plugin">webconsole plugin</a>, the <a href="#health-check-servlet">health check servlet</a> or via <a href="#jmx-access-to-health-checks">JMX</a>. <code>HealthCheck</code> services can be selected for execution based on their <code>hc.tags</code> multi-value service property. </p>
<p>The <code>HealthCheckFilter</code> utility accepts positive and negative tag parameters, so that <code>-security,sling</code> selects all <code>HealthCheck</code> having the <code>sling</code> tag but not the <code>security</code> tag, for example.</p>
<p>For advanced use cases it is also possible to use the API directly by using the interface <code>org.apache.sling.hc.api.execution.HealthCheckExecutor</code>.</p>
<h2>Health Check bundles</h2>
@@ -75,7 +106,7 @@
<li><code>org.apache.sling.hc.junit.bridge</code> makes selected Health Checks available as server-side JUnit tests. See below for more info.</li>
</ul>
<h2>Out-of-the-box <code>HealthCheck</code> services</h2>
-<p>The following default <code>HealthCheck</code> services are provided by the <code>org.apache.sling.hc.core</code> bundle:</p>
+<p>The following default <code>HealthCheck</code> services are provided by the <code>org.apache.sling.hc.core</code> bundle: </p>
<p>The <code>org.apache.sling.hc.samples</code> bundle provides OSGi configurations that demonstrate them.</p>
<ul>
<li><code>JmxAttributeHealthCheck</code> checks the value of a single JMX attribute and supports ranges like <em>between 12 and 42</em>.</li>
@@ -131,8 +162,14 @@
</table>
<p>All service properties are optional.</p>
<p>As an example, here's a <code>ScriptableHealthCheck</code> configuration provided by the <code>org.apache.sling.hc.samples</code> bundle:</p>
-<p>Factory PID = org.apache.sling.hc.ScriptableHealthCheck "hc.name" : "LoadedClassCount and ManagementSpecVersion are in range" "hc.mbean.name" : "LoadedClassCount and ManagementSpecVersion" "hc.tags" : [jvm, script] "expression" : "jmx.attribute('java.lang:type=ClassLoading', 'LoadedClassCount') > 10 && jmx.attribute('java.lang:type=Runtime', 'ManagementSpecVersion') > 1" "language.extension" : "ecma"</p>
-<p>The service properties starting with the <code>hc.</code> prefix in this example should be provided by all <code>HealthCheck</code> services.</p>
+<pre><code>Factory PID = org.apache.sling.hc.ScriptableHealthCheck
+"hc.name" : "LoadedClassCount and ManagementSpecVersion are in range"
+"hc.mbean.name" : "LoadedClassCount and ManagementSpecVersion"
+"hc.tags" : [jvm, script]
+"expression" : "jmx.attribute('java.lang:type=ClassLoading', 'LoadedClassCount') > 10 && jmx.attribute('java.lang:type=Runtime', 'ManagementSpecVersion') > 1"
+"language.extension" : "ecma"
+</code></pre>
+<p>The service properties starting with the <code>hc.</code> prefix in this example should be provided by all <code>HealthCheck</code> services. </p>
<h2>Configuring the Health Check Executor</h2>
<p>The health check executor can <strong>optionally</strong> be configured via service PID <code>org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl</code>:</p>
<table>
@@ -172,19 +209,21 @@
<p><img src="sling-hc-plugin.jpg" alt="Health Check Webconsole Plugin" /></p>
<h2>JMX access to health checks</h2>
<p>If the <code>org.apache.sling.hc.jmx</code> bundle is active, a JMX MBean is created for each <code>HealthCheck</code> which has the service property <code>hc.mbean.name</code> service property set. All health check MBeans are registered in the domain <code>org.apache.sling.healthcheck</code> with a type of <code>HealthCheck</code>.</p>
-<p>The MBean gives access to the <code>Result</code> and the log, as shown on the screenshot below.</p>
+<p>The MBean gives access to the <code>Result</code> and the log, as shown on the screenshot below. </p>
<p>See the example configurations of the <code>org.apache.sling.hc.samples</code> for more details.</p>
<p><img src="jconsole-hc.jpg" alt="JConsole showing Sling Health Check MBeans" /></p>
<h2>Health Check Servlet</h2>
<p>Starting with version 1.2.4 of the <code>org.apache.sling.hc.core</code> bundle, a flexible Health Checks execution servlet is available. It provides similar features to the Web Console plugin described above, with output in HTML, JSON (plain or jsonp) and TXT (concise or verbose) formats (see HTML format rendering page for more documentation).</p>
<p>The Health Checks Servlet is disabled by default, to enable it create an OSGi configuration like</p>
-<p>PID = org.apache.sling.hc.core.impl.servlet.HealthCheckExecutorServlet servletPath = /system/health</p>
+<pre><code>PID = org.apache.sling.hc.core.impl.servlet.HealthCheckExecutorServlet
+servletPath = /system/health
+</code></pre>
<p>which specifies the servlet's base path. That URL then returns an HTML page, by default with the results of all active health checks and with instructions at the end of the page about URL parameters which can be used to select specific Health Checks and control their execution and output format.</p>
<p>Note that by design <strong>the Health Checks Servlet doesn't do any access control by itself</strong> to ensure it can detect unhealthy states of the authentication itself. Make sure the configured path is only accessible to relevant infrastructure and operations people. Usually all <code>/system/*</code> paths are only accessible from a local network and not routed to the Internet.</p>
<h2>Health Checks as server-side JUnit tests</h2>
-<p>The <code>org.apache.sling.hc.junit.bridge</code> bundle makes selected Health Checks available as server-side JUnit tests.</p>
+<p>The <code>org.apache.sling.hc.junit.bridge</code> bundle makes selected Health Checks available as server-side JUnit tests. </p>
<p>It requires the <code>org.apache.sling.junit.core bundle</code> which provides the server-side JUnit tests infrastructure.</p>
-<p>The idea is to implement the smoke tests of your system, for example, as health checks. You can then run them as part of integration testing, using the <a href="/documentation/development/sling-testing-tools.html">Sling Testing Tools</a> remote testing utilities, and also as plain Health Checks for monitoring or troubleshooting Sling instances.</p>
+<p>The idea is to implement the smoke tests of your system, for example, as health checks. You can then run them as part of integration testing, using the <a href="/documentation/development/sling-testing-tools.html">Sling Testing Tools</a><br/>remote testing utilities, and also as plain Health Checks for monitoring or troubleshooting Sling instances.</p>
<p>To use this module, configure sets of tags at <code>/system/console/configMgr/org.apache.sling.hc.junitbridge.HealthCheckTestsProvider</code> using the standard <code>includeThisTag,-omitThatTag</code> syntax, and JUnit tests will be available at /system/sling/junit/HealthChecks.html to run the corresponding Health Checks.</p>
<p>To run the Health Check tests at build time, see the <a href="http://svn.apache.org/repos/asf/sling/trunk/testing/samples/integration-tests">testing/samples/integration-tests</a> sample module.</p></section></div></div>
<div class="footer">
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/sling-oak-restrictions.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/sling-oak-restrictions.html b/documentation/bundles/sling-oak-restrictions.html
index 378e957..d116f68 100644
--- a/documentation/bundles/sling-oak-restrictions.html
+++ b/documentation/bundles/sling-oak-restrictions.html
@@ -2,98 +2,93 @@
<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>Sling Oak Restrictions</h1></header><p>[TOC]</p>
<h2>Introduction</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>
-<p><strong>Important:</strong> Using the sling restrictions (as well as standard oak restrictions) is not as performant as simple path based ACE entries without any restrictions. Permission setups should always mostly work with path based ACEs and only use ACEs with restrictions for special cases.</p>
+<p><strong>Important:</strong> Using the sling restrictions (as well as standard oak restrictions) is not as performant as simple path based ACE entries without any restrictions. Permission setups should always mostly work with path based ACEs and only use ACEs with restrictions for special cases. </p>
<h2>Restriction sling:resourceTypes</h2>
-<p>This restriction allows to match against a sling resource type of a node and works much like the oak standard restriction <code>rep:ntNames</code>. Only resources that have one of the supplied resource types are matched, child and parent resources with other resource types are not matched.</p>
+<p>This restriction allows to match against a sling resource type of a node and works much like the oak standard restriction <code>rep:ntNames</code>. Only resources that have one of the supplied resource types are matched, child and parent resources with other resource types are not matched. </p>
<p>The following example allows <code>myAuthorizable</code> to write to all nodes that have either resource type <code>myproj/comp1</code> or <code>myproj/comp2</code>:</p>
-<ul>
- <li>/content/myprj/mynode</li>
- <li>rep:policy (rep:ACL)</li>
- <li>allow (rep:GrantACE)</li>
- <li>principalName (String) = "myAuthorizable"</li>
- <li>rep:privileges (Name[]) = "rep:write"</li>
- <li>rep:restrictions (rep:Restrictions)</li>
- <li>sling:resourceTypes (String[]) = [myproj/comp1,myproj/comp2]</li>
-</ul>
+<pre><code>- /content/myprj/mynode
+ - rep:policy (rep:ACL)
+ - allow (rep:GrantACE)
+ + principalName (String) = "myAuthorizable"
+ + rep:privileges (Name[]) = "rep:write"
+ - rep:restrictions (rep:Restrictions)
+ + sling:resourceTypes (String[]) = [myproj/comp1,myproj/comp2]
+</code></pre>
<p>Assuming the following structure</p>
-<ul>
- <li>/content/myprj</li>
- <li>sling:resourceType (String) = "myproj/siteroot"</li>
- <li>mynode</li>
- <li>sling:resourceType (String) = "myproj/comp1"</li>
- <li>mysubnode</li>
- <li>sling:resourceType (String) = "myproj/comp3"</li>
-</ul>
+<pre><code>- /content/myprj
+ + sling:resourceType (String) = "myproj/siteroot"
+ - mynode
+ + sling:resourceType (String) = "myproj/comp1"
+ - mysubnode
+ + sling:resourceType (String) = "myproj/comp3"
+</code></pre>
<p>the rule from above will match <code>/content/myprj/mynode</code> and not <code>/content/myprj</code> (parent) nor <code>/content/myprj/mynode/mysubnode</code> (child).</p>
<p>Naturally (as with any oak restrictions), the rule is limited to its base path. In case the node <code>/content/myprj/othernode</code> is of resource type <code>myproj/comp1</code>, it will still not match.</p>
<h2>Restriction sling:resourceTypesWithDescendants</h2>
<p>This restriction matches against resource types in the same way as <a href="#restriction-slingresourcetypes">sling:resourceTypes</a>, except that it will also match all descendants of a matched node.</p>
<p>The following example allows <code>myAuthorizable</code> to write to all nodes that have either resource type <code>myproj/comp1</code> or <code>myproj/comp2</code> <strong>or are a child of a node, that has one of these resource types</strong>:</p>
-<ul>
- <li>/content/myprj/mynode</li>
- <li>rep:policy (rep:ACL)</li>
- <li>allow (rep:GrantACE)</li>
- <li>principalName (String) = "myAuthorizable"</li>
- <li>rep:privileges (Name[]) = "rep:write"</li>
- <li>rep:restrictions (rep:Restrictions)</li>
- <li>sling:resourceTypesWithDescendants (String[]) = [myproj/comp1,myproj/comp2]</li>
-</ul>
+<pre><code>- /content/myprj/mynode
+ - rep:policy (rep:ACL)
+ - allow (rep:GrantACE)
+ + principalName (String) = "myAuthorizable"
+ + rep:privileges (Name[]) = "rep:write"
+ - rep:restrictions (rep:Restrictions)
+ + sling:resourceTypesWithDescendants (String[]) = [myproj/comp1,myproj/comp2]
+</code></pre>
<p>Assuming the structure example as mentioned in <a href="#restriction-slingresourcetypes">sling:resourceTypes</a>, the rule from above will match <code>/content/myprj/mynode</code> and <code>/content/myprj/mynode/mysubnode</code> (and any other subnodes of <code>/content/myprj/mynode</code> with arbitrary resource types), but not <code>/content/myprj</code>.</p>
<h2>Advanced Path Matching</h2>
-<p>Both <a href="#restriction-slingresourcetypes">sling:resourceTypes</a> and <a href="#restriction-slingresourcetypeswithdescendants">sling:resourceTypesWithDescendants</a> support advanced path matching by using <code>resourcetype@path</code>. That way instead of checking the resource type of the current node, the resource type of node at the relative path is checked. For instance this is useful for the case where page content is stored in a <code>jcr:content</code> subnode of a hierarchy, the permission however is required to become effective on the parent node of <code>jcr:content</code>.</p>
+<p>Both <a href="#restriction-slingresourcetypes">sling:resourceTypes</a> and <a href="#restriction-slingresourcetypeswithdescendants">sling:resourceTypesWithDescendants</a> support advanced path matching by using <code>resourcetype@path</code>. That way instead of checking the resource type of the current node, the resource type of node at the relative path is checked. For instance this is useful for the case where page content is stored in a <code>jcr:content</code> subnode of a hierarchy, the permission however is required to become effective on the parent node of <code>jcr:content</code>. </p>
<p>The following example allows <code>myAuthorizable</code> to write to all nodes that have a subnode <code>jcr:content</code> with resource type <code>myproj/comp1</code> or <code>myproj/comp2</code> including their descendants:</p>
-<ul>
- <li>/content/myprj/mynode</li>
- <li>rep:policy (rep:ACL)</li>
- <li>allow (rep:GrantACE)</li>
- <li>principalName (String) = "myAuthorizable"</li>
- <li>rep:privileges (Name[]) = "rep:write"</li>
- <li>rep:restrictions (rep:Restrictions)</li>
- <li>sling:resourceTypesWithDescendants (String[]) = [myproj/comp1@jcr:content,myproj/comp2@jcr:content]</li>
-</ul>
+<pre><code>- /content/myprj/mynode
+ - rep:policy (rep:ACL)
+ - allow (rep:GrantACE)
+ + principalName (String) = "myAuthorizable"
+ + rep:privileges (Name[]) = "rep:write"
+ - rep:restrictions (rep:Restrictions)
+ + sling:resourceTypesWithDescendants (String[]) = [myproj/comp1@jcr:content,myproj/comp2@jcr:content]
+</code></pre>
<p>Assuming the following structure</p>
-<ul>
- <li>/content/myprj</li>
- <li>jcr:content</li>
- <li>sling:resourceType (String) = "myproj/siteroot"</li>
- <li>mynode1</li>
- <li>jcr:content</li>
- <li>sling:resourceType (String) = "myproj/comp1"</li>
- <li>mysubnode1</li>
- <li>jcr:content</li>
- <li>sling:resourceType (String) = "myproj/comp3"</li>
- <li>contentsubnode1</li>
- <li>sling:resourceType (String) = "myproj/comp4"</li>
- <li>contentsubnode2</li>
- <li>sling:resourceType (String) = "myproj/comp5"</li>
- <li>mysubnode2</li>
- <li>jcr:content</li>
- <li>sling:resourceType (String) = "myproj/comp3"</li>
- <li>mynode2</li>
- <li>jcr:content</li>
- <li>sling:resourceType (String) = "myproj/comp7"</li>
-</ul>
-<p>the rule from above will match</p>
+<pre><code>- /content/myprj
+ - jcr:content
+ + sling:resourceType (String) = "myproj/siteroot"
+ - mynode1
+ - jcr:content
+ + sling:resourceType (String) = "myproj/comp1"
+ - mysubnode1
+ - jcr:content
+ + sling:resourceType (String) = "myproj/comp3"
+ - contentsubnode1
+ + sling:resourceType (String) = "myproj/comp4"
+ - contentsubnode2
+ + sling:resourceType (String) = "myproj/comp5"
+ - mysubnode2
+ - jcr:content
+ + sling:resourceType (String) = "myproj/comp3"
+ - mynode2
+ - jcr:content
+ + sling:resourceType (String) = "myproj/comp7"
+</code></pre>
+<p>the rule from above will match </p>
<ul>
<li><code>/content/myprj/mynode1</code> (because of the <code>@jcr:content</code> part of <code>myproj/comp1@jcr:content</code>)</li>
<li><code>/content/myprj/mynode1/jcr:content</code> (it will check for <code>/content/myprj/mynode1/jcr:content/jcr:content</code> that does not exist, but since the parent <code>/content/myprj/mynode1</code> is already a match this matches because of <code>sling:resourceTypesWithDescendants</code>)</li>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/sling-pipes.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/sling-pipes.html b/documentation/bundles/sling-pipes.html
index fc151b1..1793fa6 100644
--- a/documentation/bundles/sling-pipes.html
+++ b/documentation/bundles/sling-pipes.html
@@ -2,27 +2,35 @@
<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>Sling Pipes</h1></header><p>tool for doing extract - transform - load operations through a resource tree configuration.</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>What is a pipe</h2>
-<p>getOutputBinding ^ | getInput +---+---+ getOutput | | +----> Pipe +----> | | +-------+</p>
+<pre><code> getOutputBinding
+ ^
+ |
+ getInput +---+---+ getOutput
+ | |
+ +----> Pipe +---->
+ | |
+ +-------+
+</code></pre>
<p>A sling pipe is essentially a sling resource stream:</p>
<ul>
<li>it provides an output as a sling resource iterator</li>
@@ -33,7 +41,7 @@
<ul>
<li>"reader" pipes, that will just output a set of resource depending on the input</li>
<li>"writer" pipes, that write to the repository, depending on configuration and output</li>
- <li>"container" pipes, that contains pipes, and whose job is to chain their execution : input is the input of their first pipe, output is the output of the last pipe it contains.</li>
+ <li>"container" pipes, that contains pipes, and whose job is to chain their execution : input is the input of their first pipe, output is the output of the last pipe it contains.</li>
</ul>
<p>A <code>Plumber</code> osgi service is provided to help getting & executing pipes.</p>
<h2>Registered Pipes</h2>
@@ -150,29 +158,34 @@
<li>name/value of each property of some pipes (write, remove)</li>
</ul>
<p>you can use name of previous pipes in the pipe container, or the special binding <code>path</code>, where <code>path.previousPipe</code> is the path of the current resource of previous pipe named <code>previousPipe</code></p>
-<p>global bindings can be set at pipe execution, external scripts can be added to the execution as well (see pipe configurations)</p>
+<p>global bindings can be set at pipe execution, external scripts can be added to the execution as well (see pipe configurations)</p>
<h2>How to execute a pipe</h2>
<p>for now it's possible to execute Pipes through GET (read) or POST (read/write) commands:</p>
<h3>Request Path</h3>
<ul>
- <li>either you'll need to create a slingPipes/plumber resource, say <code>etc/pipes</code> and then to execute</li>
+ <li>
+ <p>either you'll need to create a slingPipes/plumber resource, say <code>etc/pipes</code> and then to execute</p>
+ <p>curl -u admin:admin -F "path=/etc/pipes/mySamplePipe" http://localhost:8080/etc/pipes.json</p>
+ </li>
+ <li>
+ <p>either you execute the request directly on the pipe Path, e.g.</p>
+ <p>curl -u admin:admin http://localhost:8080/etc/pipes/mySamplePipe.json</p>
+ </li>
</ul>
-<p>curl -u admin:admin -F "path=/etc/pipes/mySamplePipe" http://localhost:8080/etc/pipes.json</p>
-<ul>
- <li>either you execute the request directly on the pipe Path, e.g.</li>
-</ul>
-<p>curl -u admin:admin http://localhost:8080/etc/pipes/mySamplePipe.json</p>
<p>which will return you the path of the pipes that have been through the output of the configured pipe.</p>
<h3>Request Parameter <code>binding</code></h3>
<p>you can add as <code>bindings</code> parameter a json object of global bindings you want to add for the execution of the pipe</p>
<p>e.g.</p>
-<p>curl -u admin:admin -F "path=/etc/pipes/test" -F "bindings={testBinding:'foo'}" http://localhost:4502/etc/pipes.json</p>
+<pre><code>curl -u admin:admin -F "path=/etc/pipes/test" -F "bindings={testBinding:'foo'}" http://localhost:4502/etc/pipes.json
+</code></pre>
<p>will returns something like</p>
-<p>{"size":2, "items":["/one/output/resource", "another/one"]}</p>
+<pre><code>{"size":2, "items":["/one/output/resource", "another/one"]}
+</code></pre>
<h3>Request Parameter <code>writer</code></h3>
<p>you can add as <code>writer</code> parameter a json object as a pattern to the result you want to have. The values of the json object are expressions and can reuse each pipe's subpipe binding. Note this works only if the pipe called is a container pipe.</p>
<p>e.g.</p>
-<p>curl -u admin:admin http://localhost:4502/etc/pipes/users.json?writer={"user":"${user.fullName}"}</p>
+<pre><code>curl -u admin:admin http://localhost:4502/etc/pipes/users.json?writer={"user":"${user.fullName}"}
+</code></pre>
<p>will returns something similar to</p>
<p>{"size":2, "items":[{'user':'John Smith','path':'/home/users/q/q123jk1UAZS'},{'user':'John Doe','path':'/home/users/q/q153jk1UAZS'}]}</p>
<h3>Request Parameter <code>dryRun</code></h3>
@@ -182,14 +195,131 @@
<h2>sample configurations</h2>
<h3>slingQuery | write</h3>
<p>this pipe parse all profile nodes, and</p>
-<p>{ "sling:resourceType":"slingPipes/container", "name":"Dummy User prefix Sample", "jcr:description":"prefix all full names of profile with "Mr" or "Ms" depending on gender", "conf":{ "profile": { "sling:resourceType":"slingPipes/slingQuery", "expr":"nt:unstructured#profile", "path":"/home/users" }, "writeFullName": { "sling:resourceType":"slingPipes/write", "conf": { "fullName":"${(profile.gender === 'female' ? 'Ms ' + profile.fullName : 'Mr ' + profile.fullName)}", "generatedBy":"slingPipes" } } } }</p>
+<pre><code>{
+ "sling:resourceType":"slingPipes/container",
+ "name":"Dummy User prefix Sample",
+ "jcr:description":"prefix all full names of profile with "Mr" or "Ms" depending on gender",
+ "conf":{
+ "profile": {
+ "sling:resourceType":"slingPipes/slingQuery",
+ "expr":"nt:unstructured#profile",
+ "path":"/home/users"
+ },
+ "writeFullName": {
+ "sling:resourceType":"slingPipes/write",
+ "conf": {
+ "fullName":"${(profile.gender === 'female' ? 'Ms ' + profile.fullName : 'Mr ' + profile.fullName)}",
+ "generatedBy":"slingPipes"
+ }
+ }
+ }
+}
+</code></pre>
<h3>slingQuery | multiProperty | authorizable | write</h3>
-<p>{ "jcr:primaryType": "sling:Folder", "jcr:description": "move badge<->user relation ship from badge MV property to a user MV property" "name": "badges", "sling:resourceType": "slingPipes/container", "conf": { "jcr:primaryType": "sling:OrderedFolder", "badge": { "jcr:primaryType": "sling:Folder", "jcr:description": "outputs all badge component resources", "expr": "[sling:resourceType=myApp/components/badge]", "path": "/etc/badges/badges-admin/jcr:content", "sling:resourceType": "slingPipes/slingQuery" }, "profile": { "jcr:primaryType": "sling:Folder", "jcr:description": "retrieve all user ids from a mv property", "path": "${path.badge}/profiles", "sling:resourceType": "slingPipes/multiProperty" }, "user": { "jcr:primaryType": "sling:OrderedFolder", "jcr:description": "outputs user resource", "expr": "profile", "sling:resourceType": "slingPipes/authorizable" }, "write": { "jcr:primaryType": "sling:OrderedFolder", "jcr:descritption": "patches the badge path to the badges prope
rty of the user profile" "path": "${path.user}/profile", "sling:resourceType": "slingPipes/write", "conf": { "jcr:primaryType": "nt:unstructured", "badges": "+[${path.badge}]" } } } }</p>
+<pre><code>{
+ "jcr:primaryType": "sling:Folder",
+ "jcr:description": "move badge<->user relation ship from badge MV property to a user MV property"
+ "name": "badges",
+ "sling:resourceType": "slingPipes/container",
+ "conf": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "badge": {
+ "jcr:primaryType": "sling:Folder",
+ "jcr:description": "outputs all badge component resources",
+ "expr": "[sling:resourceType=myApp/components/badge]",
+ "path": "/etc/badges/badges-admin/jcr:content",
+ "sling:resourceType": "slingPipes/slingQuery"
+ },
+ "profile": {
+ "jcr:primaryType": "sling:Folder",
+ "jcr:description": "retrieve all user ids from a mv property",
+ "path": "${path.badge}/profiles",
+ "sling:resourceType": "slingPipes/multiProperty"
+ },
+ "user": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "jcr:description": "outputs user resource",
+ "expr": "profile",
+ "sling:resourceType": "slingPipes/authorizable"
+ },
+ "write": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "jcr:descritption": "patches the badge path to the badges property of the user profile"
+ "path": "${path.user}/profile",
+ "sling:resourceType": "slingPipes/write",
+ "conf": {
+ "jcr:primaryType": "nt:unstructured",
+ "badges": "+[${path.badge}]"
+ }
+ }
+ }
+}
+</code></pre>
<h3>xpath | json | write</h3>
<p>this use case is for completing repository profiles with external system's data (that has an json api)</p>
-<p>{ "jcr:primaryType": "nt:unstructured", "jcr:description": "this pipe retrieves json info from an external system and writes them to the user profile, uses moment.js, it distributes modified resources using publish distribution agent", "sling:resourceType": "slingPipes/container", "distribution.agent": "publish", "additionalScripts": "/etc/source/moment.js", "conf": { "jcr:primaryType": "sling:OrderedFolder", "profile": { "jcr:primaryType": "sling:OrderedFolder", "expr": "/jcr:root/home/users//element(profile,nt:unstructured)[@uid]", "jcr:description": "query all user profile nodes", "sling:resourceType": "slingPipes/xpath" }, "json": { "jcr:primaryType": "sling:OrderedFolder", "expr": "${(profile.uid ? 'https://my.external.system.corp.com/profiles/' + profile.uid.substr(0,2) + '/' + profile.uid + '.json' : '')", "jcr:description": "retrieves json information relative to the given profile, if the uid is not found, expr is empty: the pipe will do nothing", "sling:resourceType": "s
lingPipes/json" }, "write": { "jcr:primaryType": "sling:OrderedFolder", "path": "path.profile", "jcr:description": "write json information to the profile node", "sling:resourceType": "slingPipes/write", "conf": { "jcr:primaryType": "sling:OrderedFolder", "background": "${json.opt('background')}", "about": "${json.opt('about')}", "birthday": "${(json.opt('birthday') ? moment(json.opt('birthday'), "MMMM DD").toDate() : '')}", "mobile": "${json.opt('mobile')}" } } } }</p>
+<pre><code>{
+ "jcr:primaryType": "nt:unstructured",
+ "jcr:description": "this pipe retrieves json info from an external system and writes them to the user profile, uses moment.js, it
+ distributes modified resources using publish distribution agent",
+ "sling:resourceType": "slingPipes/container",
+ "distribution.agent": "publish",
+ "additionalScripts": "/etc/source/moment.js",
+ "conf": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "profile": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "expr": "/jcr:root/home/users//element(profile,nt:unstructured)[@uid]",
+ "jcr:description": "query all user profile nodes",
+ "sling:resourceType": "slingPipes/xpath"
+ },
+ "json": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "expr": "${(profile.uid ? 'https://my.external.system.corp.com/profiles/' + profile.uid.substr(0,2) + '/' + profile.uid + '.json' : '')",
+ "jcr:description": "retrieves json information relative to the given profile, if the uid is not found, expr is empty: the pipe will do nothing",
+ "sling:resourceType": "slingPipes/json"
+ },
+ "write": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "path": "path.profile",
+ "jcr:description": "write json information to the profile node",
+ "sling:resourceType": "slingPipes/write",
+ "conf": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "background": "${json.opt('background')}",
+ "about": "${json.opt('about')}",
+ "birthday": "${(json.opt('birthday') ? moment(json.opt('birthday'), \"MMMM DD\").toDate() : '')}",
+ "mobile": "${json.opt('mobile')}"
+ }
+ }
+ }
+}
+</code></pre>
<h3>xpath | parent | rm</h3>
-<p>{ "jcr:primaryType": "nt:unstructured", "jcr:description": "this pipe removes user with bad property in their profile", "sling:resourceType": "slingPipes/container", "conf": { "jcr:primaryType": "sling:OrderedFolder", "profile": { "jcr:primaryType": "sling:OrderedFolder", "expr": "/jcr:root/home/users//element(profile,nt:unstructured)[@bad]", "jcr:description": "query all user profile nodes with bad properties", "sling:resourceType": "slingPipes/xpath" }, "parent": { "jcr:primaryType": "sling:OrderedFolder", "jcr:description": "get the parent node (user node)", "sling:resourceType": "slingPipes/parent" }, "rm": { "jcr:primaryType": "sling:OrderedFolder", "jcr:description": "remove it", "sling:resourceType": "slingPipes/rm", } } }</p>
+<pre><code>{
+ "jcr:primaryType": "nt:unstructured",
+ "jcr:description": "this pipe removes user with bad property in their profile",
+ "sling:resourceType": "slingPipes/container",
+ "conf": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "profile": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "expr": "/jcr:root/home/users//element(profile,nt:unstructured)[@bad]",
+ "jcr:description": "query all user profile nodes with bad properties",
+ "sling:resourceType": "slingPipes/xpath"
+ },
+ "parent": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "jcr:description": "get the parent node (user node)",
+ "sling:resourceType": "slingPipes/parent"
+ },
+ "rm": {
+ "jcr:primaryType": "sling:OrderedFolder",
+ "jcr:description": "remove it",
+ "sling:resourceType": "slingPipes/rm",
+ }
+ }
+}
+</code></pre>
<p>some other samples are in https://github.com/npeltier/sling-pipes/tree/master/src/test/</p>
<h1>Compatibility</h1>
<p>For running this tool on a sling instance you need:</p>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/documentation/bundles/sling-query.html
----------------------------------------------------------------------
diff --git a/documentation/bundles/sling-query.html b/documentation/bundles/sling-query.html
index e43d0f8..6004c0c 100644
--- a/documentation/bundles/sling-query.html
+++ b/documentation/bundles/sling-query.html
@@ -2,29 +2,45 @@
<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>Sling Query</h1></header><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>Introduction</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>
-<p>Resource resource = ...; while ((resource = resource.getParent()) != null) { if (!resource.isResourceType("cq:Page")) { continue; } Resource template = resource.getChild("jcr:content/cq:template"); if (template != null && "my/template".equals(template.adaptTo(String.class))) { break; } } if (resource != null) { // we've found appropriate ancestor }</p>
+<pre><code>Resource resource = ...;
+while ((resource = resource.getParent()) != null) {
+ if (!resource.isResourceType("cq:Page")) {
+ continue;
+ }
+ Resource template = resource.getChild("jcr:content/cq:template");
+ if (template != null && "my/template".equals(template.adaptTo(String.class))) {
+ break;
+ }
+}
+if (resource != null) {
+ // we've found appropriate ancestor
+}
+</code></pre>
<p>SlingQuery is a tool that helps creating such queries in a more concise way. Above code could be written as:</p>
-<p>import static org.apache.sling.query.SlingQuery.$; // ... $(resource).closest("cq:Page[jcr:content/cq:template=my/template]")</p>
+<pre><code>import static org.apache.sling.query.SlingQuery.$;
+// ...
+$(resource).closest("cq:Page[jcr:content/cq:template=my/template]")
+</code></pre>
<p>Dollar sign is a static method that takes the resource array and creates SlingQuery object. The <code>closest()</code> method returns the first ancestor matching the selector string passed as the argument.</p>
<p>SlingQuery is inspired by the jQuery framework. jQuery is the source of method names, selector string syntax and the dollar sign method used as a collection constructor.</p>
<h2>Features</h2>
@@ -37,16 +53,24 @@
</ul>
<h2>Installation</h2>
<p>Add following Maven dependency to your <code>pom.xml</code>:</p>
-<p><dependency> <groupId>org.apache.sling</groupId> <artifactId>org.apache.sling.query</artifactId> <version>3.0.0</version> </dependency></p>
+<pre><code><dependency>
+ <groupId>org.apache.sling</groupId>
+ <artifactId>org.apache.sling.query</artifactId>
+ <version>3.0.0</version>
+</dependency>
+</code></pre>
<h2>Documentation</h2>
<ul>
<li><a href="http://cognifide.github.io/Sling-Query/circuit2014/">CIRCUIT 2014 presentation</a></li>
<li><a href="https://github.com/Cognifide/Sling-Query/wiki/Basic-ideas">Basic ideas</a></li>
<li><a href="https://github.com/Cognifide/Sling-Query/wiki/Method-list">Method list</a></li>
- <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Selector-syntax">Selector syntax</a></li>
- <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Operator-list">Operator list</a></li>
- <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Modifier-list">Modifier list</a></li>
- <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Hierarchy-operator-list">Hierarchy operator list</a></li>
+ <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Selector-syntax">Selector syntax</a>
+ <ul>
+ <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Operator-list">Operator list</a></li>
+ <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Modifier-list">Modifier list</a></li>
+ <li><a href="https://github.com/Cognifide/Sling-Query/wiki/Hierarchy-operator-list">Hierarchy operator list</a></li>
+ </ul>
+ </li>
<li><a href="https://github.com/Cognifide/Sling-Query/wiki/Examples">Examples</a></li>
</ul>
<h2>External resources</h2>
http://git-wip-us.apache.org/repos/asf/sling-site/blob/3a935d04/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 74976c1..07645f9 100644
--- a/documentation/bundles/sling-settings-org-apache-sling-settings.html
+++ b/documentation/bundles/sling-settings-org-apache-sling-settings.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>Sling Settings and Run Modes (org.apache.sling.settings)</h1></header><h1>Overview</h1>
<p>The Sling Settings Bundle exposes the <code>SlingSettingsService</code> which allows access to the following information pertinent to a Sling instance:</p>
@@ -41,7 +41,8 @@
<p>The <code>sling.run.mode.install.options</code> property is only used on the first startup on the Sling instance and the run modes that it defines cannot be changed later.</p>
<p>The <code>sling.run.mode.options</code> property on the other hand is used at each startup, so the run modes that it defines can be changed between executions of a given Sling instance.</p>
<p>The value of the both these properties is a string which looks like:</p>
-<p>red,green,blue|one|moon,mars</p>
+<pre><code>red,green,blue|one|moon,mars
+</code></pre>
<p>where <em>comma-separated run modes form a group</em>. The individual groups are separated by a pipe character (<code>|</code>, which is not an OR operation, it's just as separator). A group defines a number of run modes which are <strong>mutually exclusive</strong>. It means once a group is defined, exactly one run mode will be active from that group.</p>
<p>The example from above consists out of 3 different groups</p>
<ol>
@@ -49,7 +50,7 @@
<li><code>one</code></li>
<li><code>moon,mars</code></li>
</ol>
-<p>The rules for determining the active run modes from the selected run mode (<code>sling.run.modes</code>) and the run mode options (<code>sling.run.mode.install.options</code> and <code>sling.run.mode.options</code>) are as follows :</p>
+<p>The rules for determining the active run modes from the selected run mode (<code>sling.run.modes</code>) and the run mode options (<code>sling.run.mode.install.options</code> and <code>sling.run.mode.options</code>) are as follows : </p>
<ol>
<li>If none of the run modes in the options are selected, the first one from each group in the options is activated by default.</li>
<li>If one is selected from a group in the options, this is active.</li>
@@ -57,7 +58,8 @@
<li>If the selected run mode is not mentioned in any of the option groups it is active</li>
</ol>
<p>Examples</p>
-<p>sling.run.mode.options=a,b|c,d,e</p>
+<pre><code>sling.run.mode.options=a,b|c,d,e
+</code></pre>
<table>
<thead>
<tr>
@@ -95,8 +97,16 @@
<p>Remember to look at the <code>RunModeImplTest</code> mentioned above for details, and feel free to enhance it with useful examples.</p>
<h3>Getting the Run Modes of the Sling instance</h3>
<p>The <code>SlingSettings</code> service provides the Run Modes of the running Sling instance as in this example:</p>
-<p>:::java SlingSettings settings = ...get from BundleContext... Set<String> currentRunModes = settings.getRunModes();</p>
-<p>Set<String> expectedRunModes = new HashSet<String>(){{ add("foo");add("wii"); }}; if(expectedRunModes.removeAll(currentRunModes)) { // at least one of (foo,wii) run modes // is active }</p>
+<pre><code>:::java
+SlingSettings settings = ...get from BundleContext...
+Set<String> currentRunModes = settings.getRunModes();
+
+Set<String> expectedRunModes = new HashSet<String>(){{ add("foo");add("wii"); }};
+if(expectedRunModes.removeAll(currentRunModes)) {
+ // at least one of (foo,wii) run modes
+ // is active
+}
+</code></pre>
<p>Getting run modes in this way is usually not needed, it's better to define bundles or configurations that are only valid in specific run modes, rather than making decisions in code based on run modes.</p></section></div></div>
<div class="footer">
<div class="timestamp">