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

SOAP ウィザードの使用法

SOAP ウィザードを使用して InterSystems IRIS Interoperability Web クライアントを生成するには、以下の操作を行います。

1. スタジオで、適切なネームスペースにいることを確認します。

2. [ツール]→[アドイン]→[SOAP ウィザード] の順にクリックします。

3. 最初の画面で、使用する Web サービスの WSDL ドキュメントの URL 全体を入力します。

4. [次へ] をクリックします。

5. [パッケージでビジネス・オペレーションを作成] の左側のチェックボックスにチェックを付けます。このオプションは、ウィザードで、プロキシ・クライアントを呼び出すビジネス・オペレーションクラス、およびそのビジネス・オペレーションと共に使用するメッセージ・クラスを定義するためのものです。

6. [パッケージでビジネス・オペレーションを作成] で、必要に応じて、サブパッケージ名を BusOp から別の名前に変更します。

7. [オプションのパッケージ名] に、プロキシ・クライアントおよび関連するクラスのパッケージ名を入力します。デフォルトのパッケージ名は、サービス名です。“生成されるクラスと XMLKEEPCLASS” も参照してください。

8. [クラスの種類] で、プロキシ・クライアント・クラスの一般的なタイプ、つまり永続またはシリアル (デフォルト) を選択します。

9. [次へ] をクリックします。ウィザードによってクラスが生成およびコンパイルされ、これらのクラスのリストが表示されます。

10. [終了] をクリックします。

クラスの基本要件

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

• ビジネス・オペレーション・クラスは、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 サービスを使用します。このメソッドは、ストック・シンボル (文字列) を受け取り、数値を返します。SOAP ウィザードを使用して、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
  }
  

  

  SOAP ウィザードを使用してビジネス・オペレーションを生成すると、そのビジネス・オペレーションではこのメソッドが使用されます。

• アダプタの %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 サービスに適した方法を使用してください。

TLS 構成の指定

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

プロキシ・サーバの指定

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