Author: donsez
Date: Tue Apr 1 05:48:09 2008
New Revision: 643381
URL: http://svn.apache.org/viewvc?rev=643381&view=rev
Log:
complete the documentation
Added:
felix/sandbox/donsez/wireadminbinder/src/site/wab2c.xml (with props)
Modified:
felix/sandbox/donsez/wireadminbinder/src/site/readme.html
Modified: felix/sandbox/donsez/wireadminbinder/src/site/readme.html
URL:
http://svn.apache.org/viewvc/felix/sandbox/donsez/wireadminbinder/src/site/readme.html?rev=643381&r1=643380&r2=643381&view=diff
==============================================================================
--- felix/sandbox/donsez/wireadminbinder/src/site/readme.html (original)
+++ felix/sandbox/donsez/wireadminbinder/src/site/readme.html Tue Apr 1
05:48:09 2008
@@ -11,7 +11,34 @@
<p>
<b>Description</b><br>
automates the creation and deletion of wires between producers and consumers
-<br>For more details on how to use this bundle, refer to the /doc/readme.html
file embedded in the bundle jarfile.<br>
+<br><br>
+<font size="-1"><i>
+The OSGi WireAdmin service supports the
+construction of dynamic sensor-based applications. However, it has
+several limitations. The first one is that wires are inextricably
+tied to specific consumers and producers via persistent and
+unique identifiers. The second one is that modifications of the
+topology must be realized programmatically. As a result, there
+is no explicit representation of the architecture, for it is hidden
+inside the code responsible for creating or destroying the wires.
+<br><br>
+The declarative description language for dynamic-sensor
+based applications (WADL) is based on two main
+requirements. First, it must allow producers and consumers to
+be introduced and removed at run-time. Second, it must support
+the binding of producers and consumers which may not have
+been available at the time the composition was described.
+<br><br>
+The WireAdminBinder is the engine that interprets WADL
+descriptors. It is implemented on top of the OSGi framework
+and delivered in a separate bundle. It relies on the WireAdmin
+Service to create persistent wires between consumers and
+producers according to the filters described in the wiresets. As
+producers and consumers are deployed or removed to/from the
+execution platform, the WireAdminBinder is notified and
+reacts by creating or removing wires according to the policies
+defined in the descriptor.
+</i></font>
</p>
<p>
@@ -63,13 +90,13 @@
<br> The bundle' manifest should contains this entry.
<pre>
-WireAdminBinder-Metadata: /WAB-INF/wireadminbinder.xml
+WireAdminBinder-Metadata: /WAB-INF/wab.xml
</pre>
</p>
<script language="JavaScript">
function openOnTheFly() {
- myWin= open("wireadminbinder.dtd", "DTD for WireAdminBinder",
"status=yes,toolbar=yes,menubar=yes");
+ myWin= open("wireapp.dtd", "DTD for WireAdminBinder ADL",
"status=yes,toolbar=yes,menubar=yes");
myWin.document.open("text/plain");
myWin.document.close();
}
@@ -77,8 +104,9 @@
<p id="metadata">
<b>Metadata Settings</b><br>
-<!--have a look on the <a
href="javascript:openOnTheFly()">wireadminbinder.dtd</a> file -->
-have a look on the <a href="wireadminbinder.dtd">wireadminbinder.dtd</a> file
+<!--have a look on the <a href="javascript:openOnTheFly()">wireapp.dtd</a>
file -->
+have a look on the DTD for WireAdminBinder ADL (<a
href="wireapp.dtd">wireapp.dtd</a>)
+and some examples <a href="wab1a.xml">wab1a.xml</a>, <a
href="wab1b.xml">wab1b.xml</a>, <a href="wab2a.xml">wab2a.xml</a>, <a
href="wab3.xml">wab3.xml</a>, ...
</p>
<p id="rundemo">
@@ -88,16 +116,20 @@
<p id="typicalusage">
<b>Typical Usages</b><br>
-WireAdminBinder' BaseActivator could be embedded inside others bundles
-(that provide consumer services, producer services or none)<br>
-<a href='dev/osgi/wireadminbinderdemo/readme.html'>A simple demonstrator of
WireAdminBinder</a> gives an example of the usage.
+<ul>
+<li>WireAdminBinder wired application can be build with the <a
href="../../../wireadminbinder.cmd">Apache Felix WireAdminBinder Command</a>
+</li>
+<li>WireAdminBinder' BaseActivator could be embedded inside others bundles
+(that provide consumer services, producer services or none) see the bundle <a
href="../../../wireadmin.sample.consumerservlet">Apache Felix Consumer
Servlet</a> and the <a href="../../../wireadminbinder.cmd">Apache Felix
WireAdminBinder Command</a>.<br>
+</li>
+<li>WireAdminBinder wired application could be build (soon) according to the
extender model.</li>
+</ul>
</p>
<p id="platforms">
<b>Tested OSGi platforms</b><br>
<ul>
-<li>Felix (done)</li>
-<li><a href="http://oscar.objectweb.org/";>Oscar</a> (done)</li>
+<li>Objectweb/OW2 Oscar (done)</li>
<li>Apache Felix (done)</li>
<li>Equinox (to do)</li>
</ul>
@@ -123,6 +155,7 @@
<p id="todo">
<b>TODO (contributions are welcome)</b><br>
<ul>
+<li>2008-03-26: adapt the WAB Eclipse plugin to the new metadata
DTD/schema</li>
<li>2008-01-12: add a extended model to start and stop wired applications
described in other bundles manifest</li>
<li>2007-12-19: add consumersFilter and producersFilter elements to set LDAP
filters in CDATA section</li>
<li>2007-12-19 (DONE 2008-03-23): add consumerPid and producerPid attributes
in wireset elements to simplify PID setting</li>
@@ -135,7 +168,7 @@
<b>Links</b><br>
<ul>
<li>WireAdminBinder was presented at CCNC08:
-Humberto Cervantes, Didier Donsez, Lionel Touseau, "An Architecture
Description Language for Dynamic Sensor-Based Applications", 5th IEEE Consumer
Communications and Networking Conference (CCNC) 2008,
http://www.ieee-ccnc.org/</li>
+Humberto Cervantes, Didier Donsez, Lionel Touseau, "An Architecture
Description Language for Dynamic Sensor-Based Applications", 5th IEEE Consumer
Communications and Networking Conference (CCNC) 2008, http://www.ieee-ccnc.org/
doi:<a
href="http://dx.doi.org/10.1109/ccnc08.2007.40";>10.1109/ccnc08.2007.40</a></li>
</ul>
</p>
Added: felix/sandbox/donsez/wireadminbinder/src/site/wab2c.xml
URL:
http://svn.apache.org/viewvc/felix/sandbox/donsez/wireadminbinder/src/site/wab2c.xml?rev=643381&view=auto
==============================================================================
--- felix/sandbox/donsez/wireadminbinder/src/site/wab2c.xml (added)
+++ felix/sandbox/donsez/wireadminbinder/src/site/wab2c.xml Tue Apr 1 05:48:09
2008
@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+<!DOCTYPE wireadminbinder SYSTEM "wireapp.dtd">
+-->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<!--
+ descriptor sample for org.apache.felix.sandbox.wireadminbinder
+
+ Author : Felix Project Team
+-->
+<wireapp
+ id="org.apache.felix.sandbox.wireadminbinder.wab2b"
+ description="A simple Wired application">
+
+ <!-- a many-to-one wireset without wire properties -->
+ <!-- + whileConsumer remove policy -->
+ <wireset
+ id="consumerservlet"
+ description="all producer and the simple consumer"
+
consumerPID="org.apache.felix.sandbox.wireadmin.sample.simpleconsumer"
+ removepolicy="whileConsumer"
+ >
+
<producersFilter><![CDATA[(|(|(|(|(wireadmin.producer.flavors=*org.osgi.util.position.Position)(wireadmin.producer.flavors=*org.osgi.util.measurement.Measurement))(wireadmin.producer.flavors=*java.lang.Long))(wireadmin.producer.flavors=*java.lang.Double))(wireadmin.producer.flavors=*java.awt.Image))]]></producersFilter>
+ </wireset>
+</wireapp>
Propchange: felix/sandbox/donsez/wireadminbinder/src/site/wab2c.xml
------------------------------------------------------------------------------
svn:eol-style = native
