You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2016/04/21 09:11:34 UTC
svn commit: r986225 - in /websites/staging/sling/trunk/content: ./
documentation/development/slingstart.html
Author: buildbot
Date: Thu Apr 21 07:11:34 2016
New Revision: 986225
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/development/slingstart.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Apr 21 07:11:34 2016
@@ -1 +1 @@
-1740163
+1740244
Modified: websites/staging/sling/trunk/content/documentation/development/slingstart.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/development/slingstart.html (original)
+++ websites/staging/sling/trunk/content/documentation/development/slingstart.html Thu Apr 21 07:11:34 2016
@@ -114,6 +114,47 @@ h2:hover > .headerlink, h3:hover > .head
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<div class="toc">
+<ul>
+<li><a href="#the-model">The Model</a><ul>
+<li><a href="#run-modes">Run Modes</a></li>
+<li><a href="#start-levels">Start Levels</a></li>
+<li><a href="#artifacts">Artifacts</a></li>
+<li><a href="#configurations">Configurations</a><ul>
+<li><a href="#bootstrap-command-file">Bootstrap Command File</a></li>
+</ul>
+</li>
+<li><a href="#settings">Settings</a></li>
+<li><a href="#features">Features</a></li>
+</ul>
+</li>
+<li><a href="#model-files">Model Files</a><ul>
+<li><a href="#comments">Comments</a></li>
+<li><a href="#configurations-in-the-model-file">Configurations in the Model file</a></li>
+<li><a href="#default-configuration-format">Default Configuration Format</a></li>
+<li><a href="#configurations-defined-through-properties">Configurations Defined through Properties</a></li>
+</ul>
+</li>
+<li><a href="#slingstart-and-slingfeature-projects">Slingstart and Slingfeature projects</a></li>
+<li><a href="#model-merging">Model Merging</a><ul>
+<li><a href="#removing-and-changing-of-artifacts">Removing and Changing of Artifacts</a></li>
+<li><a href="#removing-and-changing-of-configurations">Removing and Changing of Configurations</a></li>
+</ul>
+</li>
+<li><a href="#slingstart-maven-plugin">slingstart-maven-plugin</a><ul>
+<li><a href="#starting-a-server">Starting a server</a><ul>
+<li><a href="#debugging">Debugging</a></li>
+</ul>
+</li>
+<li><a href="#stopping-a-server">Stopping a server</a></li>
+</ul>
+</li>
+<li><a href="#known-issues">Known Issues</a><ul>
+<li><a href="#support-of-configuration-formats">Support of configuration formats</a></li>
+</ul>
+</li>
+</ul>
+</div>
<p>The Apache Sling provisioning model is a model to describe OSGi based application. It can also be used to define a partial application aka feature (or subsystem in OSGi terms).</p>
<p>The model is describing an instance, it is not directly related to any particular tooling or packaging/provisioning vehicle.</p>
<p>For Apache Maven users, the slingstart-maven-plugin uses the model to create an executable application and/or a web application based on the model. Sling's Launchpad is defined using the model and built by this Maven plugin.</p>
@@ -284,7 +325,7 @@ Each run mode is associated with a set o
<p>Notice that this definition only supports string properties. Therefore the service consuming the configuration needs to be able to adapt a string value to the correct type.</p>
<h2 id="slingstart-and-slingfeature-projects">Slingstart and Slingfeature projects<a class="headerlink" href="#slingstart-and-slingfeature-projects" title="Permanent link">¶</a></h2>
-<p>The slingstart Maven plugin introduces two new packaging types:</p>
+<p>The slingstart-maven-plugin introduces two new packaging types:</p>
<ul>
<li>slingstart : This type requires a model at src/main/provisioning. It reads all text files in that directory and merges them in alphabetical order. The resulting artifact is a runnable jar. The assembled model is also attached to the project artifacts.</li>
<li>slingfeature : This type requires a model at src/main/provisioning. It reads all text files in that directory and merges them in alphabetical order and creates a merged model which is the final artifact of this project.</li>
@@ -362,10 +403,18 @@ Each run mode is associated with a set o
<p>When the merge directive is used, the configurations are merged and the properties are applied as a delta to the base configuration. Therefore the configuration my.special.configuration.b will have two properties "a" and "foo".</p>
<p>If a merged configuration redefines a property that already exists, it overwrites it, so the last configuration supplied in a merge wins.</p>
+<h2 id="slingstart-maven-plugin">slingstart-maven-plugin<a class="headerlink" href="#slingstart-maven-plugin" title="Permanent link">¶</a></h2>
+<h3 id="starting-a-server">Starting a server<a class="headerlink" href="#starting-a-server" title="Permanent link">¶</a></h3>
+<p>Use the goal with name <code>start</code> to start one or multiple servers. The goal is bound by default to the <a href="https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#Lifecycle_Reference"><code>pre-integration-test</code> lifecycle phase</a>.</p>
+<h4 id="debugging">Debugging<a class="headerlink" href="#debugging" title="Permanent link">¶</a></h4>
+<p>Since version 1.2.0 of this plugin it is possible to easily start a Sling server in debug mode (<a href="https://issues.apache.org/jira/browse/SLING-4677">SLING-4677</a>). For that you either configure the property <code>debug</code> inside you server configuration in the pom.xml accordingly or by using the parameter <code>Dlaunchpad.debug</code>. Both values can either be <code>true</code> (in which case the <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/jpda/conninv.html#Invocation">JDWT options</a> <code>-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000</code> are appended to the VM options) or just some arbitrary string defining JDWT options.
+In case both are used the parameter <code>Dlaunchpad.debug</code> takes precedence.</p>
+<h3 id="stopping-a-server">Stopping a server<a class="headerlink" href="#stopping-a-server" title="Permanent link">¶</a></h3>
+<p>Use the goal with name <code>stop</code> to stop one or multiple servers. The goal is bound by default to the <a href="https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html#Lifecycle_Reference"><code>post-integration-test</code> lifecycle phase</a>.</p>
<h2 id="known-issues">Known Issues<a class="headerlink" href="#known-issues" title="Permanent link">¶</a></h2>
<h3 id="support-of-configuration-formats">Support of configuration formats<a class="headerlink" href="#support-of-configuration-formats" title="Permanent link">¶</a></h3>
<p>The provisioning model supports two formats to define configurations, properties and the format of the Apache Felix ConfigAdmin implementation.</p>
-<p>Starting with version 1.2.0 of the provisioning model and version 1.2.0 of the slingstart maven plugin, the implementation uses the latest format from Apache Felix, version 1.8.6 (or higher) of the ConfigAdmin. This requires you to use version 3.6.6 (or higher) of the OSGi installer core bundle to handle these configurations.</p>
+<p>Starting with version 1.2.0 of the provisioning model and version 1.2.0 of the slingstart-maven-plugin, the implementation uses the latest format from Apache Felix, version 1.8.6 (or higher) of the ConfigAdmin. This requires you to use version 3.6.6 (or higher) of the OSGi installer core bundle to handle these configurations.</p>
<p>If you want to stick with the old format from config admin, you can configure the maven plugin as follows:</p>
<div class="codehilite"><pre><span class="nt"><plugin></span>
<span class="nt"><groupId></span>org.apache.sling<span class="nt"></groupId></span>
@@ -382,7 +431,7 @@ Each run mode is associated with a set o
<span class="nt"></plugin></span>
</pre></div>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1734922 by bdelacretaz on Mon, 14 Mar 2016 11:13:50 +0000
+ Rev. 1740244 by kwin on Thu, 21 Apr 2016 07:11:17 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project