HTTPService  - AS3 Flex

Permet d’accéder à l’instance ChannelSet utilisée par le service. La classe ChannelSet peut être manuellement construite et assignée, ou elle sera dynamiquement créée afin d’utiliser les canaux configurés pour la destination de ce service.

Valeur indiquant comment traiter plusieurs appels au même service. La valeur par défaut est multiple. Les valeurs suivantes sont autorisées :

• multiple Les demandes existantes ne sont pas annulées et il incombe au développeur de vérifier la cohérence des données renvoyées en gérant avec soin le flux d’événements. Il s’agit de la valeur par défaut.
• single Une seule demande à la fois est autorisée sur l’opération ; les demandes multiples génèrent une erreur.
• last Effectuer une demande annule toute demande existante.

Type de contenu des demandes de service. La valeur par défaut est application/x-www-form-urlencoded, qui envoie des demandes comme un envoi HTTP POST normal avec des paires nom-valeur. application/xml envoie les demandes en tant qu’XML.

Nom de destination HTTPService dans le fichier services-config.xml. Si la destination n’est pas spécifiée, Flex utilise la destination DefaultHTTP. Si vous utilisez la propriété url mais voulez que les demandes atteignent le proxy via HTTPS, spécifiez DefaultHTTPS.

En-têtes HTTP personnalisés à envoyer à l’extrémité tierce. Si plusieurs en-têtes doivent être envoyés avec le même nom, la valeur doit être spécifiée en tant que tableau.

Résultat de la dernière invocation.

Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement resultForBinding .

Lorsque cette valeur est true, les objets anonymes renvoyés sont forcés sur des objets liables.

Méthode HTTP d’envoi de la demande. Les valeurs autorisées sont GET, POST, HEAD, OPTIONS, PUT, TRACE et DELETE. Les lettres minuscules sont converties en lettres majuscules. La valeur par défaut est GET.

Objet de paires nom-valeur utilisées en tant que paramètres de l’URL. Si la propriété contentType est définie sur application/xml, elle doit être un document XML.

Fournit un accès au délai d’attente de demande en secondes pour les messages envoyés. Une valeur égale ou inférieure à zéro empêche les délais d’attente de demande.

Valeur indiquant comment vous voulez désérialiser le résultat renvoyé par l’appel HTTP. La valeur de cette propriété est basée sur les éléments suivants :

• Si vous renvoyez ou non des données XML ou des paires nom-valeur.
• La manière dont vous voulez accéder aux résultats ; vous pouvez accéder aux résultats en tant qu’objet, texte ou XML.

La valeur par défaut est object. Les valeurs suivantes sont autorisées :

• object La valeur renvoyée est XML mais est analysée en tant qu’arborescence d’objets ActionScript. Il s’agit de la valeur par défaut.
• array La valeur renvoyée est XML et est analysée en tant qu’arborescence d’objets ActionScript. Cependant, si l’objet de niveau supérieur n’est pas un tableau, un nouveau tableau est créé et le résultat est défini comme constituant le premier élément. Si makeObjectsBindable est true, le tableau est enveloppé dans une classe ArrayCollection.
• xml La valeur renvoyée est XML et est renvoyée en tant qu’XML littéral dans un objet ActionScript XMLnode.
• flashvars La valeur renvoyée constitue du texte contenant des paires nom=valeur séparées par une esperluette, analysée en un objet ActionScript.
• text La valeur renvoyée constitue du texte et est située dans une colonne gauche.
• e4x La valeur renvoyée constitue des données XML et est renvoyée en tant qu’XML littéral dans un objet XML ActionScript, accessible via des expressions ECMAScript pour XML (E4X).

Adresse URL que l’objet HTTPService doit utiliser lorsqu’il calcule les URL relatives. Cette propriété n’est utilisée que si elle traverse le proxy. Lorsque la propriété useProxy est définie sur false, l’adresse URL relative est calculée automatiquement selon l’emplacement du SWF exécutant cette application. Si la propriété rootURL n’est pas définie explicitement, elle est automatiquement définie sur l’adresse URL de mx.messaging.config.LoaderConfig.url.

Fournit un adaptateur qui contrôle le processus de conversion du corps de la réponse HTTP en objets ActionScript et/ou de conversion des paramètres ou du corps vers le type contentType, l’URL et le corps de publication de la demande HTTP. Cela peut aussi être défini indirectement en définissant le format resultFormat en enregistrant un filtre SerializationFilter à l’aide de la méthode statique : SerializationFilter.registerFilterForResultFormat("formatName", filter)

Si true, un curseur occupé s’affiche lors de l’exécution d’un service. La valeur par défaut est false.

Emplacement du service. Si vous spécifiez l’url et une destination non par défaut, votre destination dans le fichier services-config.xml doit autoriser l’URL spécifiée.

Indique d’utiliser ou non le service proxy Flex. La valeur par défaut est false. Si vous ne spécifiez pas true pour les requêtes proxy via le serveur Flex, assurez-vous que Flash Player peut accéder à l’URL cible. Vous ne pouvez pas non plus utiliser les destinations définies dans le fichier services-config.xml si la propriété useProxy est définie sur false.

La valeur par défaut est false.

Fonction ActionScript utilisée pour décoder un résultat de service de XML. Lorsque le format resultFormat est un objet et que la propriété xmlDecode est définie, Flex utilise les données XML que le service HTTPService renvoie pour créer un objet. S’il n’est pas défini, le décodeur XMLDecoder par défaut est utilisé pour effectuer l’opération.

La fonction référencée par la propriété xmlDecode doit prendre un objet flash.xml.XMLNode comme paramètre et renvoyer un objet. Elle peut renvoyer n’importe quel type d’objet, mais elle doit renvoyer quelque chose. Renvoyer null ou undefined provoque une erreur.

   <mx:HTTPService id="hs" xmlDecode="xmlDecoder" url="myURL" resultFormat="object" contentType="application/xml">
        <mx:request><source/>
            <obj>{RequestObject}</obj>
        </mx:request>
   </mx:HTTPService>

function xmlDecoder (myXML)
{
 // Simplified decoding logic.
 var myObj = {};
 myObj.name = myXML.firstChild.nodeValue;
 myObj.honorific = myXML.firstChild.attributes.honorific;
 return myObj;
}

Fonction ActionScript utilisée pour coder une demande de service en tant que XML. Lorsque le type contentType d’une demande est application/xml et que l’objet de demande transmis est un objet, Flex tente d’utiliser la fonction spécifiée par la propriété xmlEncode pour le convertir en un objet flash.xml.XMLNode. Si la propriété xmlEncode n’est pas définie, Flex utilise le codeur XMLEncoder par défaut pour convertir le graphique d’objet en un objet flash.xml.XMLNode.

La propriété xmlEncode prend un objet et doit renvoyer un objet flash.xml.XMLNode. Dans ce cas, l’objet XMLNode peut être un objet flash.xml.XML, qui est une sous-classe de XMLNode, ou le premier enfant de l’objet flash.xml.XML, qui est l’élément obtenu d’une balise <mx:XML>. Renvoyer le type d’objet incorrect provoque une erreur. L’exemple suivant présente une balise <mx:HTTPService> qui spécifie une fonction xmlEncode :

  <mx:HTTPService id="hs" xmlEncode="xmlEncoder" url="myURL" resultFormat="object" contentType="application/xml">
        <mx:request><source/>
            <obj>{RequestObject}</obj>
        </mx:request>
   </mx:HTTPService>
    

function xmlEncoder (myObj)
{
  return new XML("");
}

Crée une nouvelle classe HTTPService. Si vous vous attendez à ce que le service effectue l’envoi à l’aide d’URL relatives, vous pouvez spécifier l’URL rootURL allant servir de base pour déterminer l’URL entière (par exemple, Application.application.url).

Annule la dernière invocation de service ou une invocation comportant l’ID spécifié. Même s’il se peut que l’opération de réseau se poursuive, aucun événement de résultat ou d’erreur n’est distribué.

Paramètres

Définit la propriété result de l’invocateur sur null. Cela est utile lorsque le résultat est un objet de grande taille qui n’est plus utilisé.

Paramètres

Interrompt la connexion réseau du service. Cette méthode n’attend pas que les opérations de réseau en attente se terminent.

Déconnecte l’utilisateur de la destination. La déconnexion d’une destination s’applique à tous les éléments connectés à l’aide du même canal tel que spécifié dans la configuration de serveur. Par exemple, si vous êtes connecté via le canal my-rtmp et que vous vous déconnectez à l’aide de l’un de vos composants RPC, tous les éléments qui étaient connectés via my-rtmp sont déconnectés.

Remarque : Adobe vous recommande d’utiliser la méthode mx.messaging.ChannelSet.logout() au lieu de cette méthode.

Eléments de l’API associés

Exécute une demande HTTPService. Les paramètres sont facultatifs, mais s’ils sont spécifiés, ils doivent être un objet contenant des paires nom-valeur ou un objet XML, selon la valeur contentType.

Paramètres

Définit les informations d’identification pour la destination à laquelle le service accède. Les informations d’identification sont appliquées à tous les services connectés via la même classe ChannelSet. Les services utilisant un proxy sur une destination distante devront appeler la méthode setRemoteCredentials() à la place.

Paramètres

Nom d’utilisateur et mot de passe utilisés pour authentifier un utilisateur lors de l’accès à l’URL HTTP. Ces données sont transmises dans le cadre de l’en-tête d’autorisation HTTP du proxy vers l’extrémité. Si la propriété useProxy est définie sur false, cette propriété est ignorée.

Paramètres

Distribué lorsqu’un appel HTTPService échoue.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

L’événement invoke est déclenché lorsqu’un appel HTTPService est invoqué à condition qu’une erreur ne soit pas générée avant que le canal ne tente d’envoyer le message.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Distribué lorsqu’un appel HTTPService réussit.

Les valeurs des propriétés de l’objet d’événement sont les suivantes :

Indique que les données envoyées par le service HTTP sont codées au format application/x-www-form-urlencoded.

Indique que les données envoyées par le service HTTP sont codées au format application/xml.

Indique que l’objet HTTPService utilise la destination DefaultHTTP.

Indique que l’objet HTTPService utilise la destination DefaultHTTP.

Indique qu’un résultat formaté XML n’a pas pu être analysé en une instance XML ou décodé en un objet.

Indique qu’un paramètre d’entrée n’a pas pu être codé en tant qu’XML.

Indique que la propriété useProxy a été définie sur false mais qu’aucune URL n’a été fournie.

Le format de résultat « array » est similaire à « object », mais la valeur renvoyée est toujours un tableau, de sorte que si le résultat renvoyé du format de résultat « object » n’est pas déjà un tableau, l’élément est ajouté à un nouveau tableau comme étant le premier élément.

Le format de résultat « e4x » spécifie que la valeur renvoyée est une instance XML, qui est accessible à l’aide d’expressions ECMAScript pour XML (E4X).

Le format de résultat « flashvars » spécifie que la valeur renvoyée constitue du texte contenant des paires nom=valeur séparées par une esperluette, analysée en un objet ActionScript.

Le format de résultat « object » spécifie que la valeur renvoyée est XML mais est analysée en tant qu’arborescence d’objets ActionScript. Il s’agit de la valeur par défaut.

Le format de résultat « text » spécifie que le texte de résultat HTTPService doit être une chaîne non traitée.

Le format de résultat « xml » spécifie que les résultats doivent être renvoyés en tant qu’instance flash.xml.XMLNode pointant vers le premier enfant du document flash.xml.XMLDocument parent.