Author: donsez
Date: Thu Apr 3 01:09:19 2008
New Revision: 644212
URL: http://svn.apache.org/viewvc?rev=644212&view=rev
Log:
update the documentation
Modified:
felix/sandbox/donsez/wireadmin.sample.consumerservlet/src/site/readme.html
Modified:
felix/sandbox/donsez/wireadmin.sample.consumerservlet/src/site/readme.html
URL:
http://svn.apache.org/viewvc/felix/sandbox/donsez/wireadmin.sample.consumerservlet/src/site/readme.html?rev=644212&r1=644211&r2=644212&view=diff
==============================================================================
--- felix/sandbox/donsez/wireadmin.sample.consumerservlet/src/site/readme.html
(original)
+++ felix/sandbox/donsez/wireadmin.sample.consumerservlet/src/site/readme.html
Thu Apr 3 01:09:19 2008
@@ -1,21 +1,21 @@
<html>
<head>
-<title>Consumer Servlet</title>
+<title>Apache Felix Consumer Servlet (sandbox)</title>
</head>
<body>
<!-- Start of Felix Bundle Documentation -->
<hr width="100%" size="2">
-<h1><i><a name="consumerservlet"></a><font
color="#0000aa">consumerservlet.jar</font></i></h1>
+<h1><i><a
name="org.apache.felix.sandbox.wireadmin.sample.consumerservlet"></a><font
color="#0000aa">Apache Felix Consumer Servlet (sandbox)</font></i></h1>
<p>
<b>Description</b><br>
-This bundle provides a org.osgi.service.wireadmin.Consumer to illustrate
WireAdmin services (@see chapter 16 in OSGi specification release 3). It
updates regulary java.lang.String objects on connected wires<br>
+This bundle provides a org.osgi.service.wireadmin.Consumer to illustrate
WireAdmin services (@see chapter 16 in OSGi specification release 3) and Apache
Felix WireAdminBinder. It updates regulary objects on connected wires<br>
</p>
<p>
<b>Authors/Contributors</b><br>
-<a href="mailto:[EMAIL PROTECTED]">Felix Project Team</a>
+<a href="mailto:[EMAIL PROTECTED]">Felix Project Team</a>
</p>
<p>
@@ -44,7 +44,6 @@
<li>org.osgi.service.http</li>
<li>javax.servlet</li>
<li>javax.servlet.http</li>
-<li>org.apache.felix.scr</li>
</ul>
</p>
@@ -54,56 +53,14 @@
<!-- Start of extra information -->
-<p id="download">
-<b>Download</b><br>
-<ul>
-<li><a
href='http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/consumerservlet/consumerservlet.jar'>Bundle
binaries</a></li>
-<li><a
href='http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/consumerservlet/consumerservlet-src.jar'>Bundle
sources</a></li>
-<li><a
href='http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/consumerservlet/readme.html'>The
latest version of this documentation</a></li>
-<li><a
href='http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/consumerservlet/obr.txt'>The
OBR descriptor (text format)</a></li>
-</ul>
-</p>
<p id="build">
<b>Build</b><br>
<ol>
-<li>configure the build properties in build.xml</li>
-<li>then build with ant</li>
+<li>build with maven2 <code>mvn clean install</code></li>
</ol>
</p>
-<p id="usage">
-<b>Usage</b><br>
-install and start the dependencies<br>
-<pre>
-obr start "HTTP Service"
-obr start "Service Component Runtime"
-obr start "Service Component Runtime"
-start
http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/osgi3spec/osgi3spec.jar
-start
http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/consumerservlet/consumerservlet.jar
-</pre>
-OK, now you can check available producers and create wires between the servlet
and them
-<pre>
-start
http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/wireadmincmd/wireadmincmd.jar
-start
http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/wireadmin/wireadmin.jar
-wa
-wa -lp
-wa -lc
-</pre>
-Create wires between the servlet and them
-<pre>
-start
http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/dateproducer/dateproducer.jar
-wa -c fr.imag.adele.osgi.util.clock fr.imag.adele.osgi.util.consumerservlet
-wa -w
-</pre>
-<br>Those commands create the following architecture:
-<center><img alt="Wire Admin application architecture"
src="wasample.png"></center>
-Then browse this URL <a
href="http://localhost/wa/poll?css=style.css&refresh=20";>http://localhost/wa/poll?css=style.css</a>
-<br>You should see the following document:
-<center><img alt="Wire Admin Customer Servlet snapshop" src="wa.jpg"></center>
-<br>For a more complex demo, follows the instruction of the <a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/webcamproducer/readme.html#rundemo";>WebCam
Producer demo</a>
-</p>
-
<p>
<b>Servlet parameters</b><br>
<ul>
@@ -117,7 +74,8 @@
<p id="gateways">
<b>Tested gateways</b><br>
<ul>
-<li><a href="http://incubator.apache.org/felix";>Felix</a></li>
+<li>Apache Felix (done)</li>
+<li>ObjectWeb Oscar (to do)</li>
</ul>
</p>
@@ -125,26 +83,12 @@
<b>TODO (contributions are welcome)</b><br>
<ul>
<li>use table inside item lists</li>
-<li>automate wire creations/deletions between this servlet and the registered
producers (with <a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/wireadminbinder/readme.html";>WireAdminBinder</a>)</li>
+<li>DONE: automate wire creations/deletions between this servlet and the
registered producers (with Apache Felix WireAdminBinder)</li>
<li>support MIME types : text/xml (TODO), application/x-shockwave-flash
(TODO), text/vnd.wap.wml (TODO), text/csv(TODO (ie Column Separated Values)),
text/plain(TODO)</li>
<li>customizable bounds in applets and histories</li>
<li>color range in applets and histories according to values</li>
<li>use Flash to display gauge and histograms</li>
<li>use AJAX for refreshing (<a
href="https://blueprints.dev.java.net/ajax-faq.html";>https://blueprints.dev.java.net/ajax-faq.html</a>)</li>
-</ul>
-</p>
-
-<p id="links">
-<b>Links</b><br>
-<ul>
-<li><a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/wireadmin/readme.html";>My
Wire Admin Implementation</a></li>
-<li><a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/wireadmincmd/readme.html";>The
OSCAR shell command for the wire admin</a></li>
-<li><a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/wireadminbinder/readme.html";>The
WireAdminBinder</a></li>
-<li><a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/dateproducer/readme.html";>A
simple Date Producer</a></li>
-<li><a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/webcamproducer/readme.html";>A
WebCam Producer (requires a USB WebCam !)</a></li>
-<li><a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/onewireproducer/readme.html";>A
OneWire Producer (requires iButtons !)</a></li>
-<li><a
href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/gpspositionproducer/readme.html";>A
GPS Position Producer (requires a serial GPS/NMEA0183 receiver !)</a></li>
-<li><a href="http://www-adele.imag.fr/users/Didier.Donsez/dev/osgi/";>My Bundle
Farm</a></li>
</ul>
</p>
