HTTPService  - AS3 Flex

サービスが使用する ChannelSet へのアクセスを提供します。 ChannelSet は手動で作成して割り当てることができます。また、このサービスの destination に対して設定済みのチャネルを使って、動的に作成することもできます。

同一サービスに対する複数の呼び出しの処理方法を示す値です。 デフォルト値は multiple です。 使用できる値は次のとおりです。

• multiple：既存の要求はキャンセルされません。返されるデータは開発者が責任を持って、イベントストリームを慎重に管理することで整合性を確保する必要があります。 これがデフォルト値です。
• single：処理では一度に 1 つの要求のみが認められ、複数の要求を送信すると処理が失敗します。
• last：要求を送信すると、既存の要求がすべてキャンセルされます。

サービス要求のコンテンツタイプです。 デフォルトは application/x-www-form-urlencoded で、名前と値のペアを持つ通常の HTTP POST のような要求を送信します。application/xml は要求を XML として送信します。

services-config.xml ファイル内の HTTPService 宛先名です。 指定されていない場合、Flex は DefaultHTTP 宛先を使用します。 url プロパティを使用しているが、要求を HTTPS 経由でプロキシに到達させる場合は、DefaultHTTPS を指定します。

サードパーティーのエンドポイントに送信されるカスタム HTTP ヘッダーです。複数のヘッダーを同じ名前で送信する必要がある場合は、値を配列として指定します。

最後の呼び出しの結果です。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 resultForBinding イベントが送出されます。

この値が true の場合、返された匿名オブジェクトは強制的にバインド可能オブジェクトにされます。

要求を送信するための HTTP メソッドです。 有効な値は GET、POST、HEAD、OPTIONS、PUT、TRACE および DELETE です。 小文字は大文字に変換されます。 デフォルト値は GET です。

URL に渡すパラメーターとして使用される、名前と値のペアのオブジェクトです。 contentType プロパティが application/xml に設定されている場合は、XML ドキュメントにする必要があります。

送信メッセージの要求タイムアウト時間（秒単位）に対するアクセスを提供します。 ゼロ以下の値を設定すると、要求はタイムアウトになりません。

HTTP 呼び出しから返された結果を非直列化する方法を示す値です。 この値は次の項目に基づいて決定します。

• XML または名前と値のペアのどちらが返されるのか。
• 結果にアクセスする方法。結果にはオブジェクト、テキストまたは XML としてアクセスできます。

デフォルト値は object です。 使用できる値は次のとおりです。

• object：返される値は XML であり、ActionScript オブジェクトのツリーとして解析されます。 これはデフォルトの設定です。
• array：返される値は XML で、ActionScript オブジェクトのツリーとして解析されますが、トップレベルのオブジェクトが配列でない場合、新しい配列が作成されて結果が最初のアイテムとして設定されます。 makeObjectsBindable が true の場合、配列は ArrayCollection 内にラップされます。
• xml：返される値は XML です。これは ActionScript XMLnode オブジェクト内のリテラル XML として返されます。
• flashvars：返される値は、アンパサンドで区切られた名前と値のペアを含むテキストで、ActionScript オブジェクトに解析されます。
• text：返される値はテキストで、未処理のまま保持されます。
• e4x：返される値は XML で、ActionScript XML オブジェクト内のリテラル XML として返されます。XML（E4X）式用の ECMAScript を使ってアクセスできます。

相対 URL を計算するときに、HTTPService オブジェクトが使用する必要のある URL です。 このプロパティは、プロキシを介するときにだけ使用されます。 useProxy プロパティが false に設定されている場合、相対 URL はこのアプリケーションを実行する SWF の場所に基づいて自動的に計算されます。 明示的に設定されていない場合、rootURL は自動的に mx.messaging.config.LoaderConfig.url の URL に設定されます。

アダプターを提供します。このアダプターは、HTTP 応答本文を ActionScript オブジェクトに変換し、パラメーターまたは本文を contentType、URL および HTTP 要求の本文後に調整するプロセスを制御します。resultFormat を設定することで間接的に設定することもできます。そうするには、静的メソッド SerializationFilter.registerFilterForResultFormat（"formatName"、フィルター）を使用してSerializationFilter を登録します。

true の場合、サービスの実行中にビジーカーソルが表示されます。 デフォルト値は false です。

サービスの場所を表します。 url とデフォルトでない宛先を指定した場合、services-config.xml ファイル内の宛先で、指定された URL が使用可能でなければなりません。

Flex のプロキシサービスを利用するかどうかを指定します。 デフォルト値は false です。true を指定しない場合（Flex サーバーを介して要求をプロキシしない場合）は、プレーヤーがターゲット URL に確実に到達できるようにする必要があります。 また、useProxy プロパティが false に設定されている場合、services-config.xml ファイルで定義された宛先を使用することはできません。

デフォルト値： false。

サービス結果を XML からデコードする際に使用される ActionScript 関数です。 resultFormat がオブジェクトで、xmlDecode プロパティが設定されている場合、Flex は HTTPService が返す XML を使用してオブジェクトを作成します。 それが定義されていない場合は、デフォルトの XMLDecoder を使用してこの処理が実行されます。

xmlDecode プロパティで参照される関数は、flash.xml.XMLNode オブジェクトをパラメーターとして使用してオブジェクトを返す必要があります。 返されるオブジェクトはどのようなタイプでも構いませんが、必ずいずれかのオブジェクトが返される必要があります。 null または undefined が返されると失敗が発生します。

   <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;
}

サービス要求を XML にエンコードするために使用される ActionScript 関数です。 要求の contentType が application/xml で、渡された要求オブジェクトが Object の場合、Flex は xmlEncode プロパティで指定された関数を使用して flash.xml.XMLNode オブジェクトに変換しようとします。xmlEncode プロパティが設定されていない場合、Flex はデフォルトの XMLEncoder を使用して、オブジェクトグラフを flash.xml.XMLNode オブジェクトに変換します。

xmlEncode プロパティは Object を使用して、flash.xml.XMLNode オブジェクトを返す必要があります。 この場合、XMLNode オブジェクトは XMLNode のサブクラスである flash.xml.XML オブジェクトでも、<mx:XML> タグで取得できる flash.xml.XML オブジェクトの最初の子でも構いません。 誤ったタイプのオブジェクトが返されると、処理が失敗します。 次に、xmlEncode 関数を指定した <mx:HTTPService> タグの例を示します。

  <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("");
}

新しい HTTPService を作成します。サービスで相対 URL による送信を行う場合、完全な URL を決定するための基礎となる rootURL を指定できます。例えば、Application.application.url と指定します。

最後のサービス呼び出しまたは指定された ID を持つ呼び出しをキャンセルします。ネットワーク処理が続行する場合でも、result イベントや fault イベントは送出されません。

パラメーター

インボーカの result プロパティを null に設定します。 これは呼び出しの結果が、既に使用されていない大きなオブジェクトであった場合に便利です。

パラメーター

サービスのネットワーク接続を切断します。 このメソッドは、未処理のネットワーク操作が完了するまで待つことはしません。

ユーザーを宛先からログアウトします。宛先からのログアウトは、サーバー設定で指定されているものと同じチャネルを使用して接続されているあらゆるものに適用されます。 例えば、my-rtmp チャネル上で接続しており、RPC コンポーネントのいずれかを使用してログアウトすると、my-rtmp 上で接続していたあらゆるユーザーがログアウトされます。

メモ：このメソッドではなく mx.messaging.ChannelSet.logout() メソッドを使用することをお勧めします。

関連する API エレメント

HTTPService 要求を実行します。 パラメーターはオプションですが、指定する場合は contentType に応じて、名前と値のペアの入ったオブジェクトまたは XML オブジェクトにする必要があります。

パラメーター

サービスがアクセスする宛先の証明書を設定します。 証明書は、同じ ChannelSet 上で接続されているすべてのサービスに適用されます。リモート宛先に対してプロキシを使用するサービスは、代わりに setRemoteCredentials() メソッドを呼び出す必要があります。

パラメーター

ユーザーが HTTP URL にアクセスするときに、ユーザーを認証するためのユーザー名とパスワードです。 これらは、HTTP 認証ヘッダーの一部としてプロキシからエンドポイントに渡されます。 useProxy プロパティが false に設定されている場合、このプロパティは無視されます。

パラメーター

HTTPService 呼び出しが失敗したときに送出されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

チャネルがメッセージの送信を試みる前にエラーがスローされない限り、HTTPService 呼び出しが実行されると、invoke イベントが開始されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

HTTPService 呼び出しが正常に結果を返したときに送出されます。

イベントオブジェクトの各プロパティには次の値が設定されています。

HTTP サービスによって送信中のデータが、application/x-www-form-urlencoded としてエンコードされることを示します。

HTTP サービスによって送信中のデータが、application/xml としてエンコードされることを示します。

HTTPService オブジェクトが DefaultHTTP 宛先を使用することを示します。

HTTPService オブジェクトが DefaultHTTPS 宛先を使用することを示します。

XML 形式の結果を XML インスタンスに解析できなかったか、オブジェクトにデコードできなかったことを示します。

入力パラメーターを XML としてエンコードできなかったことを示します。

useProxy プロパティが false に設定されたが、URL が提供されなかったことを示します。

結果フォーマット "array" は "object" と同様です。ただし、この結果フォーマットで返される値は常に配列で、結果フォーマット "object" から返された結果が配列になっていない場合に、そのアイテムが最初のアイテムとして新しい配列に追加されるようにします。

結果フォーマットが "e4x" の場合、返される値は XML インスタンスです。このインスタンスには、XML（E4X）式用の ECMAScript を使用してアクセスできます。

結果フォーマットが "flashvars" の場合、返される値はアンパサンドで区切られた名前と値のペアを含むテキストで、ActionScript オブジェクトに解析されます。

結果フォーマットが "object" の場合、返される値は XML で、ただし ActionScript オブジェクトのツリーとして解析されます。 これはデフォルトの設定です。

結果フォーマットが "text" の場合、HTTPService 結果テキストは未処理のストリングとなります。

結果フォーマットが "xml" の場合、結果は、親 flash.xml.XMLDocument の最初の子を指定する flash.xml.XMLNode インスタンスとして返されます。