You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by bu...@apache.org on 2013/01/29 16:15:51 UTC
svn commit: r848428 - in /websites/staging/felix/trunk/content: ./
documentation/subprojects/apache-felix-web-console/web-console-restful-api.html
Author: buildbot
Date: Tue Jan 29 15:15:50 2013
New Revision: 848428
Log:
Staging update by buildbot for felix
Modified:
websites/staging/felix/trunk/content/ (props changed)
websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html
Propchange: websites/staging/felix/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jan 29 15:15:50 2013
@@ -1 +1 @@
-1439919
+1439922
Modified: websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html
==============================================================================
--- websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html (original)
+++ websites/staging/felix/trunk/content/documentation/subprojects/apache-felix-web-console/web-console-restful-api.html Tue Jan 29 15:15:50 2013
@@ -110,16 +110,12 @@ Please note that the APIs described on t
<h3 id="urls">URLs</h3>
<dl>
<dt><code>.../bundles</code></dt>
-<dd>
-<dl>
-<dt>addresses all bundles in the framework</dt>
+<dd>addresses all bundles in the framework</dd>
<dt><code>.../bundles/*id*</code></dt>
<dd>addresses a single bundle in the framework. The <code>*id*</code> can in this case be the bundle's ID
(as per <code>Bundle.getBundleId()</code>), the bundle's symbolic name (which actually may
cause multiple bundles to be addressed), or the bundle's symbolic name and version separated by a colon. Examples are <code>.../bundles/0</code>, <code>.../bundles/org.apache.felix.webconsole</code>, and <code>.../bundles/org.apache.felix.webconsole:3.1.4</code>.</dd>
</dl>
-</dd>
-</dl>
<h3 id="get-requests">GET Requests</h3>
<p>GET requests are used to retrieve information on the bundles (or bundle) available in the framework. To response formats are currently supported: regular HTML and JSON if requests are sent with the <code>.json</code> extension; e.g. <code>.../bundles/0.json</code>. The HTML response is destined at browsers and is not further described here.</p>
<h4 id="get-bundlesjson">GET .../bundles.json</h4>
@@ -321,73 +317,49 @@ Due to a bug <a href="https://issues.apa
<h3 id="post-requests">POST Requests</h3>
-<p>To update the bundles the <code>action</code> request method is used to indicate the action:</p>
-<table>
-<thead>
-<tr>
-<th>Action</th>
-<th>Requires a Bundle</th>
-<th>Description</th>
-</tr>
-</thead>
-<tbody>
-<tr>
-<td><code>refreshPackages</code></td>
-<td>no</td>
-<td>Calls <code>PackageAdmin.refreshPackages(Bundle[]())</code> with a <code>null</code> argument -- refreshing all pending bundles</td>
-</tr>
-<tr>
-<td><code>install</code></td>
-<td>no</td>
-<td>Installs (or updates) and optionally starts one or more bundles. Parameters:</td>
-</tr>
-<tr>
-<td>* <code>bundlestart</code> -- whether to start newly installed bundles or not. Has no influence on updated bundles.</td>
-<td></td>
-<td></td>
-</tr>
-<tr>
-<td>* <code>bundlestartlevel</code> -- the start level to set on newly installed bundles. Has no influence on updated bundles.</td>
-<td></td>
-<td></td>
-</tr>
-<tr>
-<td>* <code>bundlefile</code> -- one or more uploaded files being the bundles to install or update. The manifests in the bundles are inspected to see whether any bundle is an update or new install.</td>
-<td></td>
-<td></td>
-</tr>
-<tr>
-<td>* <code>refreshPackages</code> -- whether to call <code>PackageAdmin.refreshPackages(Bundle[]())</code> with the installed/updated bundles after installation/update.</td>
-<td></td>
-<td></td>
-</tr>
-<tr>
-<td><code>start</code></td>
-<td>yes</td>
-<td>Starts the bundle</td>
-</tr>
-<tr>
-<td><code>stop</code></td>
-<td>yes</td>
-<td>Stops the bundle</td>
-</tr>
-<tr>
-<td><code>refresh</code></td>
-<td>yes</td>
-<td>Calls <code>PackageAdmin.refreshPackages(Bundle[]())</code> with the bundle as its sole argument thus forcing the bundle to be rewired.</td>
-</tr>
-<tr>
-<td><code>update</code></td>
-<td>yes</td>
-<td>Calls <code>Bundle.update()</code> on the bundle or tries to update the bundle through the OBR.</td>
-</tr>
-<tr>
-<td><code>uninstall</code></td>
-<td>yes</td>
-<td>Calls <code>Bundle.uninstall()</code> on the bundle.</td>
-</tr>
-</tbody>
-</table>
+<p>To update the bundles the <code>action</code> request parameter is used to indicate the action:</p>
+<p>| Action | Requires a Bundle | Description |
+|--|--|--|</p>
+<dl>
+<dt><code>refreshPackages</code></dt>
+<dd>Calls <code>PackageAdmin.refreshPackages(Bundle[]())</code> with a <code>null</code>
+argument -- refreshing all pending bundles. This action does not require a bundle
+in the URL and just ignores if one is provided.</dd>
+<dt><code>install</code></dt>
+<dd>
+<p>Installs (or updates) and optionally starts one or more bundles. Parameters:</p>
+<ul>
+<li><code>bundlestart</code> -- whether to start newly installed bundles or not. Has no influence on updated bundles.</li>
+<li><code>bundlestartlevel</code> -- the start level to set on newly installed bundles. Has no influence on updated bundles.</li>
+<li><code>bundlefile</code> -- one or more uploaded files being the bundles to install or update. The manifests in the bundles are inspected to see whether any bundle is an update or new install.</li>
+<li><code>refreshPackages</code> -- whether to call <code>PackageAdmin.refreshPackages(Bundle[]())</code> with the installed/updated bundles after installation/update.</li>
+</ul>
+</dd>
+<dt><code>start</code></dt>
+<dd>
+<p>Starts the bundle addressed by the request URL.</p>
+</dd>
+<dt><code>stop</code></dt>
+<dd>
+<p>Stops the bundle addressed by the request URL.</p>
+</dd>
+<dt><code>refresh</code></dt>
+<dd>
+<p>Calls <code>PackageAdmin.refreshPackages(Bundle[]())</code> with the
+bundle as its sole argument thus forcing the bundle to be rewired. The bundle
+is required to be addressed by the request URL.</p>
+</dd>
+<dt><code>update</code></dt>
+<dd>
+<p>Calls <code>Bundle.update()</code> on the bundle addressed by the request URL or tries
+to update the bundle through the OBR.</p>
+</dd>
+<dt><code>uninstall</code></dt>
+<dd>
+<p>Calls <code>Bundle.uninstall()</code> on the bundle addressed by the request URL. After the
+installation the framework must be refreshed (see <code>refreshPackages</code> above).</p>
+</dd>
+</dl>
<p>The response on those actions requiring a bundle is a simple JSON response:</p>
<div class="codehilite"><pre><span class="p">{</span>
<span class="s">"fragment"</span><span class="p">:</span> <span class="o">--</span> <span class="n">whether</span> <span class="n">the</span> <span class="n">bundle</span> <span class="n">is</span> <span class="n">a</span> <span class="n">fragement</span>
@@ -403,7 +375,7 @@ Due to a bug <a href="https://issues.apa
<h2 id="configuration-admin-plugin">Configuration Admin Plugin</h2>
<p>TBD</p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1439919 by fmeschbe on Tue, 29 Jan 2013 15:07:50 +0000
+ Rev. 1439922 by fmeschbe on Tue, 29 Jan 2013 15:15:43 +0000
</div>
<div class="trademarkFooter">
Apache Felix, Felix, Apache, the Apache feather logo, and the Apache Felix project