Commit bf737788 authored by Christophe Demarey's avatar Christophe Demarey
Browse files

Move examples doc in the examples module.

parent 5202b1f1
============================================================================
OW2 FraSCAti Examples: Chat application
Copyright (C) 2009 INRIA, USTL
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: frascati@ow2.org
Author: Christophe Demarey
Contributor:
============================================================================
Chat:
-----
This example shows how to expose an SCA service in a Java RMI registry and how
to consume it with SCA clients: one basic command line client and one GUI client.
The GUI client shows how to load SCA composites from standards Java objects.
Compilation with Maven:
-----------------------
mvn install
Execution with Maven:
---------------------
1) Open a console for the server
cd server
mvn -Prun (standalone execution)
mvn -Pexplorer (with FraSCAti Explorer)
2) Open another console for the client
cd client
mvn -Prun (GUI client, standalone execution)
mvn -Prun.cmd (Command-line client, standalone execution)
Compilation and execution with the FraSCAti script:
---------------------------------------------------
1) Open a console and follow instructions in the 'server' directory
2) Open another console and follow instructions in the 'client' directory
============================================================================
OW2 FraSCAti Examples: Chat Client
Copyright (C) 2009 INRIA, USTL
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: frascati@ow2.org
Author: Christophe Demarey
Contributor:
============================================================================
Chat Client:
------------
This example shows how to consume the service exposed in a Java RMI registry by
the chat server example with different clients:
* one basic command line client, and
* one GUI client.
The GUI client shows how to load SCA composites from standards Java objects.
Compilation with Maven:
-----------------------
mvn install
Execution with Maven:
---------------------
mvn -Prun (GUI client, standalone execution)
mvn -Prun.cmd (Command-line client, standalone execution)
Compilation and execution with the FraSCAti script:
---------------------------------------------------
We highly recommand to use Maven to compile and run this example because there
is a lot of dependencies to specify.
============================================================================
OW2 FraSCAti Examples: Chat Server
Copyright (C) 2009 INRIA, USTL
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: frascati@ow2.org
Author: Christophe Demarey
Contributor:
============================================================================
Chat Server:
------------
This example shows how to expose an SCA service in a Java RMI registry.
Compilation with Maven:
-----------------------
mvn install
Execution with Maven:
---------------------
mvn -Prun (standalone execution)
mvn -Pexplorer (with FraSCAti Explorer)
Compilation and execution with the FraSCAti scripts:
----------------------------------------------------
frascati compile src chat-server
frascati run chat-server -libpath chat-server.jar
......@@ -32,7 +32,7 @@
<artifactId>chat-server</artifactId>
<packaging>jar</packaging>
<name>FraSCAti Examples: Chat application server</name>
<name>OW2 FraSCAti Examples: Chat application server</name>
<properties>
<composite.file>chat-server</composite.file>
......
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<chapter>
<section>
<title>FraSCAti examples</title>
<para>This section lists the examples available in the distribution. Each
example provides a README file with a short description of the example and
how to test it.</para>
<para>The three first examples are used by the tutorial to show how to
develop an SCA application with <emphasis role="bold">POJO</emphasis>
(Plain Old Java Objects), with <emphasis role="bold">Java
Annotations</emphasis>, and with a <emphasis role="bold">remote
binding</emphasis>:</para>
<itemizedlist>
<listitem>helloworld-pojo,</listitem>
<listitem>helloworld-annotated,</listitem>
<listitem>helloworld-rmi.</listitem>
</itemizedlist>
<para>Next examples show how to use <emphasis role="bold">web
services</emphasis> with FraSCAti:</para>
<itemizedlist>
<listitem>helloworld-ws (client and server),</listitem>
<listitem>calculator (client and server),</listitem>
<listitem>weather,</listitem>
<listitem>verify-mail,</listitem>
<listitem>isbn-test,</listitem>
<listitem>dictionary.</listitem>
</itemizedlist>
<para>Next examples show how to use the <emphasis
role="bold">REST</emphasis>ful binding with FraSCAti:</para>
<itemizedlist>
<listitem>twitter-rest (client),</listitem>
<listitem>counter-rest (client and server).</listitem>
</itemizedlist>
<para>The chat example shows how to expose an SCA service in a Java
<emphasis role="bold">RMI</emphasis> registry and how to consume it with
SCA clients: one basic command line client and one GUI client. The
<emphasis role="bold">GUI client</emphasis> shows how to load SCA
composites from standards Java objects.</para>
<para>All previous examples are using primitive components with a Java
implementation. Next example illustrates how to develop a primitive SCA
component with a <emphasis role="bold">script
implementation</emphasis>:</para>
<itemizedlist>
<listitem>helloworld-script</listitem>
</itemizedlist>
<para>Finally, the following example shows how to <emphasis
role="bold">compose</emphasis> two examples of FraSCAti: the Twitter one
and the Weather one. This example retrieve the location of a given Twitter
user then use the weather service to get the current weather in the
Twitter user's city.</para>
<itemizedlist>
<listitem>twitter-weather</listitem>
</itemizedlist>
</section>
</chapter>
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment