SOAP Web サービスの作成

%XML.Adaptor を必要としない入力オブジェクトと出力オブジェクト

ほとんどの場合、Web メソッドへの入力または出力としてオブジェクトを使用するときは、そのオブジェクトは %XML.AdaptorOpens in a new tab を拡張したものでなければなりません。例外は以下のとおりです。

• オブジェクトが、%ListOfDataTypesOpens in a new tab、%ListOfObjectsOpens in a new tab、%ArrayOfDataTypesOpens in a new tab、%ArrayOfObjectsOpens in a new tab、またはサブクラスの場合、Caché SOAP サポートは、そのオブジェクトを %XML.AdaptorOpens in a new tab が含まれているものとして暗黙的に扱います。これらのクラスのサブクラスを作成する必要はありません。ただし、以下の条件があります。

  • メソッド・シグニチャ内で、以下のように ELEMENTTYPE を指定する必要があります。

    Method MyMethod() As %ListOfObjects(ELEMENTTYPE="MyApp.MyXMLType") [WebMethod]
    {
       //method implementation
    }
    

    

    または、入力引数の場合は以下のとおりです。

    Method MyMethod(input As %ListOfObjects(ELEMENTTYPE="MyApp.MyXMLType")) [WebMethod]
    {
       //method implementation
    }
    

    

  • ELEMENTTYPE で名前を指定したクラスがオブジェクト・クラスの場合、そのクラスは %XML.AdaptorOpens in a new tab から継承される必要があります。

• オブジェクトがいずれかのストリーム・クラスの場合、Caché SOAP サポートは、そのオブジェクトを %XML.AdaptorOpens in a new tab が含まれているものとして暗黙的に扱います。そのストリーム・クラスのサブクラスを作成する必要はありません。

  オブジェクトが文字ストリームの場合、Caché SOAP ツールは、そのタイプが文字列であると見なします。また、オブジェクトがバイナリ・ストリームの場合、ツールはそれを Base 64 でエンコードされたデータとして扱います。したがって、タイプ情報を指定する必要はありません。

入力または出力としての結果セットの使用法

結果セットは入力または出力として使用できますが、その方法は対象の Web クライアントによって異なります。

• Web サービスと Web クライアントの両方が Caché を基盤とする場合や、いずれかが .NET を基盤とする場合、特殊な結果セット・クラスである %XML.DataSetOpens in a new tab を使用できます。これについては、“SOAP メッセージでのデータセットの使用” を参照してください。または、クラス・クエリを Web メソッドとして使用することもできます。XML 表現は自動的に %XML.DataSetOpens in a new tab と同じになります。

• Java ベースの Web クライアントで使用できるようにクエリの結果を出力するには、%ListOfObjectsOpens in a new tab サブクラスを使用します。SAMPLES ネームスペースの SOAP.DemoOpens in a new tab に例があります。

Web サービス・ウィザードの使用法

Web サービス・ウィザードでは、簡単なスタブが生成されます。

1. [ファイル]→[新規作成] をクリックします。

   [新規作成] ダイアログ・ボックスが表示されます。

2. [一般] タブをクリックします。

3. [新規 Web サービス] をクリックしてから [OK] をクリックします。

   ウィザードが表示されます。

4. パッケージ名、クラス名、および Web サービス名の値を入力します。これらの入力は必須です。

5. オプションで、ネームスペースの URI を編集します (またはこの初期値を後で変更します)。これは、Caché ネームスペースではなく、XML ネームスペースです。

6. オプションで、別の行にメソッド名のリストを入力します。

7. [OK] をクリックします。

Web メソッドのスタブを含む新しい Web サービス・クラスが作成されました。以下はその例です。

/// MyApp.StockService
Class MyApp.StockService Extends %SOAP.WebService 
{

/// Name of the WebService.
Parameter SERVICENAME = "StockService";

/// TODO: change this to actual SOAP namespace.
/// SOAP Namespace for the WebService
Parameter NAMESPACE = "http://tempuri.org";

/// Namespaces of referenced classes will be used in the WSDL.
Parameter USECLASSNAMESPACES = 1;

/// TODO: add arguments and implementation.
/// Forecast
Method Forecast() As %String [ WebMethod ]
{
   ;Quit "Forecast"
}

}

SOAP ウィザードと既存の WSDL の併用

WSDL が設計済みで、その WSDL に合わせて Web サービスを作成する必要がある場合もあります。これは、“WSDL-first の開発” と呼ばれています。Caché では、3 つの手順でこの開発を行います。

1. SOAP ウィザードを使用して、WSDL を読み取り、Web サービス・クラスおよびサポートするすべてのクラスを生成します。

   このウィザードでは、Web クライアント・クラスも生成できます (こちらのほうがより一般的です)。

   このウィザードの使用の詳細は、このドキュメントで後述の “SOAP ウィザードの使用法” を参照してください。そのセクションで説明する手順に従い、さらにウィザード内の [ウェブ・サービスの作成] オプションを選択してください。

   または、“%SOAP.WSDL.Reader クラスの使用法” の説明に従って、%SOAP.WSDL.ReaderOpens in a new tab クラスを使用します。

2. 生成されたクラスを検証して、メソッド・シグニチャ内の %StringOpens in a new tab の値のいずれかに変更を加える必要があるかどうかを確認します。

   ウィザードで WSDL を読み取る場合、Caché では文字列タイプの入出力を %StringOpens in a new tab として表現できることが前提となっていますが、そのように表現できないこともあります。文字列によっては、Caché の 32 KB という文字列の制限を超える可能性があります。

   このドキュメントで後述する “生成されたクラスを長い文字列に合わせて調整する方法” を参照してください。

3. 生成された Web サービスで、必要なアクションを実行するようにメソッドを編集します。

   当初、各メソッドは次の例のようなスタブです。

   Method Add(a As Test.ns2.ComplexNumber, b As Test.ns2.ComplexNumber) As Test.ns2.ComplexNumber 
   [ Final, SoapAction = "http://www.mynamespace.org/GSOAP.AddComplexWS.Add", 
   SoapBindingStyle = document, SoapBodyUse = literal, WebMethod ]
   {
    // Web Service Method Implementation Goes Here.
   }

   

   ウィザードには、Final や SoapBindingStyle などのコンパイラ・キーワードが含まれます。これらのキーワードの値は変更しないでください。

WSDL に WS-Policy 要素が含まれている場合、ウィザードでは、Web サービスの構成クラスも生成されます。既定の構成クラス名は、Web サービス名に Config を追加したものです。WS-Policy については、"Caché Web サービスの保護" を参照してください。

既存の Caché Web サービスのサブクラスの作成

Web サービスを作成するには、既存の Caché Web サービス・クラスのサブクラスを作成してから、以下のようにクラスに SOAPMETHODINHERITANCE パラメータを追加します。

PARAMETER SOAPMETHODINHERITANCE = 1;

このパラメータの既定値は 0 です。このパラメータが 0 の場合、クラスは Web メソッドを Web メソッドとして継承しません。つまり、それらのメソッドは、一般メソッドとしては使用可能ですが、サブクラスによって定義された Web サービス内の Web メソッドとしてアクセスすることはできません。

このパラメータを 1 に設定した場合、クラスは、Web サービスであるスーパークラスで定義された Web メソッドを使用することができます。

これらのページへのアクセス

これらの CSP ページは、前の章で説明したように、Caché Web アプリケーションの一部になります。現在使用しているネームスペースに Web アプリケーションが存在しない場合は、これらのページにアクセスできません。また、既定ではこれらのページにはアクセスできません。これらのページにアクセスできるようにするには、ターミナルを開いて %SYS ネームスペースに移動し、次のコマンドを入力します。

set ^SYS("Security","CSP","AllowClass",webapplicationname,"%SOAP.WebServiceInfo")=1
set ^SYS("Security","CSP","AllowClass",webapplicationname,"%SOAP.WebServiceInvoke")=1

webapplicationname は、末尾にスラッシュを付けた Web アプリケーションの名前です。例えば、"/csp/mynamespace/" のようになります。これにより、既定で、/csp/samples Web アプリケーションにアクセスできます。

また、これらのページは、%Development リソースに対する USE 特権を持つユーザとしてログインした場合にのみ使用できます。

これらのページに関する注意事項

カタログ・ページには、クラス名、ネームスペース、サービス名、およびクラスと Web メソッドについてのコメントが表示されます。[サービス記述] リンクでは、WSDL が表示されます。詳細は、この章で後述する “WSDL の表示” のセクションを参照してください。次にページに Web メソッドがリンクと共に表示されます (適切な許可がある場合)。指定されたメソッドのリンクにテスト・ページが表示され、そこから限られた方法でメソッドをテストできます。

テスト・ページに関する注記

• SOAP 要求は表示できません。

• このテスト・ページは、SOAP 経路を完全にテストするわけではありません。つまり、この章の後述部分で説明される SOAP ログなどは作成されません。

• 簡単なリテラル入力のみを受け付けるので、引数がオブジェクト、コレクション、またはデータセットとなっているメソッドの呼び出しには使用できません。

このドキュメントでは、このページについてこれ以上は説明しません。Web サービスをより完全にテストするには、このドキュメントで後述するとおり、Web クライアントを生成して使用します。

WSDL の表示

Web サービスの WSDL を表示するには、次の URL を使用します。

base/csp/app/web_serv.cls?WSDL

ここで、base は Web サーバのベース URL です (必要に応じてポートを含む)。/csp/app は Web サービスが格納されている Web アプリケーションの名前です。web_serv は Web サービスのクラス名です (通常、/csp/app は /csp/namespace です)。

以下はその例です。

http://localhost:57772/csp/samples/MyApp.StockService.cls?WSDL

ブラウザに WSDL ドキュメントが表示されます。以下に例を示します。

WSDL の生成

WSDL は静的ドキュメントとしても生成できます。%SOAP.WebServiceOpens in a new tab クラスには、そのために使用できるメソッドがあります。

FileWSDL()

ClassMethod FileWSDL(fileName As %String, includeInternalMethods As %Boolean = 1) As %Status 

ここで、fileName はファイルの名前で、includeInternalMethods は、生成された WSDL に Internal としてマークされた Web メソッドが含まれるかどうかを指定します。

WSDL からの Internal Web メソッドの抑制

Web サービスに Internal とマークされている Web メソッドがある場合、既定では WSDL にこれらの Web メソッドが含まれます。これらのメソッドが WSDL に含まれないようにすることができます。これを実行するには、以下のいずれかを実行します。

• Web サービスの FileWSDL() メソッドを使用して WSDL を生成します。前のセクションを参照してください。このメソッドは、WSDL に内部 Web メソッドが含まれるかどうかを制御する引数を提供します。

• Web サービス・クラスの SOAPINTERNALWSDL クラス・パラメータを 0 に指定してください (このクラス・パラメータの既定値は 1 です)。