Lecture d’une réponse SOAP complète

David Adams

4e Dimension version 2003 et ultérieures propose en natif la construction de clients de Services Web. ♪

- Titre : Lecture d’une réponse SOAP complète

- Auteur : David Adams

- Parution : 1 août 2004

- Licence : Ce document est issu de https://www.developpez.com et reste la propriété exclusive de son auteur. La copie, modification et/ou distribution par quelque moyen que ce soit est soumise à l'obtention préalable de l'autorisation de l'auteur.

Sommaire

- I. Résumé

- II. Exemple de méthode proxy SOAP

- III. Le paramètre Web Service Dynamique

- IV. Le paramètre Web Service Manuel

- V. Lire les valeurs XML

- VI. Avantages

- VII. Notes et limitations

- VIII. Base exemple

I - Résumé

4e 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, 4e 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 4e 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 4e 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 4e 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 4e 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.

II - 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é) :

1. C_ENTIER LONG(proxy_longint)

2. C_REEL(proxy_real)

3. C_TEXTE(proxy_text)

5. ` ***********

6. ` NOTE

7. ` ***********

8. ` http://127.0.0.1:8080/ signifie "appelle cette methode sur cette machine sur le `port 8080".

9. ` Mettez à jour si nécessaire cette URl dans votre contexte.

10. ` ***********

11. APPELER WEB SERVICE("http://127.0.0.1:8080/4DSOAP/";"A_WebService#returnThreeResults";

12. "returnThreeResults";"http://www.4d.com/namespace/default";Web Service dynamique )

13. Si (OK=1)

14. LIRE RESULTAT WEB SERVICE(proxy_longint;"outSecondsSinceMidnight")

15. LIRE RESULTAT WEB SERVICE(proxy_real;"outPi")

16. LIRE RESULTAT WEB SERVICE(proxy_text;"outServerVersion";*) ` Libération de la mémoire

17. Fin de si

III - 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 4e 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="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="http://www.4d.com/namespace/default">
<outSecondsSinceMidnight xsi:type="xsd:float">40174</outSecondsSinceMidnight>
<outPi xsi:type="xsd:float">3.141592653589793116</outPi>
<outServerVersion xsi:type="xsd:string">Version #0703</outServerVersion>
</ns1:returnThreeResultsResponse>

IV - 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é) :

1. ` ***********

2. ` NOTE

3. ` ***********

4. ` http://127.0.0.1:8080/ signifie "appelle cette methode sur cette machine sur le `port 8080".

5. ` Mettez à jour si nécessaire cette URl dans votre contexte.

6. ` ***********

7. APPELER WEB SERVICE("http://127.0.0.1:8080/4DSOAP/";"A_WebService#returnThreeResults";

8. "returnThreeResults";"http://www.4d.com/namespace/default";Web Service sortie manuel )

9. Si (OK=1)

10. C_BLOB(proxy_fullResponse_blob)

11. LIRE RESULTAT WEB SERVICE(proxy_fullResponse_blob;*) ` Libération de la mémoire

12. C_TEXTE(proxy_fullResponse_text) ` Recopie dans une variable texte pour l’affichage.

13. proxy_fullResponse_text:=BLOB vers texte(proxy_fullResponse_blob;Texte sans longueur )

14. 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 32 000 caractères, ou analysée par la commande Analyser variable XML.

V - Lire les valeurs XML

Lire du 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-200407-20-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.

1. C_ALPHA(16;$xmlref)

2. $xmlref:=Analyser variable XML(proxy_fullResponse_blob)

3. proxy_longint:=Num(xutil_GetValue ($xmlref;"outSecondsSinceMidnight"))

4. proxy_real:=Num(xutil_GetValue ($xmlref;"outPi"))

5. proxy_text:=xutil_GetValue ($xmlref;"outServerVersion")

6. FERMER XML($xmlref) `Fermer l’arbre XML et libère la mémoire occupée

VI - Avantages

Les avantages de la lecture des réponses complètes méritent d’être explicités.

- Lors du débogage des échanges SOAP, il est plus facile de localiser les problèmes en regardant le 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-200407-21-FR : Lecture d’une requête SOAP complète » ou à la note technique »4D-200308-22-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 4e 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.

- Expérimenter l’option manuelle amène le développeur à une meilleure compréhension des caractéristiques du client SOAP de 4e Dimension. Cela lui permet un jugement en connaissance de cause lors du choix de l’approche de la construction de clients SOAP.

VII - 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 éventuels SOAP ne sont pas accessibles en 4D 2003.

- 4e 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.

VIII - Base exemple

Téléchargez la base exemple :

base pour Windows

base pour MacOs