Main.Documentation
ALEonOSGi
en
0
Main.Documentation
xwiki:XWiki.gabo_pedraza
xwiki:XWiki.donsez
xwiki:XWiki.donsez
1269527467000
1286568447000
1286568447000
1.89
Aspire :: Deployment of Filtering And Collection Server on OSGi
ltkjava-0.1.1.jar
1420892
xwiki:XWiki.gabo_pedraza
1277458764000
1.1
ALE-OSGi.png
31036
xwiki:XWiki.gabo_pedraza
1276076174000
1.1
wireadmin.jar
24086
xwiki:XWiki.gabo_pedraza
1277464237000
1.1
wireadmin-binder.jar
68047
xwiki:XWiki.gabo_pedraza
1277464272000
1.1
aleosgiarch.png
221894
xwiki:XWiki.donsez
1278846906000
1.2
1 Aspire :: Deployment of Filtering And Collection Server on OSGi
----
#toc("" "" "true")
----
1.1 Introduction
Deployment of the Filtering And Collection Server on OSGi platform provides to the middleware two important properties:
* Modularity: Extensions to the F&C server as addition of new readers or sensors should be provided in a modular fashion. Using OSGi approach, new readers are developed without introduce their driver code in the same archive (war) used to package the ALE Server.
* Dynamicity: These new modules will be deployed (or undeployed) on the platform dynamically without stopping the applications that are currently in execution.
However, deployment on OSGi imposes some conditions on the F&C server provisioning. This document will explain how to deploy the Fosstrak ALE Server on OSGi platform. The document is organized as follows: first installation of OSGi platform is presented. Then, how the war archive is transformed in a compliant OSGi bundled is showed. Next, the installation of a reader driver is illustrated, follow by installation of a sensor driver. Finally, additional features installation is explained.
{image:aleosgiarch.png|width=784|height=445}
Figure : architecture of the ALEServer' OSGi profile ({attach:HiRes picture|file=aleosgiarch.png})
1.1 Transformation of ALE Server web application in an OSGi compliant bundle
This transformation consists only in the addition of a MANIFEST.MF file into the war archive. This manifest file must be OSGi compliant, indicating the bundle dependencies and capabilities and also other meta-data used by the OSGi platform. In OSGi profile, we have added the manifest file, also Sensor communication and JMX management features. In the project *aleserver-bundle* the specific files to support these features are found.
Instructions to build the F&C server are [here>http://wiki.aspire.ow2.org/xwiki/bin/view/Main.Documentation/Filtering%26Collection#HBuilding]
1.1 Deployment of F&C Server on OSGI platform
1.1.1 Installation of an OSGi platform with web application support
First download an OSGi distribution such as [Apache Felix>http://felix.apache.org] (current version is 2.0.1). Then, install [Pax Web>http://wiki.ops4j.org/display/paxweb/Pax+Web] (implementation of OSGi Http Service) and their dependencies (current version is 0.7.2). Finally, install the [Pax Web Extender>http://wiki.ops4j.org/display/paxweb/Pax+Web] (current version is 0.7.2) with provides a transparent (for JEE war archive) registration of servlets on the OSGi platform.
These steps can be performed easily using the [Pax Runner>http://paxrunner.ops4j.org/space/Pax+Runner] tool (an intenet connection is required). Simply, download the Pax Runner, then in a console execute the command ~~ pax-run \-\-platform=felix \-\-dir=ale war config~~
This command install (and launch) the Felix platform into the directory ~~ale~~. The last arguments indicate to Pax Runner which [profiles>http://paxrunner.ops4j.org/display/paxrunner/Pax+Runner+profiles+list] it should install, war is the web support profile and config the configuration admin service.
In some windows system the command must be typed as ~~pax-run "\-\-platform=felix" "\-\-dir=ale" war config~~
1.1.1 Other necessary bundles
In order to support sensor extensions is necessary also to install the [Wire Admin>http://svn.apache.org/viewvc/felix/trunk/wireadmin/] bundle (compiled version {attach:wireadmin.jar} ) and [Wire Admin Binder>http://svn.apache.org/viewvc/felix/sandbox/donsez/wireadminbinder/src/site/readme.html?view=co] (compiled version {attach:wireadmin-binder.jar}) bundles.
Install the bundles using the associated command in your OSGi distribution. For Felix distribution use the next commands
~~install file:path/wireadmin.jar~~
~~install file:path/wireadmin-binder.jar~~
1.1.1 Instalation of F&C server bundle
In Felix platform you can install the server bundle using the next command
~~install file:path/aleserver-bundle.war~~
1.1 Installation of Readers' Drivers
Readers' Drivers are installed as bundles on the OSGi platform. Next readers' drivers have been included in the OSGi profile:
* [Simple Reader (an reader simulator)>Main.Documentation.Bundles.SimpleReader]
* [ProximaRF Desktop USB reader>Main.Documentation.Bundles.ProximaRFDesktopReader]
* [TagSys Medio Serial reader>Main.Documentation.Bundles.TagSysMedioReader]
* [ACR 122 USB reader>Main.Documentation.Bundles.ACR122Reader]
* [OneWire reader>Main.Documentation.Bundles.OneWireReader]
Use the Felix command [install>http://felix.apache.org/site/documentation.html] to deploy each reader bundle and its dependencies.
1.1 Installation of the temperature sensors
Two temperature sensors are provided in this distribution, At first,a fictive sensor that can be used for test purposes, and a Temper sensor that is the driver of an usb sensor temperature device. Require bundles are also provided (iPojo version 1.4.0).
Readers' bundles and sensors' bundles are shown in the next osgi console snapshot:
{image:ALE-OSGi.png}
1.1 Installation of other features bundles
The platform can be enriched using other bundles to add different features. By example, a bundle allowing administration of OSGi platform using the [Visual VM OSGi plugin>http://membres-liglab.imag.fr/kiev.gama/dev/osgi/visualvm/] is provided.
1.1 All-in-one distribution
A distribution with all required bundles is available [here>http://chaphe.free.fr/aspire/ale.zip]. Download the file and unzip it, then execute run.sh (or run.bat in Windows).
1.1 Misc
* [CiliaALE>Main.Documentation.ALEinCilia] : a flexible and dynamically reconfigurable ALE Server for Android platforms (phones and tablets)
<h2 class="heading-1"><span id="HAspire3A3ADeploymentofFilteringAndCollectionServeronOSGi">Aspire :: Deployment of Filtering And Collection Server on OSGi</span></h2><p class="paragraph"/>
<hr class="line"/>
<ul>
<li><a href="#HIntroduction">1 Introduction</a>
<li><a href="#HTransformationofALEServerwebapplicationinanOSGicompliantbundle">2 Transformation of ALE Server web application in an OSGi compliant bundle</a>
<li><a href="#HDeploymentofF26CServeronOSGIplatform">3 Deployment of F&C Server on OSGI platform</a>
<ul>
<li><a href="#HInstallationofanOSGiplatformwithwebapplicationsupport">3.1 Installation of an OSGi platform with web application support</a>
<li><a href="#HOthernecessarybundles">3.2 Other necessary bundles</a>
<li><a href="#HInstalationofF26Cserverbundle">3.3 Instalation of F&C server bundle</a>
</ul>
<li><a href="#HInstallationofReaders27Drivers">4 Installation of Readers' Drivers</a>
<li><a href="#HInstallationofthetemperaturesensors">5 Installation of the temperature sensors</a>
<li><a href="#HInstallationofotherfeaturesbundles">6 Installation of other features bundles</a>
<li><a href="#HAllinonedistribution">7 All-in-one distribution</a>
<li><a href="#HMisc">8 Misc</a>
</ul> <hr class="line"/>
<h3 class="heading-1-1"><span id="HIntroduction">1 Introduction</span></h3><p class="paragraph"/>
Deployment of the Filtering And Collection Server on OSGi platform provides to the middleware two important properties:
<ul class="star">
<li>Modularity: Extensions to the F&C server as addition of new readers or sensors should be provided in a modular fashion. Using OSGi approach, new readers are developed without introduce their driver code in the same archive (war) used to package the ALE Server.</li>
<li>Dynamicity: These new modules will be deployed (or undeployed) on the platform dynamically without stopping the applications that are currently in execution.</li>
</ul>However, deployment on OSGi imposes some conditions on the F&C server provisioning. This document will explain how to deploy the Fosstrak ALE Server on OSGi platform. The document is organized as follows: first installation of OSGi platform is presented. Then, how the war archive is transformed in a compliant OSGi bundled is showed. Next, the installation of a reader driver is illustrated, follow by installation of a sensor driver. Finally, additional features installation is explained.<p class="paragraph"/>
<img src="/xwiki/bin/download/Main.Documentation/ALEonOSGi/aleosgiarch.png" height="445" width="784" alt="aleosgiarch.png" /><p class="paragraph"/>Figure : architecture of the ALEServer' OSGi profile (<a href="/xwiki/bin/download/Main.Documentation/ALEonOSGi/aleosgiarch.png" />HiRes picture</a>)
<h3 class="heading-1-1"><span id="HTransformationofALEServerwebapplicationinanOSGicompliantbundle">2 Transformation of ALE Server web application in an OSGi compliant bundle</span></h3><p class="paragraph"/>
This transformation consists only in the addition of a MANIFEST.MF file into the war archive. This manifest file must be OSGi compliant, indicating the bundle dependencies and capabilities and also other meta-data used by the OSGi platform. In OSGi profile, we have added the manifest file, also Sensor communication and JMX management features. In the project <strong class="strong">aleserver-bundle</strong> the specific files to support these features are found.<p class="paragraph"/>Instructions to build the F&C server are <span class="wikiexternallink"><a href="http://wiki.aspire.ow2.org/xwiki/bin/view/Main.Documentation/Filtering%26Collection#HBuilding">here</a></span>
<h3 class="heading-1-1"><span id="HDeploymentofF26CServeronOSGIplatform">3 Deployment of F&C Server on OSGI platform</span></h3>
<h4 class="heading-1-1-1"><span id="HInstallationofanOSGiplatformwithwebapplicationsupport">3.1 Installation of an OSGi platform with web application support</span></h4><p class="paragraph"/>First download an OSGi distribution such as <span class="wikiexternallink"><a href="http://felix.apache.org">Apache Felix</a></span> (current version is 2.0.1). Then, install <span class="wikiexternallink"><a href="http://wiki.ops4j.org/display/paxweb/Pax+Web">Pax Web</a></span> (implementation of OSGi Http Service) and their dependencies (current version is 0.7.2). Finally, install the <span class="wikiexternallink"><a href="http://wiki.ops4j.org/display/paxweb/Pax+Web">Pax Web Extender</a></span> (current version is 0.7.2) with provides a transparent (for JEE war archive) registration of servlets on the OSGi platform.<p class="paragraph"/>
These steps can be performed easily using the <span class="wikiexternallink"><a href="http://paxrunner.ops4j.org/space/Pax+Runner">Pax Runner</a></span> tool (an intenet connection is required). Simply, download the Pax Runner, then in a console execute the command <i class="italic"> pax-run --platform=felix --dir=ale war config</i><p class="paragraph"/>
This command install (and launch) the Felix platform into the directory <i class="italic">ale</i>. The last arguments indicate to Pax Runner which <span class="wikiexternallink"><a href="http://paxrunner.ops4j.org/display/paxrunner/Pax+Runner+profiles+list">profiles</a></span> it should install, war is the web support profile and config the configuration admin service.<p class="paragraph"/>In some windows system the command must be typed as <i class="italic">pax-run "--platform=felix" "--dir=ale" war config</i>
<h4 class="heading-1-1-1"><span id="HOthernecessarybundles">3.2 Other necessary bundles</span></h4><p class="paragraph"/>In order to support sensor extensions is necessary also to install the <span class="wikiexternallink"><a href="http://svn.apache.org/viewvc/felix/trunk/wireadmin/">Wire Admin</a></span> bundle (compiled version <a href="/xwiki/bin/download/Main.Documentation/ALEonOSGi/wireadmin.jar" />wireadmin.jar</a> ) and <span class="wikiexternallink"><a href="http://svn.apache.org/viewvc/felix/sandbox/donsez/wireadminbinder/src/site/readme.html?view=co">Wire Admin Binder</a></span> (compiled version <a href="/xwiki/bin/download/Main.Documentation/ALEonOSGi/wireadmin-binder.jar" />wireadmin-binder.jar</a>) bundles.<p class="paragraph"/>Install the bundles using the associated command in your OSGi distribution. For Felix distribution use the next commands<p class="paragraph"/><i class="italic">install file:path/wireadmin.jar</i>
<i class="italic">install file:path/wireadmin-binder.jar</i>
<h4 class="heading-1-1-1"><span id="HInstalationofF26Cserverbundle">3.3 Instalation of F&C server bundle</span></h4><p class="paragraph"/>In Felix platform you can install the server bundle using the next command<p class="paragraph"/><i class="italic">install file:path/aleserver-bundle.war</i>
<h3 class="heading-1-1"><span id="HInstallationofReaders27Drivers">4 Installation of Readers' Drivers</span></h3><p class="paragraph"/>Readers' Drivers are installed as bundles on the OSGi platform. Next readers' drivers have been included in the OSGi profile:
<ul class="star">
<li><span class="wikilink"><a href="/xwiki/bin/view/Main.Documentation.Bundles/SimpleReader">Simple Reader (an reader simulator)</a></span></li>
<li><span class="wikilink"><a href="/xwiki/bin/view/Main.Documentation.Bundles/ProximaRFDesktopReader">ProximaRF Desktop USB reader</a></span></li>
<li><span class="wikilink"><a href="/xwiki/bin/view/Main.Documentation.Bundles/TagSysMedioReader">TagSys Medio Serial reader</a></span></li>
<li><span class="wikilink"><a href="/xwiki/bin/view/Main.Documentation.Bundles/ACR122Reader">ACR 122 USB reader</a></span></li>
<li><span class="wikilink"><a href="/xwiki/bin/view/Main.Documentation.Bundles/OneWireReader">OneWire reader</a></span></li>
</ul>Use the Felix command <span class="wikiexternallink"><a href="http://felix.apache.org/site/documentation.html">install</a></span> to deploy each reader bundle and its dependencies.
<h3 class="heading-1-1"><span id="HInstallationofthetemperaturesensors">5 Installation of the temperature sensors</span></h3><p class="paragraph"/>
Two temperature sensors are provided in this distribution, At first,a fictive sensor that can be used for test purposes, and a Temper sensor that is the driver of an usb sensor temperature device. Require bundles are also provided (iPojo version 1.4.0).<p class="paragraph"/>Readers' bundles and sensors' bundles are shown in the next osgi console snapshot:<p class="paragraph"/><img src="/xwiki/bin/download/Main.Documentation/ALEonOSGi/ALE-OSGi.png" alt="ALE-OSGi.png" />
<h3 class="heading-1-1"><span id="HInstallationofotherfeaturesbundles">6 Installation of other features bundles</span></h3><p class="paragraph"/>
The platform can be enriched using other bundles to add different features. By example, a bundle allowing administration of OSGi platform using the <span class="wikiexternallink"><a href="http://membres-liglab.imag.fr/kiev.gama/dev/osgi/visualvm/">Visual VM OSGi plugin</a></span> is provided.
<h3 class="heading-1-1"><span id="HAllinonedistribution">7 All-in-one distribution</span></h3><p class="paragraph"/>A distribution with all required bundles is available <span class="wikiexternallink"><a href="http://chaphe.free.fr/aspire/ale.zip">here</a></span>. Download the file and unzip it, then execute run.sh (or run.bat in Windows).
<h3 class="heading-1-1"><span id="HMisc">8 Misc</span></h3>
<ul class="star">
<li><span class="wikilink"><a href="/xwiki/bin/view/Main.Documentation/ALEinCilia">CiliaALE</a></span> : a flexible and dynamically reconfigurable ALE Server for Android platforms (phones and tablets)</li>
</ul>