sling.html

buildbot Thu, 25 Feb 2016 06:24:34 -0800

Author: buildbot
Date: Thu Feb 25 14:24:10 2016
New Revision: 981140

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 Thu Feb 25 14:24:10 2016
@@ -1 +1 @@
-1732300
+1732310

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 
Thu Feb 25 14:24:10 2016
@@ -101,11 +101,6 @@ h2:hover > .headerlink, h3:hover > .head
       </div>
 
       
-      <div class="tip">
-           This page is a translated version of <a href="/site/sling.html" 
target="sling_cwiki">/site/sling.html</a>. In case of
-           doubt you might want to refer to the old page.
-      </div>
-      
       
       <h1>Maven Sling Plugin</h1>
       <style type="text/css">
@@ -119,7 +114,7 @@ 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>
-<p>The Maven Sling Plugin provides a number of goals which may be of help 
while developping bundles for Sling. To run the plugin you need at least Maven 
2.x and JDK 1.5 or higher. Maven Sling Plugin provides the following goals:</p>
+<p>The Maven Sling Plugin provides a number of goals which may be of help 
while developping bundles for Sling. To run the plugin you need at least Maven 
3.x and JDK 1.6 or higher. Maven Sling Plugin provides the following goals:</p>
 <table class="table">
 <thead>
 <tr>
@@ -130,15 +125,15 @@ h2:hover > .headerlink, h3:hover > .head
 <tbody>
 <tr>
 <td><a href="#the-deploy-goal">sling:deploy</a></td>
-<td>Deploy a OSGi-bundle into a running Sling instance.</td>
+<td>Deploy an OSGi-bundle into the OBR running on a Sling instance.</td>
 </tr>
 <tr>
 <td><a href="#the-deploy-file-goal">sling:deploy-file</a></td>
-<td>Deploy a OSGi-bundle into a running Sling instance without requiring a 
project descriptor file.</td>
+<td>Deploy an OSGi-bundle into the OBR running on a Sling instance without 
requiring a project descriptor file.</td>
 </tr>
 <tr>
 <td><a href="#the-install-file-goal">sling:install-file</a></td>
-<td>Install a OSGi-bundle into a running Sling instance without requiring a 
project descriptor file.</td>
+<td>Install an OSGi-bundle into a running Sling instance without requiring a 
project descriptor file.</td>
 </tr>
 </tbody>
 </table>
@@ -153,7 +148,7 @@ h2:hover > .headerlink, h3:hover > .head
         <span class="nt">&lt;plugin&gt;</span>
           <span class="nt">&lt;groupId&gt;</span>org.apache.sling<span 
class="nt">&lt;/groupId&gt;</span>
           <span class="nt">&lt;artifactId&gt;</span>maven-sling-plugin<span 
class="nt">&lt;/artifactId&gt;</span>
-          <span class="nt">&lt;version&gt;</span>2.0.5-SNAPSHOT<span 
class="nt">&lt;/version&gt;</span>
+          <span class="nt">&lt;version&gt;</span>2.1.6<span 
class="nt">&lt;/version&gt;</span>
         <span class="nt">&lt;/plugin&gt;</span>
         ...
       <span class="nt">&lt;/plugins&gt;</span>
@@ -163,7 +158,6 @@ h2:hover > .headerlink, h3:hover > .head
       <span class="nt">&lt;plugin&gt;</span>
         <span class="nt">&lt;groupId&gt;</span>org.apache.sling<span 
class="nt">&lt;/groupId&gt;</span>
         <span class="nt">&lt;artifactId&gt;</span>maven-sling-plugin<span 
class="nt">&lt;/artifactId&gt;</span>
-        <span class="nt">&lt;version&gt;</span>2.0.5-SNAPSHOT<span 
class="nt">&lt;/version&gt;</span>
       <span class="nt">&lt;/plugin&gt;</span>
       ...
     <span class="nt">&lt;/plugins&gt;</span>
@@ -226,13 +220,13 @@ h2:hover > .headerlink, h3:hover > .head
 </tr>
 <tr>
 <td><code>buildDirectory</code></td>
-<td><code>$\{project.build.directory</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><code>${project.build.finalName}.jar</code></td>
 <td>-</td>
 <td>The name of the file to be installed</td>
 </tr>
@@ -240,7 +234,7 @@ h2:hover > .headerlink, h3:hover > .head
 <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>
+<td>The URL of the running Sling instance to which the bundle is installed. 
Note that this parameter is required and has no default value. It must always 
be specified in the configuration section or on the command line.</td>
 </tr>
 </tbody>
 </table>
@@ -267,7 +261,7 @@ h2:hover > .headerlink, h3:hover > .head
 <tbody>
 <tr>
 <td><code>bundleFileName</code></td>
-<td><code>$\{project.build.directory}/$\{project.build.finalName}.jar</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>
@@ -285,7 +279,7 @@ h2:hover > .headerlink, h3:hover > .head
 
 
 <h2 id="the-install-goal">The <code>install</code> goal<a class="headerlink" 
href="#the-install-goal" title="Permanent link">&para;</a></h2>
-<p>The <code>install</code> goal uploads a bundle to a running sling instance, 
which may be located on a remote system. The plugin places an HTTP 
<code>POST</code> request to the sling instance sending the bundle file 
together with flags indicating whether to start the bundle and what start level 
to assign the bundle. It's also possible to HTTP <code>PUT</code> instead of 
<code>POST</code> for WebDAV.</p>
+<p>The <code>install</code> goal uploads a bundle to a running sling instance, 
which may be located on a remote system. The plugin places an HTTP 
<code>POST</code> request to <a 
href="http://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests";>Felix
 Web Console</a>. It's also possible to HTTP <code>PUT</code> instead of 
<code>POST</code> leveraging the <a 
href="/documentation/development/repository-based-development.html">WebDAV 
bundle from Sling</a>. Since version 2.1.8 you can also leverage the Sling POST 
servlet for that.</p>
 <h3 id="use_2">Use<a class="headerlink" href="#use_2" title="Permanent 
link">&para;</a></h3>
 <p>To use the <code>install</code> goal of the Maven Sling Plugin define the 
following elements in the <code>&lt;plugins&gt;</code> section of the POM:</p>
 <div class="codehilite"><pre><span class="cp">&lt;?xml version=&quot;1.0&quot; 
encoding=&quot;ISO-8859-1&quot;?&gt;</span>
@@ -336,7 +330,7 @@ h2:hover > .headerlink, h3:hover > .head
 </tr>
 <tr>
 <td><code>bundleFileName</code></td>
-<td><code>$\{project.build.directory}/$\{project.build.finalName}.jar</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>
@@ -354,7 +348,7 @@ h2:hover > .headerlink, h3:hover > .head
 </tr>
 <tr>
 <td><code>slingUrl</code></td>
-<td><code>http{</code>}<code>://localhost:8080/sling</code></td>
+<td><code>http://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>
@@ -371,20 +365,25 @@ h2:hover > .headerlink, h3:hover > .head
 <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>deploymentMethod</code></td>
+<td><code>WebConsole</code></td>
+<td><code>sling.deploy.method</code></td>
+<td>Only available since version 2.1.8 (see also <a 
href="https://issues.apache.org/jira/browse/SLING-5335";>SLING-5335</a>). 
<br>Allowed values:<br><strong>WebConsole</strong>, uses the <a 
href="http://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests";>Felix
 Web Console REST API</a> for deployment (HTTP POST). This is the default. Make 
sure that <code>slingUrl</code> points to the Felix Web Console in that 
case.<br><strong>WebDAV</strong>, uses <a 
href="/documentation/development/repository-based-development.html">WebDAV</a> 
for deployment (HTTP PUT). Make sure that <code>slingUrl</code> points to the 
entry path of the Sling WebDAV bundle (usually below regular Sling root URL). 
Issues an HTTP Delete for the uninstall 
goal.<br><strong>SlingPostServlet</strong>, uses the <a 
href="/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Sling
 Post Servlet</a> for deployment (HTTP POST). Make sure t
 hat <code>slingUrl</code> points a path which is handled by the Sling POST 
Servlet (usually below regular Sling root URL).</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>
+<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. Deprecated 
since version 2.1.8 (see also <a 
href="https://issues.apache.org/jira/browse/SLING-5335";>SLING-5335</a>). Use 
<code>deploymentMethod=WebDAV</code> instead.</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>
+<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<a 
class="headerlink" href="#the-install-file-goal" title="Permanent 
link">&para;</a></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<a class="headerlink" href="#use_3" title="Permanent 
link">&para;</a></h3>
@@ -402,7 +401,6 @@ h2:hover > .headerlink, h3:hover > .head
 </pre></div>
 
 
-<p>{anchor:uninstall}</p>
 <h2 id="the-uninstall-goal">The <code>uninstall</code> goal<a 
class="headerlink" href="#the-uninstall-goal" title="Permanent 
link">&para;</a></h2>
 <p>The <code>uninstall</code> goal uninstalls a bundle from a running sling 
instance, which may be located on a remote system. The plugin uninstalles a 
bundle via a HTTP <code>POST{</code>}request. It's also possible to use HTTP 
<code>DELETE</code> instead of <code>POST</code> for WebDAV.</p>
 <h3 id="use_4">Use<a class="headerlink" href="#use_4" title="Permanent 
link">&para;</a></h3>
@@ -449,15 +447,15 @@ h2:hover > .headerlink, h3:hover > .head
 <tbody>
 <tr>
 <td><code>bundleFileName</code></td>
-<td><code>$\{project.build.directory}/$\{project.build.finalName}.jar</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>http://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>
+<td>The URL of the running Sling instance on which the bundle should be 
uninstalled</td>
 </tr>
 <tr>
 <td><code>user</code></td>
@@ -472,14 +470,19 @@ h2:hover > .headerlink, h3:hover > .head
 <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>deploymentMethod</code></td>
+<td><code>WebConsole</code></td>
+<td><code>sling.deploy.method</code></td>
+<td>Only available since version 2.1.8 (see also <a 
href="https://issues.apache.org/jira/browse/SLING-5335";>SLING-5335</a>). 
<br>Allowed values:<br><strong>WebConsole</strong>, uses the <a 
href="http://felix.apache.org/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html#post-requests";>Felix
 Web Console REST API</a> for deployment (HTTP POST). This is the default. Make 
sure that <code>slingUrl</code> points to the Felix Web Console in that 
case.<br><strong>WebDAV</strong>, uses <a 
href="/documentation/development/repository-based-development.html">WebDAV</a> 
for deployment (HTTP PUT). Make sure that <code>slingUrl</code> points to the 
entry path of the Sling WebDAV bundle (usually below regular Sling root URL). 
Issues an HTTP Delete for the uninstall 
goal.<br><strong>SlingPostServlet</strong>, uses the <a 
href="/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html">Sling
 Post Servlet</a> for deployment (HTTP POST). Make sure t
 hat <code>slingUrl</code> points a path which is handled by the Sling POST 
Servlet (usually below regular Sling root URL).</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>
+<td>If a simple HTTP PUT should be used instead of the standard POST to the  
felix console. In the uninstall goal, an HTTP DELETE will be used. Deprecated 
since version 2.1.8 (see also <a 
href="https://issues.apache.org/jira/browse/SLING-5335";>SLING-5335</a>). Use 
<code>deploymentMethod=WebDAV</code> instead.</td>
 </tr>
 </tbody>
 </table>
-<p>{anchor:validate}</p>
 <h2 id="the-validate-goal">The <code>validate</code> goal<a class="headerlink" 
href="#the-validate-goal" title="Permanent link">&para;</a></h2>
 <p>The <code>validate</code> goal checks the JSON code of a bundle.</p>
 <h3 id="use_5">Use<a class="headerlink" href="#use_5" title="Permanent 
link">&para;</a></h3>
@@ -539,7 +542,7 @@ h2:hover > .headerlink, h3:hover > .head
 </tbody>
 </table>
       <div class="timestamp" style="margin-top: 30px; font-size: 80%; 
text-align: right;">
-        Rev. 1550770 by rombert on Fri, 13 Dec 2013 16:57:03 +0000
+        Rev. 1732310 by kwin on Thu, 25 Feb 2016 14:23:57 +0000
       </div>
       <div class="trademarkFooter"> 
         Apache Sling, Sling, Apache, the Apache feather logo, and the Apache 
Sling project

svn commit: r981140 - in /websites/staging/sling/trunk/content: ./ documentation/development/sling.html

Reply via email to