Author: buildbot
Date: Wed May 11 16:33:54 2016
New Revision: 987995
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 Wed May 11 16:33:54 2016
@@ -1 +1 @@
-1743353
+1743395
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
Wed May 11 16:33:54 2016
@@ -141,14 +141,11 @@ h2:hover > .headerlink, h3:hover > .head
<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>
@@ -157,7 +154,7 @@ h2:hover > .headerlink, h3:hover > .head
</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>
+<p>For Apache Maven users, the <code>slingstart-maven-plugin</code> 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>
<h2 id="the-model">The Model<a class="headerlink" href="#the-model"
title="Permanent link">¶</a></h2>
<p>The model is a simple API consisting of data objects:</p>
<ul>
@@ -326,10 +323,10 @@ 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 <code>slingstart-maven-plugin</code> 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>
+<li><code>slingstart</code> : 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><code>slingfeature</code> : 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>
</ul>
<p>A model can reference other slingstart or slingfeature artifacts. When such
an artifact is reference, the type needs to be specified, for example:</p>
<div class="codehilite"><pre><span class="k">[artifacts]</span>
@@ -404,13 +401,102 @@ 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.
+<h2 id="starting-a-server">Starting a server<a class="headerlink"
href="#starting-a-server" title="Permanent link">¶</a></h2>
+<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>. The launchpad JAR used to start the server is being
looked up from the following locations:</p>
+<ol>
+<li>the file path given in the configuration field <code>launchpadJar</code>
or parameter <code>launchpad.jar</code></li>
+<li>the slingstart artifact being referenced in the configuration element
<code>launchpadDependency</code></li>
+<li>the artifact being created through the Maven project itself (only if the
current project has pacakaging <code>slingstart</code>)</li>
+<li>the first dependency of type <code>slingstart</code></li>
+</ol>
+<p>The server itself is configured within an element <code>server</code> below
the configuration element <code>servers</code>. It supports the following
configuration settings</p>
+<table class="table">
+<thead>
+<tr>
+<th>Name</th>
+<th>Type</th>
+<th>Description</th>
+<th>Default Value</th>
+<th>Mandatory</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>port</td>
+<td>String</td>
+<td>The port on which the server is listening for HTTP requests. Arbitrary if
not set.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+<tr>
+<td>id</td>
+<td>String</td>
+<td>The instance id for this server. If not set the id is automatically
generated from the run modes and the port.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+<tr>
+<td>runmode</td>
+<td>String</td>
+<td>The comma-separated list of <a
href="/documentation/bundles/sling-settings-org-apache-sling-settings.html#run-modes">run
modes</a> to be set for this server. Those will be set in addition to the ones
being defined by the underlying model.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+<tr>
+<td>contextPath</td>
+<td>String</td>
+<td>The context path. If not set then Sling is deployed in the root
context.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+<tr>
+<td>controlPort</td>
+<td>String</td>
+<td>The TCP <a
href="/documentation/the-sling-engine/the-sling-launchpad.html#control-port">control
port</a> on which the server is listening for control commands. Arbitrary if
not set.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+<tr>
+<td>instances</td>
+<td>int</td>
+<td>The number of instances which should be created from this server element.
In this case the configuration acts as template. The port and controlPort for
all servers being generated from this configuration are random (except for the
first server).</td>
+<td>1</td>
+<td>no</td>
+</tr>
+<tr>
+<td>folder</td>
+<td>String</td>
+<td>The folder from where to start Sling. If not set is a folder in the
project's build directory named like the <code>id</code>.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+<tr>
+<td>vmOpts</td>
+<td>String</td>
+<td>The JVM options to use.</td>
+<td><code>-Xmx1024m -XX:MaxPermSize=256m -Djava.awt.headless=true</code></td>
+<td>no</td>
+</tr>
+<tr>
+<td>opts</td>
+<td>String</td>
+<td>Additional application options.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+<tr>
+<td>debug</td>
+<td>String</td>
+<td>See below for an explanation.</td>
+<td>-</td>
+<td>no</td>
+</tr>
+</tbody>
+</table>
+<h3 id="debugging">Debugging<a class="headerlink" href="#debugging"
title="Permanent link">¶</a></h3>
+<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";>JDWP
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
debugging 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>
+<h2 id="stopping-a-server">Stopping a server<a class="headerlink"
href="#stopping-a-server" title="Permanent link">¶</a></h2>
<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>
@@ -432,7 +518,7 @@ In case both are used the parameter <cod
<span class="nt"></plugin></span>
</pre></div>
<div class="timestamp" style="margin-top: 30px; font-size: 80%;
text-align: right;">
- Rev. 1743353 by cziegeler on Wed, 11 May 2016 12:59:26 +0000
+ Rev. 1743395 by kwin on Wed, 11 May 2016 16:33:40 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache
Sling project
