パッケージmx.rpc.soap
クラスpublic class AbstractWebService
継承AbstractWebService Inheritance AbstractService Inheritance Proxy Inheritance Object
サブクラス WebService

AbstractWebService は、SOAP ベースの Web サービスに RPC アクセスを提供する実装の抽象基本クラスです。 このクラスは、実行時に WSDL 記述をロードしません。



パブリックプロパティ
 プロパティ定義元
 InheritedchannelSet : ChannelSet
サービスが使用する ChannelSet へのアクセスを提供します。
AbstractService
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  description : String
現在アクティブなポートに対応するサービスの説明です。
AbstractWebService
  destination : String
[override] サービスの宛先です。
AbstractWebService
  endpointURI : String
WebService の場所です。
AbstractWebService
  headers : Array
[読み取り専用] WebService に対して登録された SOAPHeaders の配列を返します。
AbstractWebService
  httpHeaders : Object
SOAP エンドポイントに送信されるカスタム HTTP ヘッダです。
AbstractWebService
  makeObjectsBindable : Boolean
この値が true の場合、返された匿名オブジェクトは強制的にバインド可能オブジェクトにされます。
AbstractWebService
 Inheritedmanagers : Array
マネージャプロパティは、このサービスの動作を修正するデータマネージャのリストを格納します。
AbstractService
 Inheritedoperations : Object
通常、Operations 配列は MXML タグを使ってサービスを作成した場合に、MXML コンパイラによってのみ設定されます。
AbstractService
  port : String
この WebService が使用する必要のある WSDL ドキュメント内のポートを指定します。
AbstractWebService
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  ready : Boolean
[読み取り専用] WebService が要求を行う準備ができたかどうかを指定します。
AbstractWebService
 InheritedrequestTimeout : int
送信メッセージの要求タイムアウト時間(秒単位)に対するアクセスを提供します。
AbstractService
  rootURL : String
相対 URL を計算するときに、WebService が使用する必要のある URL です。
AbstractWebService
  service : String
この WebService が使用する必要のある WSDL ドキュメント内のサービスを指定します。
AbstractWebService
  useProxy : Boolean
Flex のプロキシサービスを利用するかどうかを指定します。
AbstractWebService
  xmlSpecialCharsFilter : Function
単純なコンテンツをエンコードする前に XML 特殊文字のエスケープに使用されるカスタム関数です。
AbstractWebService
パブリックメソッド
 メソッド定義元
  
AbstractWebService(destination:String = null, rootURL:String = null)
新しい WebService を作成します。
AbstractWebService
  
この Web サービスのすべての操作に適用されるヘッダを追加します。
AbstractWebService
  
addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void
この WebService のすべての操作に適用されるヘッダを追加します。
AbstractWebService
  
すべての操作に適用されるヘッダをクリアします。
AbstractWebService
 Inherited
サービスのネットワーク接続を切断して、保留されている要求のすべての応答側を削除します。
AbstractService
  
getHeader(qname:QName, headerName:String = null):SOAPHeader
QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。
AbstractWebService
 Inherited
指定された名前の Operation を返します。
AbstractService
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
サービスを初期化するために呼び出されます。
AbstractService
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
ユーザーを宛先からログアウトします。
AbstractService
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
  
removeHeader(qname:QName, headerName:String = null):void
指定された QName を持つヘッダをすべての操作から削除します。
AbstractWebService
 Inherited
setCredentials(username:String, password:String, charset:String = null):void
サーバー側で Data Services を使用している場合にサービスがアクセスする宛先の資格情報を設定します。
AbstractService
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
  
setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void
[override] ユーザーが WebService にアクセスするときに、ユーザーを認証するためのユーザー名とパスワードです。
AbstractWebService
 Inherited
指定されたオブジェクトのストリング表現を返します。
Object
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
イベント
 イベント 概要 定義元
 Inheritedfault イベントは、サービス呼び出しが失敗した場合に送出されます。操作自体は、このイベントを処理しません。AbstractService
 Inheritedチャネルがメッセージの送信を試行する前にエラーがスローされない限り、サービスの操作が呼び出されたときに、invoke イベントが送出されます。AbstractService
 Inheritedresult イベントは、サービス呼び出しから制御が正常に戻された場合に送出されます。操作自体は、このイベントを処理しません。AbstractService
パブリック定数
 定数定義元
  DEFAULT_DESTINATION_HTTP : String = "DefaultHTTP"
[静的] プロキシを介して Web サービスを呼び出す場合の HTTP 接続のデフォルトの宛先です。
AbstractWebService
  DEFAULT_DESTINATION_HTTPS : String = "DefaultHTTPS"
[静的] プロキシを介して Web サービスを呼び出す場合の HTTPS 接続のデフォルトの宛先です。
AbstractWebService
プロパティの詳細
descriptionプロパティ
description:String

現在アクティブなポートに対応するサービスの説明です。



実装
    public function get description():String
    public function set description(value:String):void
destinationプロパティ 
destination:String[override]

サービスの宛先です。この値は、services-config.xml ファイル内の宛先エントリと一致している必要があります。



実装
    override public function get destination():String
    override public function set destination(value:String):void
endpointURIプロパティ 
endpointURI:String

WebService の場所です。 通常、サービスの場所は WSDL ドキュメントで指定されますが、このプロパティを設定してその場所をオーバーライドすることもできます。



実装
    public function get endpointURI():String
    public function set endpointURI(value:String):void
headersプロパティ 
headers:Array  [読み取り専用]

WebService に対して登録された SOAPHeaders の配列を返します。



実装
    public function get headers():Array
httpHeadersプロパティ 
httpHeaders:Object

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



実装
    public function get httpHeaders():Object
    public function set httpHeaders(value:Object):void
makeObjectsBindableプロパティ 
makeObjectsBindable:Boolean

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



実装
    public function get makeObjectsBindable():Boolean
    public function set makeObjectsBindable(value:Boolean):void
portプロパティ 
port:String

この WebService が使用する必要のある WSDL ドキュメント内のポートを指定します。



実装
    public function get port():String
    public function set port(value:String):void
readyプロパティ 
ready:Boolean  [読み取り専用]

WebService が要求を行う準備ができたかどうかを指定します。



実装
    public function get ready():Boolean
rootURLプロパティ 
rootURL:String

相対 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):void
serviceプロパティ 
service:String

この WebService が使用する必要のある WSDL ドキュメント内のサービスを指定します。



実装
    public function get service():String
    public function set service(value:String):void
useProxyプロパティ 
useProxy:Boolean

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

デフォルト値 : false.



実装
    public function get useProxy():Boolean
    public function set useProxy(value:Boolean):void
xmlSpecialCharsFilterプロパティ 
xmlSpecialCharsFilter:Function

単純なコンテンツをエンコードする前に XML 特殊文字のエスケープに使用されるカスタム関数です。 操作レベルで明確に上書きされない限り、Web サービスのすべての操作に対して有効です。 何も提供されていない場合は、IXMLEncoder の特定の実装によって設定されたものがデフォルトで使用されます。



実装
    public function get xmlSpecialCharsFilter():Function
    public function set xmlSpecialCharsFilter(value:Function):void
コンストラクタの詳細
AbstractWebService()コンストラクタ
public function AbstractWebService(destination:String = null, rootURL:String = null)

新しい WebService を作成します。 宛先を指定する場合、その宛先は services-config.xml 内のエントリと一致している必要があります。 宛先を指定しない場合、WebService では DefaultHTTP 宛先が使用されます。 相対 URL を使用してこの WebService の WSDL ドキュメントを検索することを前提としている場合は、rootURL が必要です。

パラメータ
destination:String (default = null)
 
rootURL:String (default = null)
メソッドの詳細
addHeader()メソッド
public function addHeader(header:Object):void

この Web サービスのすべての操作に適用されるヘッダを追加します。 ヘッダは XML インスタンスのプリエンコード形式で提供できます。また、エンコードを内部 SOAP エンコーダに任せる SOAPHeader インスタンスとして提供することもできます。

パラメータ

header:Object — すべての操作に追加する SOAP ヘッダです。

addSimpleHeader()メソッド 
public function addSimpleHeader(qnameLocal:String, qnameNamespace:String, headerName:String, headerValue:String):void

この WebService のすべての操作に適用されるヘッダを追加します。

パラメータ

qnameLocal:String — ヘッダ QName のローカル名です。
 
qnameNamespace:String — ヘッダー QName の名前空間です。
 
headerName:String — ヘッダの名前です。
 
headerValue:String — ヘッダの値です。

clearHeaders()メソッド 
public function clearHeaders():void

すべての操作に適用されるヘッダをクリアします。

getHeader()メソッド 
public function getHeader(qname:QName, headerName:String = null):SOAPHeader

QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。

パラメータ

qname:QName — SOAPHeader の QName。
 
headerName:String (default = null) — (オプション) SOAPHeader コンテンツ内のヘッダーの名前。

戻り値
SOAPHeader — QName の localName と URI に基づいた一致があった場合に、ヘッダーを返します。
removeHeader()メソッド 
public function removeHeader(qname:QName, headerName:String = null):void

指定された QName を持つヘッダをすべての操作から削除します。

パラメータ

qname:QName — SOAPHeader の QName。
 
headerName:String (default = null) — (オプション) SOAPHeader コンテンツ内のヘッダーの名前。

setRemoteCredentials()メソッド 
override public function setRemoteCredentials(remoteUsername:String, remotePassword:String, charset:String = null):void

ユーザーが 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"

プロキシを介して Web サービスを呼び出す場合の HTTP 接続のデフォルトの宛先です。宛先の指定なしで useProxy プロパティを true に設定した場合は、デフォルトの宛先を使用して、要求が Web サービスのエンドポイントにルーティングされます。

デフォルトの宛先を使用する場合は、クライアント上の WSDL と endpointURI を指定する必要があります。デフォルト以外のプロキシ宛先を使用する場合は、宛先構成の中に指定された WSDL と endpointURI を使用できます。

DEFAULT_DESTINATION_HTTPS定数 
public static const DEFAULT_DESTINATION_HTTPS:String = "DefaultHTTPS"

プロキシを介して Web サービスを呼び出す場合の HTTPS 接続のデフォルトの宛先です。宛先の指定なしで useProxy プロパティを true に設定した場合は、デフォルトの宛先を使用して、要求が Web サービスのエンドポイントにルーティングされます。

デフォルトの宛先を使用する場合は、クライアント上の WSDL と endpointURI を指定する必要があります。デフォルト以外のプロキシ宛先を使用する場合は、宛先構成の中に指定された WSDL と endpointURI を使用できます。





 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/mx/rpc/soap/AbstractWebService.html