source: ether_core/trunk/kit/interactifKit/zipContent/readme.txt

Ce kit sert à préparer l'intégration d'un service intéractif s'exécutant avec un fichier de l'espace utilisateur en entrée.

++++++++ Contenu du kit +++++++++++++++++++++++++++++++++++++++++++++++++++++
Les sources sont présents dans le sous répertoire src du kit.
Listing des sources :
----------- classes applicatives :
- package fr.alcatel.ether.bean : ErrorBean.java, ServiceInfoBean.java,
- package fr.alcatel.ether.app.common :
Config.java ,Constants.java, FileManager.java, AtaRemoteFileServer.java, QueueFileServer.java,
RemoteFile.java, RemoteFileImpl.java, RemoteFileManager.java, RemoteFileServerEvent.java, RmiFileInputStream.java
- package fr.alcatel.ether.app.data : EtherFileName.java
- package fr.alcatel.ether.app.exception : EtherException.java
- package fr.alcatel.ether.app.service :  Service.java
- package fr.alcatel.ether.app.user :  User.java
- package fr.alcatel.ether.tools : Trace.java
- package fr.alcatel.ether.tools.singleton : Singleton.java
- package flafi.util : FileCopy2.java

----------- servlet de test :
InteractifServiceServlet.java, TestInteractifServlet.java

----------- page jsp :
launchService.jsp

----------- fichier de configuation du serveur de fichiers :
ether.properties.

----------- script permettant le lancement du serveur de fichiers :
fileserver.sh


Les classes compilées sont présentes dans le sous répertoire compiled.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

+++++++ Utilisation du kit ++++++++++++++++++++++++++++++++++++++++++++++++++++

++ Pré traitements avant exécution du service :
-Le point d'entrée du kit est : /servlet/TestInteractifServlet?action=1.
Un formulaire permettant d'entrer le nom du fichier qui sera fournit au service apparaît.
Le chemin à rentrer est un chemin absolu. Si aucun nom n'est saisi, le fichier declaré dans la variable 
TestInteractifServlet.DEFAULT_IN_FILE est utilisé. La servlet prépare le bean ServiceInfoBean ( de test) qui sera fournit au service.
Elle redirige ensuite vers la jsp TestInteractifServlet.JSP_PAGE ( par défaut, launchService.jsp ).
- La jsp launchService.jsp prépare l'environement d'éxecution du service et redirige vers le service.
Le développeur du service est libre de modifier cette page jsp. Elle sera intégrée 
comme point d'entrée du service dans Ether/IPSL.

Par défaut, cette page redirige vers InteractifServiceServlet, une servlet qui simule un service interactif.
Cette servlet contient un bouton permettant de lancer les post-traitements.
Avant de cliquer sur le bouton, si vous copier des fichiers manuellement dans le répertoire de sortie du service
( défini dans la variable TestInteractifServlet.INTERACTIF_SERVICE_OUTDIR ), ces fichiers seront copier dans 
l'espace utilisateur ( à l'endroit définit dans TestInteractifServlet.OUT_USER_DIR ).

++ Post traitements du service après exécution :
- Ces traitements sont décrits dans le document service.doc.
Ils consistent à copier les fichiers résultats vers l'espace utilisateur
 et à nettoyer l'environnement d'éxecution du service. Ces taches sont effectuées
par l'action 2 de la servlet InteractifServiceServlet.
Ces traitements sont à intégrer dans le service interactif (sous forme de jsp ou servlet).

+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

++++ Installation et déploiement du kit +++++++++++++++++++++++++++++++++++++++++
-- Editer et re-compiler les servlets afin de les adapter à votre environnement.

-Dans TestInteractifServlet.java, les champs à modifier sont :
public static String JSP_PAGE = "/ether/priv/launchService.jsp";
public static String SERVLET_CALL = "/servlet/TestInteractifServlet";
// nom de votre machine unix
public static String SERVICE_HOST = "sugiton";
public static String EMAIL_USER = "ether@ether";
// nom de votre machine unix
public static String USER_HOST = "sugiton";
public static String NAME_USER = "ether";
// répertoire représentant l'espace utilisateur 
public static String USER_REPOSITORY = "/tmp/ether_user";
// fichier par défaut en entrée du service
public static String DEFAULT_IN_FILE = USER_REPOSITORY + "/ether.txt";
// répertoire d'éxécution du service
public static String INTERACTIF_SERVICE_DIR = "/tmp/interactif/ether_user/" + ID_EXECUTION; 

- Dans InteractifServlet.java,  les champs à modifier sont :
public static String SERVLET_CALL = "/servlet/InteractifServiceServlet";

-- Installer les classes applicatives dans le CLASSPATH de votre moteur de servlet.
Ce sont les sous répertoires flafi et fr présents dans le répertoire compiled.

-- Mettre à jour les fichiers ether.properties et fileserver.sh :
Dans ether.properties, mettre à jour les répertoires ou seront créés les fichiers rfslog.txt et rfsdebug.txt.
Ces répertoires doivent exister ( les créer sinon ).
Dans fileserver.sh, mettre à jour les variables LIB_BASE,CONF,HOST_NAME :
LIB_BASE contient le chemin d'acces aux classes applicatives ( fr et flafi ).
CONF contient le chemin d'acces au fichier ether.properties .
HOST_NAME contient le nom de la machine unix.

-- Lancer le serveur de fichier :
Lancer le registry : rmiregitry &
Exécuter le script: fileserver.sh

-- Lancement du moteur de servlet : 
Il faut ajouter une variable en ligne de commande qui indique où se trouve le fichier ether.properties
Exemple : java –Dpath_conf=/tmp/ether.properties …..
Note : Si vous ne le faîtes pas, vous aurez une exception java.lang.nullPointerException à l'exécution des servlets.


Vous pouvez maintenant commencer le test ( voir paragraphe Utilisation du kit )
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++