WS Axis

Dploiement et Appel aux web services Java avec Axis
par Mohamed KARAMI
Date de publication : 07/10/2006 Dernire mise jour : 29/10/2007
Ce tutoriel est destin aux dbutants J2EE, il explique comment utiliser le framework Axis sous Apache Tomcat pour crer, dployer et consommer un web service en java.
Dploiement et Appel aux web services Java avec Axis par Mohamed KARAMI
I - Remerciements II - Lancement et configuration d'Axis II-A - Configuration de Tomcat II-B - Dmarrage de Tomcat II-C - Dmarrage d'Axis III - Mthode de dploiement 1 III-A - Cration du web service III-B - Dploiement du web service III-C - Test du web service IV - Mthode de dploiement 2 IV-A - Compilation de la classe du web service IV-B - Dfinition du descripteur de dploiement IV-C - Dploiement du web service IV-D - Excution du web service par son alias V - Consommer le web service en Java V-A - Cration du fichier de description du web service "wsdl" V-B - Utilisation du gnrateur " WSDL2Java " V-C - Dfinition du client Java VI - Dsactivation du web service
-2Copyright - karami. Aucune reproduction, mme partielle, ne peut tre faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu' 3 ans de prison et jusqu' 300 000 E de domages et intrts.
http://karamimed.developpez.com/j2ee/tutoriels/axis/
Axis 1.4 Apache Tomcat 5.5.17 Eclipse 2.1 Le cours au format HTML : Par FTP ---- Par HTTP Le cours au format PDF : Par FTP ---- Par HTTP La source du web service : Par FTP ---- Par HTTP La source du client java : Par FTP ---- Par HTTP Librairies d'activation d'Axis : Par FTP ---- Par HTTP
I - Remerciements
Merci Neo41 pour sa lecture et ses corrections, RideKick pour sa relecture. Merci Ricky81 pour ses conseils, et un grand merci galement Nono40, ralisateur de l'diteur xml.
II - Lancement et configuration d'Axis

Le serveur de dploiement " Axis " est install comme une application Web au sein du moteur de servlets et de JSP " Apache Tomcat ". Note : Pour raliser notre web service dans les meilleures conditions, c'est prfrable de faire une installation standard de Tomcat et la machine virtuelle JDK, en effet pendant l'installation ne changer pas les chemins d'installation standard, car sinon on peut se retrouver dans des situations o on aura des erreurs tranges et difficiles interprter.
II-A - Configuration de Tomcat

Avant de lancer Tomact vous devez vrifier que Tomcat pointe sur le JDK et non pas le JRE, car ceci peut causer une erreur assez frquente concernant le fichier tools.jar (tools.jar est prsent dans le dossier "lib" du JDK mais il n'existe pas dans le JRE), et voici l'erreur que vous pouvez avoir : "java.lang.RuntimeException: No compiler found in your classpath! (you may need to add 'tools.jar')". Donc votre Java Virtual Machine doit tre comme ceci : "JAVA_HOME\jre\bin\server\jvm.dll".
II-B - Dmarrage de Tomcat

Vous devez, pour accder aux possibilits de " Axis ", activer pralablement le serveur " Apache Tomcat " (j'utilise la version 5.5.17 de Tomcat). Pour cela, sous Tomcat 4, vous double-cliquez sur : "dossierInstallation\Tomcat 4\bin\startup.bat". Sous Tomcat 5.5.x, vous double-cliquez sur : "dossierInstallation\Tomcat 5.5\bin\tomcat5.exe". Ou tout simplement, si le service Tomcat est install, utiliser "Monitor Tomcat" puis le menu "Start Service".
II-C - Dmarrage d'Axis

Pour installer Axis (j'utilise la version 1.4), dcompresser le fichier "axis-bin-1_4.zip", puis copier le dossier "axis-1_4\webapps\axis" dans "dossierInstallation\Tomcat 5.5\webapps\", comme a Axis sera une application web dploye sous Tomcat. Il vous manquera la librairie "activation.jar" et d'autres optionnelles: "soap.jar" et "mail.jar",# que vous pouvez copier dans "dossierInstallation\Tomcat 5.5\common\lib\". Pour vrifier la bonne installation et ventuellement accder aux services web existants sur " Axis ", vous redmarrez Tomcat et vous tapez dans un navigateur : http://localhost:8080/axis. Ensuite, vous pouvez cliquer sur " Validate " puis "List":
La validation teste l'existence des librairies requises par Axis:
III - Mthode de dploiement 1 III-A - Cration du web service

La premire tape consiste dfinir la classe du service web qui retournera au client la somme de 2 entiers. La dfinition de cette classe est la suivante : Le web service
public class sommer { public int getsomme(int a, int b) { return a+b; } }
Utilisez un diteur de texte simple, Kate sous Unix ou Bloc-notes sous Windows. Attention, vous devez sauvegardez votre classe sous le fichier portant le mme nom de la classe et suffix par " jws " ! Ici, le fichier de sauvegarde sera donc : "sommer.jws".
III-B - Dploiement du web service

La deuxime tape consiste dployer le service au sein d'un fournisseur de services web. L'environnement d'excution et de dploiement des services web que nous utilisons est, comme vous l'avez dj constat, l'outil " Axis ". Le premier mode de dploiement sous " Axis " que nous allons mettre en oeuvre est le plus simple qui soit ; c'est le dploiement instantan par fichier " JWS ". Vous noterez qu'il n'est pas ncessaire de compiler le fichier source java. Pour raliser le dploiement, il suffit de copier le fichier "sommer.jws" dans le domaine applicatif de " Axis ". Le domaine d'application de " Axis " est : "dossierTomcat/webapps/axis", vous devez donc copier le fichier "sommer.jws" dans ce dossier. Vous tes dsormais en mesure d'accder votre service l'URL suivante : http://localhost:8080/axis/sommer.jws. Vous devez alors constater que votre service a bien t dploy sur " Axis " en ayant en retour la page " html " suivante :
Si vous cliquez sur ce dernier lien, vous verrez la dfinition " WSDL " (gnre automatiquement par " Axis ") de votre service web.
III-C - Test du web service

La dernire tape consiste mettre en oeuvre votre service qui est dsormais accessible travers tout le net ! Pour excuter une mthode de votre service et obtenir la rponse " SOAP " correspondante, vous tapez l'expression suivante dans votre navigateur : http://localhost:8080/axis/sommer.jws?method=getsomme&a=2&b=3 Par rapport l'expression prcdente, vous prcisez ici le nom de la mthode excuter, sous la forme de la valeur de l'attribut " method " et vous prcisez les valeurs des paramtres a et b. La rponse affiche est le contenu " SOAP ", c'est--dire un fichier " XML " dont voici un extrait :
- 10 Copyright - karami. Aucune reproduction, mme partielle, ne peut tre faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu' 3 ans de prison et jusqu' 300 000 E de domages et intrts.
IV - Mthode de dploiement 2
Dans l'exercice prcdent, nous avons mis en oeuvre un mode de dploiement entirement pris en charge par " Axis ". Ce mode automatique de dploiement prsente les contraintes suivantes : Ncessit de disposer des sources des classes dont on veut dfinir le ou les services. En effet, le mode de dploiement automatique d'Axis travaille sur la source des classes Java, Impossibilit de dcrire des particularits de dploiement (classes publiques et prives). Ce sont pour ces raisons, que nous devons parfois raliser un dploiement explicite. Cela implique la dfinition d'un fichier particulier, appel descripteur de dploiement du service web. Ce fichier porte l'extension " wsdd " pour "Web Service Deployment Descriptor".
IV-A - Compilation de la classe du web service

La premire tape consiste compiler la classe que vous avez dfinie, renommer le fichier "sommer.jws" en "sommer.java" et compiler le par commande "javac sommer.java", aprs vous devez copier la classe rsultante dans le dossier des "jwsClasses"
IV-B - Dfinition du descripteur de dploiement

Le descripteur de dploiement doit tre plac dans le mme dossier que le " .wsdl " dfinissant le service. Appelons ce descripteur " deploy.wsdd ". Son contenu sera minimalement celui-ci : Dploiement du web service
<deployment xmlns="http://xml.apache.org/axis/wsdd/" xmlns:java="http://xml.apache.org/axis/wsdd/providers/java"> <service name="sommer" style="java:RPC"> <parameter name="className" value="sommer"/> <parameter name="allowedMethods" value="*"/> </service> </deployment>
Expliquons les diffrents lments :

Balise de dbut avec comme attributs les espaces de noms des balises mises en oeuvre dans un descripteur de dploiement. deployment xmlns="http://xml.apache.org/axis/wsdd/" xmlns:java="http://xml.apache.org/axis/wsdd/providers/java" Le nom d'invocation du service, avec le mode, ici "RPC". Ce sera le principal mode que nous mettrons en oeuvre. service name="sommer" style="RPC" Ensuite, la classe compile associe au service parameter name="className" value="sommer" Ensuite, les autorisations d'accs au service (ici toutes les mthodes) parameter name="allowedMethods" value="*" Fin de la balise "service" service Fin de la balise "deployment" deployment
IV-C - Dploiement du web service

Le descripteur de dploiement doit tre maintenant pris en compte par le serveur " Axis " (i.e. le fournisseur de services) pour raliser le dploiement du service. Pour ce faire, il convient d'utiliser l'utilitaire " AdminClient " du serveur " Axis ". La ligne de commande est alors : "java org.apache.axis.client.AdminClient deploy.wsdd"
Si les librairies Axis ne sont pas spcifies dans le classpath, vous devez le faire comme suit dans un fichier "deploy.bat" de prfrence: Le classpath
set OLD_CLASSPATH=%CLASSPATH% set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\common\lib\activation.jar set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\common\lib\mail.jar set CLASSPATH=%CLASSPATH%;%AXIS_HOME% set CLASSPATH=%CLASSPATH%;%AXIS_HOME%\lib\axis.jar set CLASSPATH=%CLASSPATH%;%AXIS_HOME%\lib\jaxrpc.jar set CLASSPATH=%CLASSPATH%;%AXIS_HOME%\lib\wsdl4j.jar set CLASSPATH=%CLASSPATH%;%AXIS_HOME%\lib\commons-discovery.jar set CLASSPATH=%CLASSPATH%;%AXIS_HOME%\lib\commons-logging.jar set CLASSPATH=%CLASSPATH%;%AXIS_HOME%\lib\saaj.jar set CLASSPATH=%CLASSPATH%;%AXIS_HOME%\lib\log4j-1.2.4.jar set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\common\lib\xerces.jar set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\common\lib\servlet-api.jar set CLASSPATH=%CLASSPATH%;%CATALINA_HOME%\common\lib\naming-factory.jar set CLASSPATH="%CLASSPATH%" java - CLASSPATH="%CLASSPATH%" org.apache.axis.client.AdminClient deploy.wsdd set CLASSPATH=%OLD_CLASSPATH%
Parmi les librairies Axis inclues dans le classpath, il faut faire attention aux versions de quelques unes, donc il vaux mieux vrifier manuellement la correspondance des noms des fichiers existants dans le dossier "Axis\lib" et leurs noms dans le classpath dfinit ci-dessus. Si vous n'arrivez pas lancer correctement la commande l'aide du classpath, vous pouvez dcompressez ces librairies dans le dossier "AXIS_HOME\WEB-INF", a ne sera pas assez propre comme solution mais c'est efficace, et vous aurez seulement lancer la commande : "java org.apache.axis.client.AdminClient deploy.wsdd" L'arborescense du dossier Axis (avec l'utilisation du classpath) devra tre comme illustr dans la figure suivante :
Nous avons, lors de l'tape prcdente, demand au serveur " Axis " d'tre en mesure de traiter toutes les requtes " SOAP " correspondant notre service " sommer ". Cela signifie donc qu' la rception d'une requte " HTTP-SOAP ", le serveur pourra appliquer la mthode spcifie dans la requte une instance de la classe correspondant notre service (en lui passant, le cas chant des valeurs). Vous tes dsormais en mesure d'accder votre service l'URL suivante : http://localhost:8080/axis/services/sommer. Le nom " sommer " correspond au nom du service que nous avons indiqu dans le descripteur de dploiement. Vous pouvez alors constater que votre service a bien t dploy sur " Axis " en ayant en retour la page " html " suivante :
IV-D - Excution du web service par son alias

La dernire tape consiste mettre en oeuvre votre service qui est dsormais accessible travers tout le net ! Pour excuter une mthode de votre service et obtenir la rponse " SOAP " correspondante, vous tapez l'expression suivante dans votre navigateur : http://localhost:8080/axis/services/sommer?method=getsomme&a=2&b=3 Par rapport la mthode prcdente, vous prcisez ici le nom du web service par son alias (ici "sommer"). La rponse affiche est le contenu " SOAP ", c'est--dire un fichier " XML " comme :
V - Consommer le web service en Java

Jusqu' ce stade, nous avons toujours utilis le navigateur Web pour invoquer les services et visualiser (sous le format SOAP) les rsultats retourns. Nous allons tudier maintenant, un autre mode de communication avec les services plus adapt leur mise en oeuvre, et surtout l'intgration avec d'autres applications. Ce deuxime modle consiste la mise en oeuvre des Services Web depuis le langage Java en gnrant automatiquement la dfinition du Proxy ct client. Cela sous-entend la cration de toutes les interfaces et classes ncessaires la mise en oeuvre du service depuis Java. Ce modle est caractris par: Utilisation du stub ct client et du skeleton ct serveur Utilisation des interfaces reprsentant les types des objets Java manipuler
V-A - Cration du fichier de description du web service "wsdl"

Pour ce faire, nous utiliserons le mme service prcdent, dans le navigateur utiliser le menu "Fichier puis Enregistrer sous", Puis nommer le fichier "sommer.wsdl" dans le dossier "Tomcat 5.5\webapps\axis\WEB-INF". Note : "wsdl" signifie selon http://dico.developpez.com: Langage de description des web services, respectant la syntaxe XML. Il donne une dfinition abstraite des services, le dtail des types de donnes changes, les oprations possibles, le protocole utiliser ainsi que l'adresse (URL) du service.
V-B - Utilisation du gnrateur " WSDL2Java "

L'outil " Axis " qui permet la gnration des dfinitions Java ct client et ct serveur, s'appelle " org.apache.axis.wsdl.WSDL2Java ". L'invocation depuis une fentre DOS, est la commande: "java org.apache.axis.wsdl.WSDL2Java sommer.wsdl". Remarque : le fichier " sommer.wsdl " peut-tre cr simplement, comme on l'a dj fait, en sauvegardant le contenu de la fentre navigateur, lorsque l'on visualise la dfinition " wsdl " du service : http://localhost:8080/axis/services/sommer?wsdl . L'outil " WSDL2Java " gnre l'ensemble des dfinitions dans un sous-dossier correspondant au nom "targetNamespace="http://127.0.0.1:8080/axis/services/sommer"" du descripteur " wsdl ". En effet, les namespaces sont mapps en packages Java.
V-C - Dfinition du client Java

Avant de dfinir le client Java, je commence par clarifier quelques ambiguts qui peuvent vous passer par la tte: A quoi il sert le Stub gnr? Ce fichier est le seul point d'entre pour le web service, il contient toute l'information dont on a besoin pour invoquer le web service :noms des mthodes, types des paramtres et les types de retour, et c'est qui permet l'auteur du web service de protger son code Quels sont les fichiers aux quels j'ai besoin pour consommer le web service? NON, c'est seulement le serveur dployant le web service qui doit contenir les librairies Axis Quels sont les fichiers aux quels j'ai besoin pour consommer le web service? Nous aurons seulement besoin des fichiers gnrs (Stub) par la commande wsdl2java, il faut juste importer ces fichiers dans l'application et utiliser les interfaces prsentes dans ce Stub. On dfinit maintenant le client Java qui met en oeuvre les classes gnres lors de l'tape prcdente. Pour cela, votre client ressemblera ceci : Client Java
import import import public // // // // // // // // java.rmi.RemoteException; javax.xml.rpc.ServiceException; _1._0._0._127.axis.sommer_jws.*; class SommerClient { public static void main(String[] args) { Cration du service depuis le endpoint SommerService correspond au nom du service dans le fichier "wsdl" c'est la balise : wsdl:service name="sommerService" SommerService service = new SommerServiceLocator(); try { Utilisation du service pour obtenir un stub qui implemente le SDI (Service Definition Type ; i.e. PortType). Pour le typage, c'est la balise : wsdl:portType name="sommer" Pour le getsommer(), le sommer correspond la balise : wsdl:port binding="impl:sommerSoapBinding" name="sommer" Sommer port = service.getsommer(); int s; try { Mise en oeuvre du service par application directe des mthodes s = port.getsomme(2, 3); System.out.println("2+3 = " + s); } catch (RemoteException e1) { e1.printStackTrace(); } } catch (ServiceException e) { e.printStackTrace(); } }
//
Sous Eclipse vous aurez comme ceci (j'ai utilis "http://127.0.0.1" au lieu de "http://localhost", c'est pourquoi j'ai le chemin gnr "_1._0._0.127":
Pour connatre les noms des classes et interfaces utiliser, vous devez examiner le contenu du dossier contenant les classes et interfaces gnres ainsi que le fichier " wsdl " ayant permis cette gnration.
VI - Dsactivation du web service

Enfin pour retirer un service dploy, il suffit d'appliquer l'utilitaire " AdminClient ", crer un fichier " undeploy.wsdd " correspondant au service. Le contenu du fichier " undeploy.wsdd " sera toujours le mme, au nom de service prs. Pour le service " sommer ", nous aurons : Suppression du web service
<undeployment xmlns="http://xml.apache.org/axis/wsdd/"> <service name="sommer"/> </undeployment>
Ensuite, la ligne de commande est simplement : "java org.apache.axis.client.AdminClient undeploy.wsdd". Forum Java Web Services http://dico.developpez.com http://ws.apache.org/axis

WS Axis

Transféré par

Informations du document

Titre original

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

WS Axis

Transféré par

Droits d'auteur :

Formats disponibles

Dploiement et Appel aux web services Java avec Axis

par Mohamed KARAMI

Date de publication : 07/10/2006 Dernire mise jour : 29/10/2007

II - Lancement et configuration d'Axis

II-A - Configuration de Tomcat

II-B - Dmarrage de Tomcat

II-C - Dmarrage d'Axis

La validation teste l'existence des librairies requises par Axis:

III - Mthode de dploiement 1 III-A - Cration du web service

III-B - Dploiement du web service

III-C - Test du web service

IV-A - Compilation de la classe du web service

IV-B - Dfinition du descripteur de dploiement

Expliquons les diffrents lments :

IV-C - Dploiement du web service

IV-D - Excution du web service par son alias

V - Consommer le web service en Java

V-A - Cration du fichier de description du web service "wsdl"

V-B - Utilisation du gnrateur " WSDL2Java "

V-C - Dfinition du client Java

VI - Dsactivation du web service

Vous aimerez peut-être aussi