incubator-sling-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r890244 - in /websites/staging/sling/trunk/content: ./ documentation/development/sling.html
Date Fri, 13 Dec 2013 16:57:14 GMT
Author: buildbot
Date: Fri Dec 13 16:57:14 2013
New Revision: 890244

Log:
Staging update by buildbot for sling

Modified:
    websites/staging/sling/trunk/content/   (props changed)
    websites/staging/sling/trunk/content/documentation/development/sling.html

Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Dec 13 16:57:14 2013
@@ -1 +1 @@
-1550767
+1550770

Modified: websites/staging/sling/trunk/content/documentation/development/sling.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/development/sling.html (original)
+++ websites/staging/sling/trunk/content/documentation/development/sling.html Fri Dec 13 16:57:14
2013
@@ -178,13 +178,43 @@
 
 
 <h3 id="configuration">Configuration</h3>
-<p>The <code>deploy</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:
-| Parameter | Default Value | System Property Overwrite | Description |
-|--|--|--|--|
-| <code>skip</code> | <code>false</code> | <code>sling.deploy.skip</code>
| Whether to skip this step even though it has been configured in the project to be executed.
The main use of this setting is preventing deployment of the bundle to a Sling OSGi Bundle
Repository server if it is known that there is none or if such an upload is not required.
|
-| <code>buildDirectory</code> | <code>$\{project.build.directory</code>}
| - | The path of the file to be installed |
-| <code>jarName</code> | <code>$\{project.build.finalName}.jar</code>
| - | The name of the file to be installed |
-| <code>obr</code> | - | <code>obr</code> | The URL of the running
Sling instance to which the bundle is installed. Note that this parameter is required and
has no defualt value. It must always be specified in the configuration section or on the command
line. |</p>
+<p>The <code>deploy</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Default Value</th>
+<th>System Property Overwrite</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>skip</code></td>
+<td><code>false</code></td>
+<td><code>sling.deploy.skip</code></td>
+<td>Whether to skip this step even though it has been configured in the project to
be executed. The main use of this setting is preventing deployment of the bundle to a Sling
OSGi Bundle Repository server if it is known that there is none or if such an upload is not
required.</td>
+</tr>
+<tr>
+<td><code>buildDirectory</code></td>
+<td><code>$\{project.build.directory</code>}</td>
+<td>-</td>
+<td>The path of the file to be installed</td>
+</tr>
+<tr>
+<td><code>jarName</code></td>
+<td><code>$\{project.build.finalName}.jar</code></td>
+<td>-</td>
+<td>The name of the file to be installed</td>
+</tr>
+<tr>
+<td><code>obr</code></td>
+<td>-</td>
+<td><code>obr</code></td>
+<td>The URL of the running Sling instance to which the bundle is installed. Note that
this parameter is required and has no defualt value. It must always be specified in the configuration
section or on the command line.</td>
+</tr>
+</tbody>
+</table>
 <h2 id="the-deploy-file-goal">The <code>deploy-file</code> goal</h2>
 <p>The <code>deploy-file</code> goal is equivalent to the <code>deploy</code>
goal except, that the <code>deploy-file</code> does not require a project descriptor
file while the <code>deploy</code> goal does. In other words the <code>deploy-file</code>
goal may used to upload any bundle file available to a Sling OBR server instance.</p>
 <h3 id="use_1">Use</h3>
@@ -195,12 +225,32 @@
 
 <p>Specifying the bundle file to upload with the <code>sling.file</code>
property is required.</p>
 <h3 id="configuration_1">Configuration</h3>
-<p>The <code>deploy-file</code> supports similar configuration parameters
as the <code>deploy</code> goal with the exception of the <code>skip</code>
parameter which makes no sense. In addition, all parameters must be specified on the command
line by setting system properties. The <code>bundleFileName</code> parameter specified
as the <code>sling.file</code> system property as well as the <code>obr</code>
URL are required by the <code>deploy-file</code> goal.
-| Parameter | Default Value | System Property Overwrite | Description |
-|--|--|--|--|
-| <code>bundleFileName</code> | <code>$\{project.build.directory}/$\{project.build.finalName}.jar</code>
| <code>sling.file</code> | The path and name of the file to be installed |
-| <code>obr</code> | - | <code>obr</code> | The URL of the running
Sling instance to which the bundle is installed. Note that this parameter is required and
has no defualt value. It must always be specified in the configuration section or on the command
line. |
-Example: To deploy the bundle file <code>someBundle.jar</code> to the OBR running
at <code>[http://obr.sample.org](http://obr.sample.org)</code> you might use the
goal as follows:</p>
+<p>The <code>deploy-file</code> supports similar configuration parameters
as the <code>deploy</code> goal with the exception of the <code>skip</code>
parameter which makes no sense. In addition, all parameters must be specified on the command
line by setting system properties. The <code>bundleFileName</code> parameter specified
as the <code>sling.file</code> system property as well as the <code>obr</code>
URL are required by the <code>deploy-file</code> goal.</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Default Value</th>
+<th>System Property Overwrite</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>bundleFileName</code></td>
+<td><code>$\{project.build.directory}/$\{project.build.finalName}.jar</code></td>
+<td><code>sling.file</code></td>
+<td>The path and name of the file to be installed</td>
+</tr>
+<tr>
+<td><code>obr</code></td>
+<td>-</td>
+<td><code>obr</code></td>
+<td>The URL of the running Sling instance to which the bundle is installed. Note that
this parameter is required and has no defualt value. It must always be specified in the configuration
section or on the command line.</td>
+</tr>
+</tbody>
+</table>
+<p>Example: To deploy the bundle file <code>someBundle.jar</code> to the
OBR running at <code>[http://obr.sample.org](http://obr.sample.org)</code> you
might use the goal as follows:</p>
 <div class="codehilite"><pre>$ <span class="n">mvn</span> <span
class="n">org</span><span class="p">.</span><span class="n">apache</span><span
class="p">.</span><span class="n">sling</span><span class="p">:</span><span
class="n">maven</span><span class="o">-</span><span class="n">sling</span><span
class="o">-</span><span class="n">plugin</span><span class="p">:</span><span
class="n">deploy</span><span class="o">-</span><span class="n">file</span>
<span class="o">-</span><span class="n">Dsling</span><span class="p">.</span><span
class="n">file</span><span class="p">=</span><span class="n">someBundle</span><span
class="p">.</span><span class="n">jar</span> <span class="o">-</span><span
class="n">Dobr</span><span class="p">=</span><span class="n">http</span><span
class="p">:</span><span class="o">//</span><span class="n">obr</span><span
class="p">.</span><span class="n">sample</span><span class="p">.</span><span
class="n">org</span>
 </pre></div>
 
@@ -238,19 +288,74 @@ Example: To deploy the bundle file <code
 
 
 <h3 id="configuration_2">Configuration</h3>
-<p>The <code>install</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:
-| Parameter | Default Value | System Property Overwrite | Description |
-|--|--|--|--|
-| <code>skip</code> | <code>false</code> | <code>sling.install.skip</code>
| Whether to skip this step even though it has been configured in the project to be executed.
The main use of this setting is preventing installation of the bundle to a running Sling installation
if it is known that there is none or if such an upload is not required, for example when building
the bundle in an automated build system such as Confluence. |
-| <code>bundleFileName</code> | <code>$\{project.build.directory}/$\{project.build.finalName}.jar</code>
| <code>sling.file</code> | The path and name of the file to be installed |
-| <code>bundleStart</code> | <code>true</code> | <code>sling.bundle.start</code>
| Whether to start the bundle after installing it. If the bundle is just updated, this parameter
is ignored even if the bundle is currently stopped |
-| <code>bundleStartLevel</code> | <code>20</code> | <code>sling.bundle.startlevel</code>
| The start level to set on the installed bundle. If the bundle is already installed and therefore
is only updated this parameter is ignored. The parameter is also ignored if the running Sling
instance has no StartLevel service (which is unusual actually) |
-| <code>slingUrl</code> | <code>http{</code>}<code>://localhost:8080/sling</code>
| <code>sling.url</code> | The URL of the running Sling instance to which the
bundle is installed |
-| <code>user</code> | <code>admin</code> | <code>sling.user</code>
| The name of the user to authenticate as with the running Sling instance given by the <code>slingUrl</code>
parameter |
-| <code>password</code> | <code>admin</code> | <code>sling.password</code>
| The password of the user to authenticate as with the running Sling instance given by the
<code>slingUrl</code> parameter |</p>
-<p>| <code>usePut</code> | <code>false</code> | <code>sling.usePut</code>
| If a simple HTTP PUT should be used instead of the standard POST to the  felix console.
In the uninstall goal, a HTTP DELETE will be  used. |
-| <code>refreshPackages</code> | <code>true</code> | <code>sling.refreshPackages</code>
| Whether to refresh the packages after installing the uploaded bundle. If this property is
set to <code>true</code>, the <code>PackageAdmin.refreshPackages(Bundle\[\]())</code>
method is called after installing or updating the bundle. |
-{anchor:install-file}</p>
+<p>The <code>install</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Default Value</th>
+<th>System Property Overwrite</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>skip</code></td>
+<td><code>false</code></td>
+<td><code>sling.install.skip</code></td>
+<td>Whether to skip this step even though it has been configured in the project to
be executed. The main use of this setting is preventing installation of the bundle to a running
Sling installation if it is known that there is none or if such an upload is not required,
for example when building the bundle in an automated build system such as Confluence.</td>
+</tr>
+<tr>
+<td><code>bundleFileName</code></td>
+<td><code>$\{project.build.directory}/$\{project.build.finalName}.jar</code></td>
+<td><code>sling.file</code></td>
+<td>The path and name of the file to be installed</td>
+</tr>
+<tr>
+<td><code>bundleStart</code></td>
+<td><code>true</code></td>
+<td><code>sling.bundle.start</code></td>
+<td>Whether to start the bundle after installing it. If the bundle is just updated,
this parameter is ignored even if the bundle is currently stopped</td>
+</tr>
+<tr>
+<td><code>bundleStartLevel</code></td>
+<td><code>20</code></td>
+<td><code>sling.bundle.startlevel</code></td>
+<td>The start level to set on the installed bundle. If the bundle is already installed
and therefore is only updated this parameter is ignored. The parameter is also ignored if
the running Sling instance has no StartLevel service (which is unusual actually)</td>
+</tr>
+<tr>
+<td><code>slingUrl</code></td>
+<td><code>http{</code>}<code>://localhost:8080/sling</code></td>
+<td><code>sling.url</code></td>
+<td>The URL of the running Sling instance to which the bundle is installed</td>
+</tr>
+<tr>
+<td><code>user</code></td>
+<td><code>admin</code></td>
+<td><code>sling.user</code></td>
+<td>The name of the user to authenticate as with the running Sling instance given by
the <code>slingUrl</code> parameter</td>
+</tr>
+<tr>
+<td><code>password</code></td>
+<td><code>admin</code></td>
+<td><code>sling.password</code></td>
+<td>The password of the user to authenticate as with the running Sling instance given
by the <code>slingUrl</code> parameter</td>
+</tr>
+<tr>
+<td><code>usePut</code></td>
+<td><code>false</code></td>
+<td><code>sling.usePut</code></td>
+<td>If a simple HTTP PUT should be used instead of the standard POST to the  felix
console. In the uninstall goal, a HTTP DELETE will be  used.</td>
+</tr>
+<tr>
+<td><code>refreshPackages</code></td>
+<td><code>true</code></td>
+<td><code>sling.refreshPackages</code></td>
+<td>Whether to refresh the packages after installing the uploaded bundle. If this property
is set to <code>true</code>, the <code>PackageAdmin.refreshPackages(Bundle\[\]())</code>
method is called after installing or updating the bundle.</td>
+</tr>
+</tbody>
+</table>
+<p>{anchor:install-file}</p>
 <h2 id="the-install-file-goal">The <code>install-file</code> goal</h2>
 <p>The <code>install-file</code> goal is equivalent to the <code>install</code>
goal except, that the <code>install-file</code> does not require a project descriptor
file while the <code>install</code> goal does. In other words the <code>install-file</code>
goal may used to upload any bundle file available to a running Sling instance.</p>
 <h3 id="use_3">Use</h3>
@@ -302,15 +407,50 @@ Example: To deploy the bundle file <code
 
 
 <h3 id="configuration_4">Configuration</h3>
-<p>The <code>uninstall</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:
-| Parameter | Default Value | System Property Overwrite | Description |
-|--|--|--|--|
-| <code>bundleFileName</code> | <code>$\{project.build.directory}/$\{project.build.finalName}.jar</code>
| <code>sling.file</code> | The path and name of the file to be uninstalled |
-| <code>slingUrl</code> | <code>http{</code>}<code>://localhost:8080/sling</code>
| <code>sling.url</code> | The URL of the running Sling instance to which the
bundle should be uninstalled |
-| <code>user</code> | <code>admin</code> | <code>sling.user</code>
| The name of the user to authenticate as with the running Sling instance given by the <code>slingUrl</code>
parameter |
-| <code>password</code> | <code>admin</code> | <code>sling.password</code>
| The password of the user to authenticate as with the running Sling instance given by the
<code>slingUrl</code> parameter |
-| <code>usePut</code> | <code>false</code> | <code>sling.usePut</code>
| In the uninstall goal, a HTTP DELETE will be used. |
-{anchor:validate}</p>
+<p>The <code>uninstall</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Default Value</th>
+<th>System Property Overwrite</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>bundleFileName</code></td>
+<td><code>$\{project.build.directory}/$\{project.build.finalName}.jar</code></td>
+<td><code>sling.file</code></td>
+<td>The path and name of the file to be uninstalled</td>
+</tr>
+<tr>
+<td><code>slingUrl</code></td>
+<td><code>http{</code>}<code>://localhost:8080/sling</code></td>
+<td><code>sling.url</code></td>
+<td>The URL of the running Sling instance to which the bundle should be uninstalled</td>
+</tr>
+<tr>
+<td><code>user</code></td>
+<td><code>admin</code></td>
+<td><code>sling.user</code></td>
+<td>The name of the user to authenticate as with the running Sling instance given by
the <code>slingUrl</code> parameter</td>
+</tr>
+<tr>
+<td><code>password</code></td>
+<td><code>admin</code></td>
+<td><code>sling.password</code></td>
+<td>The password of the user to authenticate as with the running Sling instance given
by the <code>slingUrl</code> parameter</td>
+</tr>
+<tr>
+<td><code>usePut</code></td>
+<td><code>false</code></td>
+<td><code>sling.usePut</code></td>
+<td>In the uninstall goal, a HTTP DELETE will be used.</td>
+</tr>
+</tbody>
+</table>
+<p>{anchor:validate}</p>
 <h2 id="the-validate-goal">The <code>validate</code> goal</h2>
 <p>The <code>validate</code> goal checks the JSON code of a bundle.</p>
 <h3 id="use_5">Use</h3>
@@ -344,13 +484,33 @@ Example: To deploy the bundle file <code
 
 
 <h3 id="configuration_5">Configuration</h3>
-<p>The <code>validate</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:
-| Parameter | Default Value | System Property Overwrite | Description |
-|--|--|--|--|
-| <code>skip</code> | <code>false</code> | <code>sling.validation.skip</code>
| Whether to skip the validation |
-| <code>skipJson</code> | <code>false</code> | <code>sling.validation.skipJson</code>
| Whether to skip the JSON validation. At the time, there's no difference between <code>skip</code>
and <code>skipJson</code> because only JSON files will be validated by now. |</p>
+<p>The <code>validate</code> goal may be configured in the <code>&lt;configuration&gt;</code>
element using the following properties:</p>
+<table>
+<thead>
+<tr>
+<th>Parameter</th>
+<th>Default Value</th>
+<th>System Property Overwrite</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>skip</code></td>
+<td><code>false</code></td>
+<td><code>sling.validation.skip</code></td>
+<td>Whether to skip the validation</td>
+</tr>
+<tr>
+<td><code>skipJson</code></td>
+<td><code>false</code></td>
+<td><code>sling.validation.skipJson</code></td>
+<td>Whether to skip the JSON validation. At the time, there's no difference between
<code>skip</code> and <code>skipJson</code> because only JSON files
will be validated by now.</td>
+</tr>
+</tbody>
+</table>
       <div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
-        Rev. 1499238 by fmeschbe on Wed, 3 Jul 2013 07:39:54 +0000
+        Rev. 1550770 by rombert on Fri, 13 Dec 2013 16:57:03 +0000
       </div>
       <div class="trademarkFooter"> 
         Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project



Mime
View raw message