| パッケージ | mx.rpc.soap |
| クラス | public class AbstractWebService |
| 継承 | AbstractWebService AbstractService Proxy |
| サブクラス | WebService |
| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
| プロパティ | 定義元 | ||
|---|---|---|---|
![]() | channelSet : ChannelSet
サービスが使用する ChannelSet へのアクセスを提供します。 | AbstractService | |
| convertParametersHandler : Function
フレームワーク開発者には、各 WebService 操作起動で渡すパラメーターを指定して呼び出す関数をインストールする必要がある場合があります。そのような開発者を主な対象としたオプション関数です。 | AbstractWebService | ||
| convertResultHandler : Function
フレームワーク開発者には、操作の結果を処理するフックをインストールしてから結果ハンドラーを通知する必要がある場合があります。そのような開発者を主な対象としたオプション関数です。 | AbstractWebService | ||
| description : String
現在アクティブなポートに対応するサービスの説明です。 | AbstractWebService | ||
| destination : String [オーバーライド]
サービスの宛先です。 | AbstractWebService | ||
| endpointURI : String
WebService の場所です。 | AbstractWebService | ||
| headers : Array [読み取り専用]
WebService に対して登録された SOAPHeaders の配列を返します。 | AbstractWebService | ||
| httpHeaders : Object
SOAP エンドポイントに送信されるカスタム HTTP ヘッダーです。 | AbstractWebService | ||
| makeObjectsBindable : Boolean
この値が true の場合、返された匿名オブジェクトは強制的にバインド可能オブジェクトにされます。 | AbstractWebService | ||
![]() | managers : Array
マネージャープロパティは、このサービスの動作を修正するデータマネージャーのリストを格納します。 | AbstractService | |
![]() | operations : Object
通常、Operations 配列は MXML タグを使ってサービスを作成した場合に、MXML コンパイラーによってのみ設定されます。 | AbstractService | |
| port : String
この WebService が使用する必要のある WSDL ドキュメント内のポートを指定します。 | AbstractWebService | ||
| ready : Boolean [読み取り専用]
WebService が要求を行う準備ができたかどうかを指定します。 | AbstractWebService | ||
![]() | requestTimeout : int
送信メッセージの要求タイムアウト時間(秒単位)に対するアクセスを提供します。 | AbstractService | |
| rootURL : String
相対 URL を計算するときに、WebService が使用する必要のある URL です。 | AbstractWebService | ||
| service : String
この WebService が使用する必要のある WSDL ドキュメント内のサービスを指定します。 | AbstractWebService | ||
| useProxy : Boolean
Flex のプロキシサービスを利用するかどうかを指定します。 | AbstractWebService | ||
| xmlSpecialCharsFilter : Function
単純なコンテンツをエンコードする前に XML 特殊文字のエスケープに使用されるカスタム関数です。 | AbstractWebService | ||
| メソッド | 定義元 | ||
|---|---|---|---|
新しい WebService を作成します。 | AbstractWebService | ||
この Web サービスのすべての操作に適用されるヘッダーを追加します。 | AbstractWebService | ||
addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
この WebService のすべての操作に適用されるヘッダーを追加します。 | AbstractWebService | ||
すべての操作に適用されるヘッダーをクリアします。 | AbstractWebService | ||
![]() |
サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。 | AbstractService | |
QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。 | AbstractWebService | ||
![]() |
指定された名前の Operation を返します。 | AbstractService | |
![]() |
サービスを初期化するために呼び出されます。 | AbstractService | |
![]() |
ユーザーを宛先からログアウトします。 | AbstractService | |
指定された QName を持つヘッダーをすべての操作から削除します。 | AbstractWebService | ||
![]() |
サーバー側で Data Services を使用している場合にサービスがアクセスする宛先の資格情報を設定します。 | AbstractService | |
[オーバーライド]
ユーザーが WebService にアクセスするときに、ユーザーを認証するためのユーザー名とパスワードです。 | AbstractWebService | ||
| 定数 | 定義元 | ||
|---|---|---|---|
| DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP" [静的]
プロキシを介して Web サービスを呼び出す場合の HTTP 接続のデフォルトの宛先です。 | AbstractWebService | ||
| DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS" [静的]
プロキシを介して Web サービスを呼び出す場合の HTTPS 接続のデフォルトの宛先です。 | AbstractWebService | ||
convertParametersHandler | プロパティ |
public var convertParametersHandler:Function| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
フレームワーク開発者には、各 WebService 操作起動で渡すパラメーターを指定して呼び出す関数をインストールする必要がある場合があります。そのような開発者を主な対象としたオプション関数です。関数はパラメーターの配列を取り、変更されている可能性のある配列を返します。関数の定義は function myParametersFunction(parameters:Array):Array のようになります。
convertResultHandler | プロパティ |
public var convertResultHandler:Function| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
フレームワーク開発者には、操作の結果を処理するフックをインストールしてから結果ハンドラーを通知する必要がある場合があります。そのような開発者を主な対象としたオプション関数です。関数の定義は function myConvertResultsFunction(result: operation:AbstractOperation): のようになります。これに結果が返されるのは、makeObjectsBindable 変換が行われた直後、結果イベントが作成される前です。
description | プロパティ |
destination | プロパティ |
endpointURI | プロパティ |
headers | プロパティ |
httpHeaders | プロパティ |
makeObjectsBindable | プロパティ |
port | プロパティ |
ready | プロパティ |
rootURL | プロパティ |
rootURL:String| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
相対 URL を計算するときに、WebService が使用する必要のある URL です。 このプロパティは、プロキシを介するときにだけ使用されます。 useProxy プロパティが to false に設定されている場合、相対 URL はこのアプリケーションを実行する SWF の場所に基づいて自動的に計算されます。 明示的に設定されていない場合、rootURL は自動的に mx.messaging.config.LoaderConfig.url の URL に設定されます。
実装
public function get rootURL():String public function set rootURL(value:String):voidservice | プロパティ |
useProxy | プロパティ |
useProxy:Boolean| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
Flex のプロキシサービスを利用するかどうかを指定します。 デフォルト値は false です。true を Flex サーバーを介したプロキシ要求に設定しない場合は、Flash Player がターゲット URL に確実に到達できるようにする必要があります。 また、useProxy プロパティが false に設定されている場合、services-config.xml ファイルで定義された宛先を使用することはできません。
デフォルト値: false。
実装
public function get useProxy():Boolean public function set useProxy(value:Boolean):voidxmlSpecialCharsFilter | プロパティ |
xmlSpecialCharsFilter:Function| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
単純なコンテンツをエンコードする前に XML 特殊文字のエスケープに使用されるカスタム関数です。 操作レベルで明確に上書きされない限り、Web サービスのすべての操作に対して有効です。 何も指定しない場合、デフォルトの関数は IXMLEncoder の特定の実装によって設定されたものです。
実装
public function get xmlSpecialCharsFilter():Function public function set xmlSpecialCharsFilter(value:Function):voidAbstractWebService | () | コンストラクター |
public function AbstractWebService(destination:String = null, rootURL:String = null)| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
新しい WebService を作成します。 宛先を指定する場合、その宛先は services-config.xml 内のエントリと一致している必要があります。 宛先を指定しない場合、WebService では DefaultHTTP 宛先が使用されます。 相対 URL を使用してこの WebService の WSDL ドキュメントを検索することを前提としている場合は、rootURL が必要です。
destination:String (default = null) — 宛先です。services-config.xml ファイル内の宛先名と一致する必要があります。
| |
rootURL:String (default = null) — 相対 URL を計算するときに、WebService が使用する必要のある URL です。
|
addHeader | () | メソッド |
addSimpleHeader | () | メソッド |
public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
この WebService のすべての操作に適用されるヘッダーを追加します。
パラメーター
qnameLocal:String — ヘッダー QName のローカル名です。
| |
qnameNamespace:String — ヘッダー QName の名前空間です。
| |
headerName:String — ヘッダーの名前です。
| |
headerValue:String — ヘッダーの値です。
|
clearHeaders | () | メソッド |
public function clearHeaders():void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
すべての操作に適用されるヘッダーをクリアします。
getHeader | () | メソッド |
public function getHeader(qname:QName, headerName:String = null):SOAPHeader| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。
パラメーター
qname:QName — SOAPHeader の QName。
| |
headerName:String (default = null) — (オプション) SOAPHeader コンテンツ内のヘッダーの名前。
|
SOAPHeader — QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。
|
removeHeader | () | メソッド |
setRemoteCredentials | () | メソッド |
override public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
ユーザーが WebService にアクセスするときに、ユーザーを認証するためのユーザー名とパスワードです。 これらは、HTTP 認証ヘッダーの一部としてプロキシからエンドポイントに渡されます。 useProxy が false の場合、このプロパティは無視されます。
パラメーター
remoteUsername:String — リモートエンドポイントに渡すユーザー名です。
| |
remotePassword:String — リモートエンドポイントに渡すパスワードです。
| |
charset:String (default = null) — リモート資格情報をエンコードする際に使用する文字セットエンコーディングです。デフォルトは null で、旧式文字セットの ISO-Latin-1 を示します。 サポートされているその他の文字セットは "UTF-8" のみです。
|
DEFAULT_DESTINATION_HTTP | 定数 |
public static const DEFAULT_DESTINATION_HTTP:String = "DefaultHTTP"| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
プロキシを介して Web サービスを呼び出す場合の HTTP 接続のデフォルトの宛先です。宛先の指定なしで useProxy プロパティを true に設定した場合は、デフォルトの宛先を使用して、要求が Web サービスのエンドポイントにルーティングされます。
デフォルトの宛先を使用する場合は、クライアント上の WSDL と endpointURI を指定する必要があります。デフォルト以外のプロキシ宛先を使用する場合は、宛先構成の中に指定された WSDL と endpointURI を使用できます。
DEFAULT_DESTINATION_HTTPS | 定数 |
public static const DEFAULT_DESTINATION_HTTPS:String = "DefaultHTTPS"| 言語バージョン: | ActionScript 3.0 |
| 製品バージョン: | Flex 3 |
| ランタイムバージョン: | Flash Player 9, AIR 1.1 |
プロキシを介して Web サービスを呼び出す場合の HTTPS 接続のデフォルトの宛先です。宛先の指定なしで useProxy プロパティを true に設定した場合は、デフォルトの宛先を使用して、要求が Web サービスのエンドポイントにルーティングされます。
デフォルトの宛先を使用する場合は、クライアント上の WSDL と endpointURI を指定する必要があります。デフォルト以外のプロキシ宛先を使用する場合は、宛先構成の中に指定された WSDL と endpointURI を使用できます。
Tue Jun 12 2018, 10:34 AM Z
継承されるパブリックプロパティを隠す
継承されるパブリックプロパティを表示