Edge Server Configuration

2011-08-20T01:36:53Z

SammyWilson:

This page explains the various configuration options of the Rifidi Edge Server
=RifidiEdgeServer.ini=
The RifidiEdgeServer.ini is a property file that contains options for various options when the edge server starts up.
==rifidiserver.ini file==
As of release 1.2.0, the default rifidiserver.ini file looks like this:
<pre>
-os
${target.os}
-ws
${target.ws}
-arch
${target.arch}
-nl
${target.nl}
-vmargs
-Declipse.ignoreApp=true
-Dosgi.console
-Dosgi.noShutdown=true
-Dorg.rifidi.edge.configuration=config/rifidi.xml
-Dosgi.clean=true
-Dorg.osgi.framework.bootdelegation=javax.xml.ws
-Dcom.sun.management.jmxremote.port=2021
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
-Djava.rmi.server.hostname=127.0.0.1
-Dorg.rifidi.edge.core.rmi.port=1101
-Dorg.rifidi.edge.ale.port=8081
-Dorg.rifidi.edge.ale.host=127.0.0.1
-Dosgi.framework.extensions=org.eclipse.equinox.weaving.hook
-Dorg.aspectj.osgi.verbose=true
-Dorg.rifidi.edge.autostart=true
-Dorg.rifidi.edge.logging=config/logging.properties
-Dorg.rifidi.ui.notify=true
</pre>

==Console==
;-console
:This starts up the OSGi console so that you can interact with the edge server from the command line. For a list of commands that are available see [[Edge Server Commands]]. If you would like the console to be available over the network, supply a port after the -console (e.g. -console 2020). Now it is possible to telnet into the server at the given port. It is recommended that you use ssh tunneling for security reasons (i.e. first ssh to the machine that is running the edge server, then telnet to the console). One thing to note is that after you telnet to the OSGi console, you cannot use <span class="plainlinks">[http://www.bestpills4weightloss.com<span style="color:black;font-weight:normal; text-decoration:none!important; background:none!important; text-decoration:none;">top weight loss pills</span>] the <tt>exit</tt> command as you normally would to close the telnet session. This is because <tt>exit</tt> will be caught by the OSGi console and will perform a System.exit(). Instead, to exit the telnet session while keeping the server running, just close the telnet window.
==VMArgs==
VMArgs must follow the <tt>-vmargs</tt> flag in the .ini file. They must start with <tt>-D</tt>. Default values can be found in the <tt>bundle.properties</tt> file in the spring directory for the appropriate option. Important VM args:
;-Dorg.rifidi.edge.configuration
:This is the path to the persistence file. See [[#rifidi.xml]].
;-Dcom.sun.management.jmxremote.port
:The port to open up JMX on. This is important if you are using a program like VisualVM to profile the server
;-Djava.rmi.server.hostname
:The hostname to open up the RMI registry at. Default is <tt>127.0.0.1</tt>
;-Dorg.rifidi.edge.core.rmi.port
:The port of the RMI registry Default is <tt>1101</tt>
;-Dorg.rifidi.edge.ale.host
:The hostname to publish the ALE webservices at. Default is <tt>127.0.0.1</tt>
;-Dorg.rifidi.edge.ale.port
:The port to publish the ALE webservices at. Default is <tt>8081</tt>
;-Dorg.rifidi.edge.ale.read
:The service name of the ALE reading service. Default is <tt>ALEService</tt>
;-Dorg.rifidi.edge.ale.logicalreader
:The service name of the ALE logical reader service. Default is <tt>ALELRService</tt>
;-Dorg.rifidi.home
:The Rifidi directory. If not set, it defaults to ${user.dir}
;-Dorg.rifidi.ui.notify
:If set to true, reader adapters will send tag notifications to workbench. Default is true

=rifidi.xml=
The rifidi.xml file is the persistence file for the Rifidi Edge Server. The two important services that are saved are Reader Configurations and Command Configurations.

==Loading a configuration file==
Whenever the edge server starts up, it looks for the file that is specified in the <tt>org.rifidi.configuration</tt> vm flag. After the configuration file is read, the server will attempt to recreate all services specified in the file. If a needed factory is not available, the service will be skipped and recreated when the factory becomes available. For example, suppose the configuration file has an Alien Reader Configuration and an LLRP Reader Configuration. Suppose that when the server starts up, only the Alien plugin is available (so the Alien Reader Factory is available, but the LLRP Reader Factory is not). At this point the Alien Reader is recreated. If later the LLRP plugin is installed, then the LLRP reader will be recreated.

==File Structure==
The edge server uses JAXB to persist a configuration file. Each service will have a serviceID and a factoryID. The serviceID is the unique name of the service, and is used when using the service (such as starting a session on a reader). The factoryID is the ID of the factory that can create a service. The following is an example of file that has one Alien Reader saved.
<pre>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configurationStore>
<services>
<attributes>
<entry>
<key>ReconnectionInterval</key>
<value>500</value>
</entry>
<entry>
<key>Port</key>
<value>20000</value>
</entry>
<entry>
<key>InvertExternalOutput</key>
<value>0</value>
</entry>
<entry>
<key>PersistTime</key>
<value>-1</value>
</entry>
<entry>
<key>Username</key>
<value>alien</value>
</entry>
<entry>
<key>Password</key>
<value>password</value>
</entry>
<entry>
<key>InvertExternalInput</key>
<value>0</value>
</entry>
<entry>
<key>ReaderNumber</key>
<value>0</value>
</entry>
<entry>
<key>ExternalOutput</key>
<value>0</value>
</entry>
<entry>
<key>IpAddress</key>
<value>127.0.0.1</value>
</entry>
<entry>
<key>MaxNumConnectionAttempts</key>
<value>10</value>
</entry>
<entry>
<key>RFAttenuation</key>
<value>0</value>
</entry>
</attributes>
<factoryID>Alien</factoryID>
<serviceID>Alien_1</serviceID>
</services>
</configurationStore>
</pre>

Rifidi roadmap

2011-06-13T06:45:20Z

SammyWilson: /* Rifidi As Single Application */

This page discusses some long range plans for the Rifidi project.

=Current State=

Currently, the Rifidi products (Tag Streamer, and Emulator) are two totally separate software packages with little code reuse (except for readers) and loose coupling integration. Functionality is separated into osgi plugins, but code is not being developed with the service-oriented paradigm that osgi provides. this causes several problems:

*Two Separte Development Cycles for Rifidi Tag Streamer, and Emulator
** Version Numbers apply only to releases, not to underlying services provided by osgi plugins
** too much code is copied and not shared
*There is alot of functionality that is not separated into plugins
**Stable code mixed with development code
**If only one small part of a class changes, the whole plugin has to be updated
*Rifidi is missing an eclipse-like 'update' functionality

As a result, we end up with two separate, but related projects that are loosely-coupled

=Solution through Service Oriented Architecture=

In order to tie the two products closer together, we should use the services-oriented design that osgi allows for. We can achieve this by following the following best practices:

* Functionality needs to be separated into services (i.e. plugins).[http://www.bedbugbitesinfo.com/'''Bed Bug Bites''']
* osgi plugins should be versioned separately from releases. We can do this in the manifest file of the plugin
* Each bundle should have a maintainer. This can also be specified in the plugin's manifest.
* The most important idea is that Rifidi should be treated as '''one''' application with several possible ways of assembling functionality.[http://www.detective.ro/index-en.html'''private detective Romania''']

=Rifidi As Single Application=
If Rifidi is a single application, it gives several benefits:
*'''Single Installer''' - There can be a single, small Rifidi Installer that allows users to install the Rifidi functionality that they want. For example, once they have the base application running, they can choose to install the 'emulator' packages or the 'tag streamer' packages.[http://www.merchantos.com/features/cloud-based-point-of-sale cloud point of sale system]
*'''Update Functionality''' - When a user wants the latest version of the code, he can update the application, which will install only the latest osgi plugins instead of having to download the whole rifidi application again.
*'''Reliability''' - By focusing on the functionality at the package level, we can note when a package changes and update the version number of the package itself. In addition, plugin dependencies can specify version number that they depend on. This allows us to know which package versions work with the current code ==Related Links==

[http://www.cellulite.co.uk/ '''cellulite'''] in case something breaks. Because each plugin can be tagged in the SVN, a 'release' is simply a collection of plugin version numbers.
*'''User Upgrade Path''' - By having an installer with the ability to add new functionality, it provides a user with a clear upgrade path in using the Rifidi Products, for example:

[[Image:RifidiRoadmap.png]]

=Steps to Complete=
# Separate functionality into plugins and identify common code that is currently being duplicated.
# Design new packages for the duplicated code. The new packages should be able to be used by all products.
# Develop a 'best practices' guide for how to number osgi packages. Go through all packages and give them version numbers
# Create a new svn repository and add all new packages to it[http://www.amaliadraghici.ro/portofolio/Machiaj%20mireasa/list/1 machiaj mireasa]
# Add update functionality within the products
# Host site for serving package updates
# Develop common UI framework

[http://www.ocularconcepts.us Cleveland Web Design], [http://www.strep-throat-symptoms.org/ Symptoms of Strep Throat] | [http://www.blue-waffle.org/ Blue Waffle Infection], [http://www.outdoorfountains.com/ outdoor fountains], [http://namthaibinhduong.edu.vn/ du hoc], [http://namthaibinhduong.edu.vn/ tu van du hoc], [http://namthaibinhduong.edu.vn/ cong ty du hoc], [http://namthaibinhduong.edu.vn/ du hoc my], [http://namthaibinhduong.edu.vn/ du hoc uc], [http://namthaibinhduong.edu.vn/ du hoc singapore], [http://www.diamondlinks.net/ link building service]

RifidiWiki - User contributions [en]

Edge Server Configuration

Rifidi roadmap