[TUTO] Web Service: Chat

Programmation Web

Voici le plan que je vais adopter pour vous présenter le Web Service:

1/ Definition: Web Service
2/ Notions à connaître: Servlet, JSP, SOAP, XML
3/ Installation du serveur web pour exécuter le service web
4/ Implémentation, déploiement et invocation d'un service web
5/ Exemple: le Chat

1/ Définition: Web Service

Définition: Un service web est une méthode qu'on peut appeler à distance à travers un réseau, indépendamment du système d'exploitation et du langage de programmation utilisé.
Ainsi un client écrit en PHP s'exécutant sur Unix peut utiliser un service web développé en Java qui s'exécute sur Windows et inversement.

Les services web fonctionnent sur le principe du client serveur:
- un client appelle un service web
- le serveur traite la demande et renvoie le résultat au client
- le client utilise le résultat

De tels services web sont différents des traditionnels services internet basés sur le contenu. La différence fondamentale est celle-ci:
- les services basés sur le contenu délivrent des pages web (produites statiquement ou dynamiquement) destinées aux utilisateurs;
- les services web délivrent des données à des ordinateurs.

L'intégralité des services web disponibles sur internet est appelée le Service Web (le web de services)

Bon, là je vois que vous avez besoin d'un exemple:
Supposons que vous êtes familier avec les moteurs de recherche comme Google Smile

qui peuvent vous traduire un contenu web. De cette façon, vous pouvez visionner la version française d'une page web écrite (ou dynamiquement créée) en espagnol. La version traduite est typiquement produite à la volée par un software installé sur le site du moteur de recherche. Si vous voulez monter un nouveau site avec des capacités similaires, vous aussi, vous auriez besoin soit de créer soit d'acheter un software pour traiter les traductions et de l'installer dans votre serveur web. Mais dans le nouveau monde des services web, il est possible de déléguer ce travail à un site possédant un service web dédié à la traduction.

La signature de la méthode du service peut ressembler à:

String translate {
String sourceLanguage;
String targetLanguage;
String textToTranslate;
}

Votre moteur de recherche prend la page demandée, la fragmente en markup et en texte, et pour chaque fragment de texte, appelle le service web en spécifiant les langages source et cible. Avec le texte renvoyé et les markups originaux, la page peut être reconstruite.

2/ Notions à connaître: Servlet, JSP, SOAP, XML

Une Servlet est une application Java fonctionnant du côté serveur (comme ASP et PHP). Elle permet donc de gérer des requêtes HTTP et de fournir au client une réponse HTTP dynamique.

Les Servlets ont de nombreux avantages par rapport aux autres technologies côté serveur. Tout d'abord, étant donné qu'il s'agit d'une technologie Java, les servlets fournissent un moyen d'améliorer les serveurs web sur n'importe quelle plateforme, d'autant plus que les servlets sont indépendantes du serveur web. En effet, les servlets s'exécutent dans un moteur de servlet (comme Tomcat) utilisé pour établir le lien entre la servlet et le serveur web.

Ainsi le programmeur n'a pas à se soucier de détails techniques tels que la connexion au réseau, la mise en forme de la réponse HTTP, ...

[TUTO] Web Service: Chat Moteur

Voici un exemple de servlet "PremierServlet.java" (il affiche simplement "Ma première servlet"):

Code:: import javax.servlet.*;
import javax.servlet.http.*;
import java.io.*;

public class PremiereServlet extends HttpServlet {

public void init() {
}

public void doGet(HttpServletRequest req, HttpServletResponse res)
throws ServletException, IOException {

res.setContentType("text/html");
PrintWriter out = res.getWriter();

out.println("<HTML>");
out.println("<HEAD><TITLE> Titre </TITLE></HEAD>");
out.println("<BODY>");
out.println("Ma première servlet");
out.println("</BODY>");
out.println("</HTML>");
out.close();
}

}

On verra comment l'utiliser.

Les JSP (Java Server Pages) sont un standard permettant de développer des applications Web interactives, c'est-à-dire dont le contenu est dynamique. En, fait, une page web JSP aura un contenu pouvant être différent selon certains paramètres (des infos stockées dans une BD, les préférences de l'utilisateur, ...) tandis qu'une page web classique (par exemple en HTML) affichera toujours la même information..
Ils s'exécutent du côté serveur (comme PHP, ASP). Les JSP sont intégrables au sein d'une page Web en HTML à l'aide de balises spéciales.

Une page JSP est exécutée au moment de la requête par un moteur de JSP (Tomcat par exemple).

Quelle est la différence avec une Servlet?

Lorsqu'un utilisateur appelle une page JSP, le serveur Web appelle le moteur de JSP qui crée un code source Java à partir du script JSP, compile la classe afin de fournir un fichier compilé (d'extension .class), c'est-à-dire qu'il constitue en fait une servlet à partir du script JSP. En fait, les JSP sont un moyen d'écrire facilement des servlets, en incluant dans des balises spécifiques le code JSP au sein du fichier HTML.

SOAP (Simple Object Access Protocol) est un protocole de transmission de messages. Il utilise le protocole de transport HTTP (mais il fonctionne aussi avec d'autres comme FTP).

XML (eXtensible Markup Language) est un un format de description des données et non de leur représentation, comme c'est le cas avec HTML.
Les balises XML décrivent le contenu plutôt que la présentation (contrairement À HTML). Ainsi, XML permet de séparer le contenu de la présentation, ce qui permet par exemple d'afficher un même document sur des applications ou des périphériques différents sans pour autant nécessiter de créer autant de versions du document que l'on nécessite de représentations!

3/ Installation du serveur web pour exécuter le service web

On travaille avec le couple Tomcat-Axis développés par Apache (www.apache.org).
Tomcat est le serveur qui intègre un moteur de servlets et de pages JSP.
Axis est un ensemble logiciel qui permet d'exposer du code Java comme service Web.

Voici un schéma pour mieux comprendre les différentes étapes suivies lors d'une requête/réponse XML/SOAP/HTTP:

[TUTO] Web Service: Chat A VENIR

Il faut que Java soit déjà installé (voir tuto sur java).

1/ Téléchargements:

Téléchargez Tomcat 5.5.15 ICI (Download > Tomcat 5.x > Binary Distributions > Core: Windows Executable)

Téléchargez Axis 1.3 Final ICI

2/ Installation Apache Tomcat:

On suppose que l'installation se fait dans le répertoire "$DIR\Tomcat"
Lancer apache-tomcat-5.5.15.exe et répondez aux questions:

[TUTO] Web Service: Chat 011ml

Cochez les 2 dernières cases afin d'avoir les exemples et les petites applications ("Examples" et "Webapps"):

[TUTO] Web Service: Chat 042yc

Sélectionnez le répertoire d'installation:

[TUTO] Web Service: Chat 050gw

Entrez un mot de passe:

[TUTO] Web Service: Chat 073kb

Sélectionnez le chemin où se trouve l'installation de JRE:

[TUTO] Web Service: Chat 082vm

L'installation peut commencer:

[TUTO] Web Service: Chat 094vg

Décochez toutes les cases. Je vais vous montrer comment démarrer Tomcat manuellement:

[TUTO] Web Service: Chat 115le

Pour démarrer Tomcat, lancez "Monitor Tomcat":

[TUTO] Web Service: Chat 128gv

L'icône suivant apparaît à droite de la barre des tâches:

[TUTO] Web Service: Chat 130tv

Faîtes un clic droit sur l'icône et cliquez sur "Start service":

[TUTO] Web Service: Chat 148qg

Le serveur se lance:

[TUTO] Web Service: Chat 155gs

Pour tester le bon fonctionnement du serveur web Apache Tomcat, ouvrez votre navigateur et entrez l'adresse

"http://localhost:8080".
Vous devez avoir cette page qui s'affiche:

[TUTO] Web Service: Chat 166rf

3/ Installation Apache Axis:

Dézippez axis-bin-1_3.zip dans un répertoire temporaire.
Récupérez le répertoire "axis" dans "axis-1_3\webapps\" et copiez-le dans le répertoire "$DIR\Tomcat\webapps\"

Pour tester le bon fonctionnement de l'application web Apache Axis, ouvrez votre navigateur

et entrez l'adresse "http://localhost:8080/axis":

[TUTO] Web Service: Chat 175wt

Ca y est, tout est prêt pour commencer.

4/ Implémentation, déploiement et invocation d'un service web

Il faut ajouter "tools.jar" dans le répertoire "$DIR\Tomcat\webapps\axis\WEB-INF\lib\".
Pour prendre en compte la modification, il faut redémarrer le serveur Tomcat.

a/ Implémentation d'un service web

Un service web est tout simplement une classe java, exposant un certain nombre de méthodes (publiques) qu'on peut invoquer.
Ainsi, on utilisera un exemple simple de service, ServiceCatalogue.java:

Code:: import java.util.Hashtable;

// un catalogue de livre

public class ServiceCatalogue {

private Hashtable catalogue;

public ServiceCatalogue() {

catalogue = new Hashtable();
catalogue.put("Titre1", "Auteur1");
catalogue.put("Titre2", "Auteur2");
catalogue.put("Titre3", "Auteur3");
catalogue.put("Titre4", "Auteur4");
}

public void ajouterLivre(String titre, String auteur) {

if ((titre == null) || (auteur == null))
{
throw new IllegalArgumentException("Le titre et le nom de l'auteur doivent être renseignes.");
}
catalogue.put(titre,auteur);
}

public String trouverAuteur(String titre) {

if (titre == null) {
throw new IllegalArgumentException("Le titre doit etre renseigne.");
}
//Retourne l'auteur correspondant à la clé titre

return (String)catalogue.get(titre);
}

public Hashtable lister() {

return catalogue;
}
}

Créer un dossier service (où vous voulez) et copier le fichier ServiceCatalogue.java dans ce dossier nouvellement créé.
Compiler ce fichier.

b/ Déploiement du service

J'ai pu voir 2 méthodes de déploiement durant ma formation.
La première méthode est tout simplement de renommer le fichier ServiceCatalogue.java en ServiceCatalogue.jws et de déployer le service en chargeant la page http://localhost:8080/axis/ServiceCatalogue.jws

Cette méthode est très rapide. Cependant, elle ne permet pas de personnaliser le service et le déploiement (par exemple, faire une sélection des méthodes que l'on veut exposer au client). Les descripteurs de déploiement permettent de remédier à ce problème en y mettant explicitement certaines particularités que nous allons voir Smile

Cette méthode est le Web Service Deployment Descriptor (WSDD):

- Créer un descripteur de déploiement, soit un fichier CatalogueDeploy.wsdd:

Code:: <deployment xmlns="http://xml.apache.org/axis/wsdd/" xmlns:java="http://xml.apache.org/axis/wsdd/providers/java">
<service name="Catalogue" provider="java:RPC">
<parameter name="className" value="ServiceCatalogue"/>
<parameter name="allowedMethods" value="*"/>
<parameter name="scope" value="session"/>
</service>
</deployment>

Explications:

Code:: <deployment xmlns="http://xml.apache.org/axis/wsdd/" xmlns:java="http://xml.apache.org/axis/wsdd/providers/java">

Cette entête est à mettre au début de chaque descipteur de déploiement.

Code:: <service name="Catalogue" provider="java:RPC">

"Catalogue" est le nom du service à appeler http://localhost:8080/axis/services/Catalogue

Code:: <parameter name="className" value="ServiceCatalogue"/>

Il faut donner le nom du fichier java correspondant au service.

Code:: <parameter name="allowedMethods" value="*"/>

Ce paramètre permet de sélectionner les méthode que l'on veut exposer au client. Dans notre cas, toutes les méthodes sont autorisées ("*")

Code:: <parameter name="scope" value="session"/>

Le paramètre scope permet de sauvegarder ("application") ou non ("request") les modifications effectuées par un client. Je vous donnerai un exemple par la suite pour être plus clair.

- Enregistrer ce fichier dans le répertoire contenant le fichier ServiceCatalogue.java

- Compiler le fichier ServiceCatalogue.java et copier le fichier ServiceCatalogue.class ainsi obtenu dans le répertoire $DIR\Tomcat\webapps\axis\WEB-INF\classes\

- Pour déployer le service, utiliser l'invite de commande DOS, se placer dans le dossier contenant le fichier ServiceCatalogue.java et entrer la commande qui suit:

[TUTO] Web Service: Chat 019ls1

Voilà! Le service peut être utilisé!

Rien de bien compliquer. Charger la page http://localhost:8080/axis/services/Catalogue
Vous devrez voir apparaître cette fenêtre:

[TUTO] Web Service: Chat 020is

Pour faire appel à une méthode (par exemple lister), chargez la page http://localhost:8080/axis/services/Catalogue?method=lister

[TUTO] Web Service: Chat 036mw

La réponse qui s'affiche dans la fenêtre de votre navigateur est sous forme format SOAP. C'est de cette façon que HTTP véhicule le message.
On peut voir que les différents auteurs et titres sont affichés (balises item).

Pour faire appel à une méthode avec des paramètres (par exemple trouverAuteur), chargez la page http://localhost:8080/axis/services/Catalogue?method=trouverAuteur&param=Titre3

[TUTO] Web Service: Chat 045xp

A SUIVRE: utilité du paramètre scope du fichier de déploiement

crapaud Nombre de messages : 1 Date d'inscription : 01/12/2006

Salut,

enfin un forum où j'ai trouvé réponse à mes questions. Merci Alex.
Juste un soucis, lors du : "java org.apache.axis.client.AdminClient CatalogueDeploy.wsdd" j'ai l'erreur suivante : "Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/axis/client/ClientAdmin"

Peux tu m'aider à résoudre ce problème ?

Merci, Franck.

Bordel de Dieu mais ca interesse en plus !!!! Sad

Salut Franck,

Bienvenue sur mon forum top

Etant donné que ca fait longtemps que je n'ai pas touché à tomcat-axis, je ne peux te dire exactement le problème. De plus, peut-être que tu as installé des versions plus récentes de tomcat et/ou axis, donc peut-être que ce tuto n'est plus valable (ce qui m'étonnerait).

Enfin, d'après moi, ca viendrait d'une librairie manquante.

NB: je vais chercher un peu et je te tiens au courant dès que j'ai du nouveau.

@ravi: étant donné que tes messages n'apportent aucune valeur ajoutée, il me semble utile de t'interdire l'accès aux sujets relatifs à la programmation web. En plus clair, dégage de là!!! tongue

Ok, Franck. Je viens de refaire mon tuto (qui est franchement pas mal Very Happy

) et en effet, je suis arrivé à la même erreur que toi.

En fait, il faut définir une variable d'environnement contenant le chemin des différentes librairies contenues dans axis (que j'ai oublié de préciser dans mon tuto mais comme personne ne l'a fait à part toi fight1

, en même temps, c'est pas très utile dans la vie Very Happy

).

Pour celà, rien de compliquer:

- Allez sous "Démarrer > Panneau de configuration > Système", cliquez sur l'onglet "Avancé" puis sur le bouton "Variables d'environnement".
Dans la partie "Variables utilisateur", cliquez sur le bouton "Nouveau" situé en haut.
Mettez les valeurs (en respectant les majuscules/minuscules mais sans les guillemets...) "CLASSPATH" pour le nom de variable et ".;C:\Tomcat\webapps\axis\WEB-INF\lib\axis.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\axis-ant.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\commons-discovery-0.2.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\commons-logging-1.0.4.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\jaxrpc.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\log4j-1.2.8.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\saaj.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\tools.jar;
C:\Tomcat\webapps\axis\WEB-INF\lib\wsdl4j-1.5.1.jar" pour la valeur.

Cliquez sur OK.

Après modifications, vous devez avoir ca:

[TUTO] Web Service: Chat Var01ln1

Pour faire plus propre, il aurait fallu créer une autre variable ANT_LIB par exemple en lui donnant le chemin "C:\Tomcat\webapps\axis\WEB-INF\lib" et remplacer dans la variable CLASSPATH ces chemins par %ANT_LIB%\xxxxx.jar. Mais bon, je l'ai pas fait.

Lors de l'exécution, l'erreur "Exception in thread "main" java.lang.NoClassDefFoundError: org/apache/axis/client/ClientAdmin" n'apparaît plus. Par contre, voilà ce qui s'affiche:

[TUTO] Web Service: Chat Err01og9

Je pense qu'il ne s'agit que d'un warning et donc, le service peut-être néanmoins utilisé.
Maintenant, pour ne rien avoir, il suffit de télécharger ces librairies:
- activation.jar (ICI)
- mailapi.jar (ICI)

Et n'oubliez pas de rajouter les chemins de ces librairies dans le CLASSPATH.

Et voilà le résultat:

[TUTO] Web Service: Chat Okui6

Voilà, je pense que ton problème sera résolu une fois que tu auras suivi mes recommandations.

A noter, que j'ai installé les toutes dernières versions des softs:
- J2SE(TM) Development Kit 5.0 Update 10 (jdk-1_5_0_10-windows-i586-p.exe);
- Tomcat 5.5.20 (Core > Windows Service Installer: apache-tomcat-5.5.20.exe);
- Axis 1.6 (axis-bin-1_4.zip).

Ca marche impec Smile

Zut désolé Alex, si tu m'avais demandé je te l'aurai dit qu'il y avait un problème dans ton tuto ... sunny

crapaud Nombre de messages : 2 Date d'inscription : 24/03/2009

[color=red]salut , je suis un etudiant 5eme anné ingenieur en informatique et j'ai les services web comme un projet fin d'etud (PFE).
j'ai utilisé les logiciels suivant:
tomcat 5.5
axis 1.4

je veux creer un service chat et le déployer dans axis ; et devloper le cient de ce service .

je un aide svp . merci

crapaud Nombre de messages : 2 Date d'inscription : 24/03/2009

vous pouvez m'aidé svp

crapaud Nombre de messages : 1 Date d'inscription : 30/04/2009

merci alex pour ces explications pour la creation et le deploiement du web service, mais pour consommer ce web service j'ai du mal alors svp si vous pouvez m'aidé l'attend votre reponse.merci

crapaud Nombre de messages : 5 Date d'inscription : 18/01/2012

Merci beaucoup Alex pour ce tutorial ca m'a beaucoup aidé
EN fait J'ai utilisé d'autres tutoriaux qui n'ont pas précisé l'information suivante :

"4-Implémentation, déploiement et invocation d'un service web

Il faut ajouter "tools.jar" dans le répertoire "$DIR\Tomcat\webapps\axis\WEB-INF\lib\".
Pour prendre en compte la modification, il faut redémarrer le serveur Tomcat."

et par la suite quand j'effectue des modifications aux variables de mon service puis je les consulte je ne trouve pas les modifications que j'ai déjà fait . et le fait d'ajouter tools.jar m'a aidé à résoudre le problème
Merci encore

crapaud Nombre de messages : 5 Date d'inscription : 18/01/2012

alex a écrit:: [size=16]

[b]A SUIVRE: utilité du paramètre scope du fichier de déploiement

Stp Alex, tu peux poursuivre ton tuto et nous expliquer l'utilité du paramètre scope dans le fichier de déploiement?

crapaud Nombre de messages : 5 Date d'inscription : 18/01/2012

J'ai une remarque à ajouter à ce tutorial,
En effet En exécutant la commande

 
C:\Workspace eclipse\TestDeploiement\src>java org.apache.axis.client.AdminClient
 CatalogueDeploy.wsdd

une erreur apparaisse qui indique qu'il ya problème de connexion au serveur .
Pour résourdre ce problème j'ai ajouter le port de serveur apache


C:\Workspace eclipse\TestDeploiement\src>java org.apache.axis.client.AdminClient
 -p 8080 CatalogueDeploy.wsdd

dans ce cas, le déploiement a été bien réalisé Smile

crapaud Nombre de messages : 5 Date d'inscription : 18/01/2012

ma question maintenant

Qu je peux trouver le fichier catalogue.wsdl scratch

?

crapaud Nombre de messages : 5 Date d'inscription : 18/01/2012

pfff je pense que jai posté la réponse à cette question mais je la trouve pas !!
Il suffit de créer ce fichier catalogue.wsdl à l'aide de la commande :

java org.apache.axis.wsdl.Java2WSDL -o catalogue.wsdl -l"a" -n urn:catalogue -p"catalogue" urn:catalogue ServiceCatalogue

avec a est la l'adresse du service web

PS: Shocked

J'ai changé l'adresse par "a" parce que je n'ai pas pu la poster à cause d'un message de droit d'utilisation que j'ai reçu:

Les nouveaux membres ne sont pas autorisés à poster de liens externes ou des emails pendant 7 jours. Veuillez contacter l’administrateur du forum pour plus d’informations.

» [TUTO] Le langage Java
» [TUTO] Customiser l'interface graphique de XP
» [TUTO] Tutoriel sur PHP/mySQL avec EasyPHP