Lecture d'une réponse SOAP complète. Résumé. 4D Notes techniques. Par David ADAMS Note technique 4D FR Version 1 Date 1 Août 2004

Transcription

1 Lecture d'une réponse SOAP complète Par David ADAMS Note technique 4D FR Version 1 Date 1 Août 2004 Résumé 4ème Dimension version 2003 et ultérieures propose en natif la construction de clients de Services Web. Les appels à une méthode de Service Web génèrent des messages SOAP (Simple Object Access Protocol) envoyés via HTTP à un programme compatible SOAP. Le service Web distant peut être écrit en.net, Java, 4ème Dimension, ou quasiment n importe quel langage ou environnement de programmation contemporain. En interne, les messages SOAP suivent des règles strictes de formatage XML et d encodage des données. Ces règles sont définies par une série de standards interdépendants. Par défaut, le système de client de Services Web de 4ème Dimension gère toute la complexité de l analyse, de la navigation et de la conversion de valeurs entre XML et les types natifs de 4ème Dimension. 4D Notes techniques Copyright D SA - Tous droits réservés Tous les efforts ont été faits pour que le contenu de cette note technique présente le maximum de fiabilité possible. Néanmoins, les différents éléments composant cette note technique, et le cas échéant, le code, sont fournis sans garantie d'aucune sorte. L'auteur et 4D S.A. déclinent donc toute responsabilité quant à l'utilisation qui pourrait être faite de ces éléments, tant à l'égard de leurs utilisateurs que des tiers. Les informations contenues dans ce document peuvent faire l'objet de modifications sans préavis et ne sauraient en aucune manière engager 4D SA. La fourniture dulogiciel décrit dans ce document est régie par un octroi de licence dont les termes sont précisés par ailleurs dans la licence électronique figurant sur le support du Logiciel et de la Documentation afférente. Le logiciel et sa documentation ne peuvent être utilisés, copiés ou reproduits sur quelque support que ce soit et de quelque manière que ce soit, que conformément aux termes de cette licence. Aucune partie de ce document ne peut être reproduite ourecopiée de quelque manière que ce soit, électronique ou mécanique, y compris par photocopie, enregistrement, archivage outout autre procédé de stockage, de traitement et de récupération d'informations, pour d'autres buts que l'usage personnel de l'acheteur, et ce exclusivement aux conditions contractuelles, sans la permission explicite de 4D SA. 4D, 4D Calc, 4D Draw, 4D Write, 4D Insider, 4ème Dimension, 4D Server, 4D Compiler ainsi que les logos 4e Dimension, sont des marques enregistrées de 4D SA. Windows,Windows NT,Win 32s et Microsoft sont des marques enregistrées de Microsoft Corporation. Apple, Macintosh, Power Macintosh, LaserWriter, ImageWriter, QuickTime sont des marques enregistrées ou des noms commerciaux de Apple Computer,Inc. Mac2Win Software Copyright est un produit de Altura Software,Inc. 4D Write contient des éléments de "MacLink Plus file translation", un produit de DataViz, Inc,55 Corporate drive,trumbull,ct,usa. XTND Copyright D SA. Tous droits réservés. XTND Technology Copyright Claris Corporation.. Tous droits réservés ACROBAT Copyright , Secret Commercial Adobe Systems Inc.Tous droits réservés. ACROBAT est une marque enregistrée d'adobe Systems Inc. 1 / 6

2 Tous les autres noms de produits ou appellations sont des marques déposées ou des noms commerciaux appartenant à leurs propriétaires respectifs. 2 / 6

3 Lecture d'une réponse SOAP complète Résumé 4 ème Dimension version 2003 et ultérieures propose en natif la construction de clients de Service Web. Les appels à une méthode de Service Web génèrent des messages SOAP (Simple Object Access Protocol) envoyés via HTTP à un programme compatible SOAP. Le service Web distant peut être écrit en.net, Java, 4 ème Dimension, ou quasiment n importe quel langage ou environnement de programmation contemporain. En interne, les messages SOAP suivent des règles strictes de formatage XML et d encodage des données. Ces règles sont définies par une série de standards interdépendants. Par défaut, le système de client de Service Web de 4 ème Dimension gère toute la complexité de l analyse, de la navigation et de la conversion de valeurs entre XML et les types natifs de 4 ème Dimension. Il existe cependant des cas où les développeurs désirent ou préfèrent lire les réponses SOAP directement, entre autres : Pour déboguer les échanges SOAP ; Pour lire des paramètres de sortie SOAP non liés directement à des paramètres, variables ou tableaux de 4 ème Dimension ; Pour analyser directement les réponses à l aide des commandes d analyse XML natives ou de celles d un parseur XML externe ; Pour en savoir plus sur la structure et les contenus des réponses SOAP ; Pour acquérir une meilleure compréhension du fonctionnement du client SOAP de 4 ème Dimension. Heureusement, il est possible de lire de manière brute les réponses SOAP entrantes en utilisant le paramètre typecomposé lors de l appel à la commande APPELER WEB SERVICE. Cette note technique traite de la capture et de l extraction de valeurs à partir des réponses SOAP brutes. Exemple de méthode proxy SOAP Le code ci-dessous correspond à une méthode proxy SOAP appelant un service Web qui retourne trois valeurs (des retours à la ligne ont été rajoutés pour plus de clarté) : C_ENTIER LONG(proxy_longint) C_REEL(proxy_real) C_TEXTE(proxy_text) ` NOTE ` signifie "appelle cette methode sur cette machine sur le `port 8080". ` Mettez à jour si nécessaire cette URl dans votre contexte. APPELER WEB SERVICE(" "returnthreeresults";" Service dynamique ) Si (OK=1) LIRE RESULTAT WEB SERVICE(proxy_longint;"outSecondsSinceMidnight") LIRE RESULTAT WEB SERVICE(proxy_real;"outPi") 3 / 6

4 LIRE RESULTAT WEB SERVICE(proxy_text;"outServerVersion";*) ` Libération de la mémoire. Fin de si Le paramètre Web Service Dynamique Comme vous le constatez, APPELER WEB SERVICE est configurée pour utiliser le système Web Service dynamique. Dans ce cas, la réponse SOAP est automatiquement analysée en interne et de manière transparente par 4 ème Dimension. Les valeurs de la réponse peuvent être relues à l aide d appel à LIRE RESULTAT WEB SERVICE, comme dans les trois exemples d appels ci-dessus. La structure XML ci-dessous correspond à l intégralité du corps du message de la réponse SOAP. Les valeurs accessibles par le système automatique sont soulignées : <ns1:returnthreeresultsresponse SOAP-ENV:encodingStyle=" xmlns:ns1=" <outsecondssincemidnight xsi:type="xsd:float">40174</outsecondssincemidnight> <outpi xsi:type="xsd:float"> </outpi> <outserverversion xsi:type="xsd:string">version #0703</outServerVersion> </ns1:returnthreeresultsresponse> Le paramètre Web Service Manuel La méthode proxy reproduite ci-dessus peut être réécrite afin de récupérer la structure XML complète dans un BLOB, comme dans le code ci-dessous (des retours à la ligne ont été rajoutés pour plus de clarté) : ` NOTE ` signifie "appelle cette methode sur cette machine sur le `port 8080". ` Mettez à jour si nécessaire cette URl dans votre contexte. APPELER WEB SERVICE(" "returnthreeresults";" Service sortie manuel ) Si (OK=1) C_BLOB(proxy_fullResponse_blob) LIRE RESULTAT WEB SERVICE(proxy_fullResponse_blob;*) ` Libération de la mémoire. C_TEXTE(proxy_fullResponse_text) ` Recopie dans une variable texte pour l'affichage. proxy_fullresponse_text:=blob vers texte(proxy_fullresponse_blob;texte sans longueur ) Fin de si Le BLOB résultant comprend l intégralité du corps du message SOAP listé plus haut. Cette structure XML peut être copiée dans un texte, si elle ne dépasse pas caractères, ou analysée par la commande Analyser variable XML. Lire les valeurs XML 4 / 6

5 Lire de l XML brut n est guère attrayant. Heureusement, les commandes XML natives ou externes simplifient le processus de travail avec XML. La note technique "4D FR : Le composant XML_Utilities" procure du code pour lire les valeurs d éléments par nom. Par exemple, le code ci-dessous montre comment lire les trois valeurs contenues dans la structure XML précédente en utilisant la fonction xutil_getvalue du composant XML_Utilities. C_ALPHA(16;$xmlref) $xmlref:=analyser variable XML(proxy_fullResponse_blob) proxy_longint:=num(xutil_getvalue ($xmlref;"outsecondssincemidnight")) proxy_real:=num(xutil_getvalue ($xmlref;"outpi")) proxy_text:=xutil_getvalue ($xmlref;"outserverversion") FERMER XML($xmlref) `Fermer l'arbre XML et libère la mémoire occupée Avantages Les avantages de la lecture des réponses complètes méritent d être explicités : Lors du déboguage des échanges SOAP, il est plus facile de localiser les problèmes en regardant l XML brut. Par exemple, il est plus facile de voir si le serveur SOAP a renommé, ajouté ou supprimé des éléments depuis que le code du client SOAP a été généré. Pour des informations complémentaires sur la manière de capturer et examiner les messages SOAP, reportez-vous à l'ouvrage "4D Web Companion", à la note technique "4D FR : Lecture d une requête SOAP complète» ou à la note technique"4d fr : Détecter et suivre un problème TCP/IP ". La lecture manuelle des valeurs XML permet aux méthodes de client SOAP de relire des valeurs que 4 ème Dimension ne sait pas lier automatiquement à ses paramètres, variables ou tableaux. Cette approche est pertinente lorsque, par exemple, le serveur SOAP retourne différents éléments lors de différentes situations. LIRE RESULTAT WEB SERVICE, pour un élément qui n est pas présent dans la réponse courante, génère une erreur qui demande à être capturée et gérée. La lecture XML par du code personnalisée, comme les méthodes du composant XML_Utilities, ne provoque pas d erreurs lorsque des éléments ne sont pas retrouvés. Si un système inclut du code d analyse XML, il peut être plus simple et efficace de gérer les réponses avec le même code. Comme toujours, les avantages de ré-utilisation des fonctionnalités consistent dans la simplification du test, de la documentation, des améliorations et de la mise au point du code partagé. 4 ème Dimension accomplit un travail remarquable afin d épargner aux développeurs les détails de SOAP et XML. Cependant, lorsque vous travaillez et déboguez avec d autres environnements, il se révèle utile d en savoir plus sur la structure et le contenu des réponses SOAP. Expérimenter l option manuelle amène le développeur à une meilleure compréhension des caractéristiques 5 / 6

6 du client SOAP de 4 ème Dimension. Cela lui permet un jugement en connaissance de cause lors du choix de l approche de la construction de clients SOAP. Notes et limitations Quelques limitations de la technique décrite dans cette note méritent d être soulignées : L option Web Service sortie manuel retourne le corps entier du message SOAP, mais ne retourne pas l intégralité du message SOAP. En particulier, les entêtes éventuelles SOAP ne sont pas accessibles en 4D ème Dimension envoie des requêtes et lit des réponses SOAP via HTTP, le protocole du Web. Aucun entête HTTP contenu dans la réponse SOAP du serveur SOAP, y compris les cookies et les valeurs du code status, ne peut être relue. Si le serveur SOAP retourne une faute SOAP au lieu d une réponse comprenant des valeurs, APPELER WEB SERVICE ne retourne aucun résultat. 6 / 6