プロダクション内での Web クライアントの作成

指定の WSDL に対して Web クライアント・クラスのセットを生成するには、以下の手順を実行します。

1. %SOAP.WSDL.ReaderOpens in a new tab のインスタンスを作成します。

2. 必要に応じて、インスタンスの動作を制御するプロパティを設定します。

   プロパティ	目的
   CompileFlags	生成されたクラスをコンパイルするときに使用するフラグを指定します。最初の式は "dk" で、$System.OBJ.ShowFlags() を使用して利用可能なフラグに関する情報を取得します。
   MakePersistent	このプロパティが 1 の場合、プロキシ・クライアントは永続オブジェクトです。それ以外の場合は登録オブジェクトです。最初の式は 0 です。
   MakeSerial	このプロパティが 1 で、MakePersistent が 1 の場合、プロキシ・クライアントはシリアル・クラスです。最初の式は 0 です。
   OutputTypeAttribute	WSDL リーダが、生成するプロキシ・クライアントの OUTPUTTYPEATTRIBUTE パラメータをどのように設定するかを制御します。これは、SOAP メッセージの xsi:type 属性の使用を制御します。"Web サービスおよび Web クライアントの作成" を参照してください。
   MakeBusinessOperation	ビジネス・オペレーション、および関連する要求オブジェクトおよび応答オブジェクトを生成するかどうかを指定します。このビジネス・オペレーションの ADAPTER 設定は、EnsLib.SOAP.OutboundAdapterOpens in a new tab です。このオプションは、相互運用対応ネームスペース内で作業している場合にのみ機能します。

   その他のプロパティについては、%SOAP.WSDL.ReaderOpens in a new tab のクラスに関するドキュメントを参照してください。

3. Process() メソッドを呼び出し、以下の引数を提供します。

   • 最初の引数は、Web サービスの WSDL の URL または WSDL ファイルの名前 (完全なパスを含む) でなければなりません。Web サービスの構成によっては、適切なユーザ名とパスワードを提供する文字列を追加しなければならない場合があります。以下の例を参照してください。

   • オプションの 2 つ目の引数は、リーダが生成されたクラスを配置するパッケージの名前です。パッケージを指定しないと、InterSystems IRIS は、サービス名をパッケージ名として使用します。

Web クライアント・クラスを生成する場合、クラスのパッケージを指定します。このパッケージが既存のパッケージと同じ場合、デフォルトでは、ツールは既存の同じ名前のクラスを上書きします。InterSystems IRIS によってクラス定義が上書きされないようにするには、そのクラスに XMLKEEPCLASS パラメータを追加し、このパラメータの値を 1 に設定します。

ビジネス・オペレーション・クラスの基本要件を以下に列挙します。

• ビジネス・オペレーション・クラスは、Ens.BusinessOperationOpens in a new tab を拡張するものでなければなりません。

• クラスの ADAPTER パラメータは EnsLib.SOAP.OutboundAdapterOpens in a new tab である必要があります。

• クラスの INVOCATION パラメータは、使用する呼び出しスタイルを指定する必要があります。以下のいずれかを使用します。

  • Queue は、メッセージが 1 つのバックグラウンド・ジョブ内で作成され、元のジョブが解放された段階でキューに配置されることを意味します。その後、メッセージが処理された段階で、別のバックグラウンド・ジョブがそのタスクに割り当てられます。これは最も一般的な設定です。

  • InProc は、メッセージが、作成されたジョブと同じジョブで生成、送信、および配信されることを意味します。このジョブは、メッセージが対象に配信されるまで送信者のプールに解放されません。これは特殊なケースのみに該当します。

• 以下の節で説明するように、クラスでは、プロキシ・クライアントの各メソッドに対して 1 つのメソッドを定義します。

• クラスでは、各メソッドに対して 1 つのエントリを含むメッセージ・マップを定義します。メッセージ・マップは、以下の構造を持つ XData ブロック・エントリです。

  XData MessageMap
  {
  <MapItems>
    <MapItem MessageType="messageclass">
      <Method>methodname</Method>
    </MapItem>
    ...
  </MapItems>
  }
  
  

  

また、ビジネス・オペレーションが使用するプロダクション・メッセージ・クラスも定義する必要があります。

ビジネス・オペレーション・クラスにおいて、メソッドがプロキシ・メソッドを呼び出す必要があります。一般的な要件は以下のとおりです。

1. このメソッドは、呼び出しているプロキシ・メソッドと同じシグニチャを持つ必要があります。

2. このメソッドには、WebMethod キーワードでマーキングする必要があります。

3. このメソッドは、プロキシ・クライアントによって期待される、SoapBindingStyle キーワードおよび SoapBodyUse キーワードを設定する必要があります。(つまり、対応するプロキシ・メソッドのシグニチャと同じ値を使用します。)

4. このメソッドは、アダプタの WebServiceClientClass プロパティを設定する必要があります。このプロパティが設定されている場合、プロキシ・クライアントのインスタンスが作成され、アダプタの %Client プロパティ内に配置されます。

5. このメソッドは、次の節で説明するいずれかの方法で、対応するプロキシ・メソッドを呼び出す必要があります。

6. このメソッドは、ステータスを確認する必要があります。

7. 次に、以下の手順を実行します。

   • 成功した場合は、(要求の NewResponse() メソッドを介して) 新しい応答メッセージを作成し、適切にプロパティを設定します。

   • 失敗した場合は、エラーが表示されて停止します。

ビジネス・オペレーションにおいて、メソッドが、プロキシ・クライアント・クラスのプロキシ・メソッドを実行する必要があります。これには何通りかの方法があるので、例を使用して説明します。この節では、GetStock という名前の Web メソッドを持つサンプル Web サービスを使用します。このメソッドは、ストック・シンボル (文字列) を受け取り、数値を返します。GetStock という名前のメソッドを含むプロキシ・クライアント (GetStock.StockServiceSoap) を生成済みであると想定します。

また、以下のようにメッセージ・クラスを作成したものとします。

Class GetStock.BusOp.GetQuoteRequest Extends Ens.Request
{

Parameter RESPONSECLASSNAME = "GetStock.BusOp.GetQuoteResponse";

Property StockName As %String;

}

および

Class GetStock.BusOp.GetQuoteResponse Extends Ens.Response 
{

Property StockValue As %Numeric;

}

プロキシ・メソッド GetStock を実行するために、ビジネス・オペレーション・クラスは、以下のいずれかを行うことができます。

• アダプタの InvokeMethod() メソッドを呼び出し、実行するプロキシ・メソッドの名前、および任意の数の引数を指定します。この場合、引数は 1 つだけ (pRequest.StockName) です。以下に例を示します。

  Method GetQuote1(pRequest As GetStock.BusOp.GetQuoteRequest,
  Output pResponse As GetStock.BusOp.GetQuoteResponse) As %Status
  {
   set ..Adapter.WebServiceClientClass = "GetStock.StockServiceSoap"
  
   set status = ..Adapter.InvokeMethod("GetQuote",.answer,pRequest.StockName)
   if $$$ISERR(status) quit status
  
   set pResponse=##class(GetStock.BusOp.GetQuoteResponse).%New()
   set pResponse.GetQuoteResult=answer
   quit $$$OK
  }
  

  

• アダプタの %Client プロパティにアクセスします。このプロパティによってプロキシ・クライアント・クラスのインスタンスが与えられ、そのプロパティのプロキシ・メソッドが実行されます。%Client プロパティは、WebServiceClientClass プロパティの設定時に設定されます。この場合、%Client には、文字列ストック・シンボルを受け取る、GetQuote という名前のメソッドがあります。以下に例を示します。

  Method GetQuote2(pRequest As GetStock.BusOp.GetQuoteRequest,
  Output pResponse As GetStock.BusOp.GetQuoteResponse) As %Status
  {
   set ..Adapter.WebServiceClientClass = "GetStock.StockServiceSoap"
  
   set client=..Adapter.%Client
   set answer=client.GetQuote("GRPQ")
  
   set pResponse=##class(GetStock.BusOp.GetQuoteResponse).%New()
   set pResponse.GetQuoteResult=answer
   quit $$$OK
  }

  

  この方法を使用する場合、InterSystems IRIS の再試行ロジックにはアクセスできません。

• アダプタの WebMethod() メソッドを呼び出すことによって、プロキシ・メソッド・オブジェクトを作成します。このオブジェクトのプロパティを適切に設定します (名前のある引数ごとに 1 つのプロパティ)。ここでは、WebMethod() は、1 つのプロパティ (StockName) を持つオブジェクトを返します。必要に応じてプロパティを設定した後、オブジェクトの Invoke() メソッドを呼び出します。以下に例を示します。

  Method GetQuote3(pRequest As GetStock.BusOp.GetQuoteRequest,
  Output pResponse As GetStock.BusOp.GetQuoteResponse) As %Status
  {
   set ..Adapter.WebServiceClientClass = "GetStock.StockServiceSoap"
  
  
   set proxymethod=..Adapter.WebMethod("GetQuote")
   set proxymethod.StockName=pRequest.StockName
  
  
   set status=..Adapter.Invoke(proxymethod)
   if $$$ISERR(status) quit status
  
  
   set pResponse=##class(GetStock.BusOp.GetQuoteResponse).%New()
   set pResponse.GetQuoteResult=proxymethod.%Result
   quit $$$OK
  }
  

  

  この場合、任意の数だけ引数を提供できます。

この節では、これまでに説明したアダプタ・プロパティおよびメソッドについての参照情報を提供します。

%Client プロパティ

%SOAP.WebClient 

プロキシ・クライアントの関連するインスタンス (%SOAP.WebClientOpens in a new tab のインスタンス)。このプロパティは、アダプタの WebServiceClientClass プロパティの設定時に設定されます。

InvokeMethod() メソッド

Method InvokeMethod(pMethodName As %String,
       Output pResult As %RegisteredObject,
       pArgs...) As %Status

すべての引数を渡してプロキシ・クライアント・クラスの指定されたメソッドを呼び出して、ステータスを返します。出力は、2 番目の引数として参照によって返されます。

WebMethod() メソッド

Method WebMethod(pMethodName As %String) As %SOAP.ProxyDescriptor

指定されたメソッドに対応するオブジェクトを返します。このオブジェクトには、各メソッド引数に対応する 1 つのプロパティがあります。Invoke() メソッドを使用する前に、このプロパティを設定します。%SOAP.ProxyDescriptorOpens in a new tab の詳細は、クラス参照を参照してください。

Invoke() メソッド

Method Invoke(pWebMethod As %SOAP.ProxyDescriptor) As %Status

指定されたメソッドを呼び出し、ステータスを返します。

以下の設定は、InterSystems IRIS Interoperability Web クライアントの基本的な情報を指定します。

• ウェブサービスURL

• ウェブサービスクライアントクラス

• 応答タイムアウト

Web サービスにアクセスするのに、ユーザ名とパスワードが必要な場合があります。通常、InterSystems IRIS Interoperability SOAP クライアントは、以下のいずれかの方法で Web サービスにログインできます。

• WS-Security ユーザ認証を使用できます。この場合、SOAP 要求に WS-Security ヘッダを含めます。このヘッダに、ユーザ名とパスワードを含めます。[SOAP認証情報] 設定の値を指定すると、プロキシ・クライアントによってこの操作が自動的に行われます。

  Caution:

  Web クライアントと Web サービスとの間で TLS を使用していることを確認します。WS-Security ヘッダはクリア・テキストで送信されるので、TLS が使用されていない場合、この方法は安全ではありません。

• 基本的な HTTP ユーザ認証を使用することができます。WS-Security ほど安全性は高くありませんが、この方法が必要な場合もあります。この場合、SOAP 要求の HTTP ヘッダにユーザ名とパスワードを含めます。[認証情報] 設定の値を指定すると、プロキシ・クライアントによってこの操作が自動的に行われます。

使用する Web サービスに適した方法を使用してください。

Web サーバが TLS をサポートしている場合、これを使用して接続できます。そのためには、[SSL構成] 設定に対して値を指定します。

プロキシ・サーバを介して Web サービスと通信できます。これを設定するには、[プロキシ設定] グループの Proxy Server およびその他の設定を使用します。