[fractal-commits] [7824] sandbox/ervalerio/fractal-bf/README.txt: Initial version of README file.

[valerio.schiavoni@xxxxxxxxx]

Title: [7824] sandbox/ervalerio/fractal-bf/README.txt: Initial version of README file.

Revision

7824

Author

ervalerio

Date

2008-05-30 17:15:29 +0200 (Fri, 30 May 2008)

Log Message

Initial version of README file. to complete.

Added Paths

• sandbox/ervalerio/fractal-bf/README.txt

Diff

Added: sandbox/ervalerio/fractal-bf/README.txt (0 => 7824)

--- sandbox/ervalerio/fractal-bf/README.txt	                        (rev 0)
+++ sandbox/ervalerio/fractal-bf/README.txt	2008-05-30 15:15:29 UTC (rev 7824)
@@ -0,0 +1,119 @@
+============================================================================
+Fractal Binding Factory.
+Copyright (C) 2007-2008 INRIA, SARDES
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+Contact: Valerio.Schiavoni@xxxxxxxxx
+
+Author: Valerio Schiavoni
+
+============================================================================
+
+Fractal Binding Factory 0.2
+--------------------
+
+The Binding Factory provides support for establishing remote connections between
+Fractal components using diverse protocols. The Binding Factory can expose a Fractal
+server interface as a webservice or can register it into a RMI registry, or can make it
+available for group-RPC, and so on, each one via the same APIs.
+
+Table of content
+----------------
+  1. Requirements
+  2. Introduction
+  3. Compiling and installing Fractal Binding Factory artifacts
+  4. Running the sample applications
+  5. Using the Fractal Binding Factory via FractalADL
+  6. Using the Fractal Binding Factory via the Fractal Binding Factory APIs
+  7. Developing a new plugin
+  8. References
+  
+1. Requirements
+---------------
+Maven 2.0.x is required to compile and run the Fractal Binding Factory.
+See http://maven.apache.org for instructions on downloading and using Maven.
+
+2. Introduction
+---------------
+The Fractal Binding Factory is decoupled in several main maven artifacts
+ 
+ - the fractal-bf-core : This is the main module containing implementation
+   of the binding factory APIs allowing to load plugins and to generate stub and skeletons
+ 
+ - the fractal-bf-adl : an extension to the Fractal ADL to be able to use
+   the binding factory API as easily as possible
+   
+ - the connectors : also known as plugins, this module stores the currently available plugins
+  the binding factory; 
+
+Severals sample applications are also available in th examples/ directory.
+
+
+3. Compiling and installing Fractal Binding Factory artifacts
+------------------------------------------------------
+To compile and install all the modules in your Maven
+local repository, from the root directory of the Fractal Binding Factory, type:
+mvn clean install
+
+
+4. Running the sample applications
+----------------------------------
+Samples applications are available in the examples/
+directory. Read the README.txt file into each of the directories for
+detailed explanations.
+
+
+5. Using the Fractal Binding Factory via FractalADL
+--------------------------------------------------------
+The fractal-bf-adl module provides an extension the Fractal ADL toolchain to easily use
+the Fractal Binding Factory. Consider the following ADL example, taken from the
+examples/helloworld module:
+
+01 <!DOCTYPE definition PUBLIC "-//objectweb.org//DTD Fractal ADL 2.0//EN" "classpath://org/objectweb/fractal/bf/adl/xml/standard-bf.dtd">
+02 <definition name="org.objectweb.fractal.bf.Service">
+03 <interface name="service" role="server" signature="org.objectweb.fractal.bf.Service" />
+04	<component name="service">
+05		<interface name="service" role="server"
+06			signature="org.objectweb.fractal.bf.Service" />
+07		<content class="org.objectweb.fractal.bf.ServiceImpl" />
+08	</component>
+09	<binding client="this.service" server="service.service" />
+10    <exporter type="ws" interface="service.service">
+11		<parameter name="address" value="http://localhost:8080/Service" />
+12	</exporter>
+13 </definition>
+
+
+6. Using the Fractal Binding Factory via the Fractal Binding Factory APIs
+----------------------------------------------------------------
+
+TODO
+
+7. Developing a new plugin
+----------------------------------------------------------------
+
+TODO
+
+8. References
+-------------
+ - Maven    : http://maven.apache.org
+ - Fractal      : http://fractal.objectweb.org
+ - FractalADL :
+
+
+For any question concerning the Fractal Binding Factory, please contact
+valerio.schiavoni@xxxxxxxxx
+Date of creation of this file: May 30, 2008.
\ No newline at end of file