Domino Designer での Web サービス

Web サービスプロバイダの設計要素は、アプリケーションナビゲータの [コード] の下に表示されます。設計要素は、[基本]、[セキュリティ]、[詳細] の各タブがあるプロパティボックスとエディタペインを備えています。Web サービスの動作部分はコンパイル済みプログラムです。Web サービスには、プログラムインターフェースを反映する WSDL 文書も保持されます。インポートされた WSDL 文書はそのまま保持されます。コーディングの変更がインターフェースに反映される場合、Web サービスの保存時に WSDL 文書は再生成されます。LotusScript Web サービスに対する WSDL 文書が再生成されるとき、WSDL 名になるすべての LotusScript ID は大文字で表わされることに注意してください。これは、LotusScript が大文字小文字を区別しない言語であり、ID 名は内部的に大文字でしか保持されないためです。

Web サービスプロバイダの設計要素は、ロックとロック解除ができます。

[基本] タブ

プロパティボックスの [基本] タブには、次の項目があります。

[名前]、[別名]、[コメント] -- エージェントなど他の設計要素と同様に Web サービスを識別します。
[オプション] -- [WSDL インターフェースの更新を警告] をチェックできます。このオプションは、WSDL の呼び出しアクションの実行時には自動的に選択されます。
[PortType class] -- ポートタイプの操作 (実装コード) が入ったクラスを指定します(最初にクラスを作成する必要があります)。

[セキュリティ] タブ

Web サービスのセキュリティはエージェントの場合と同じです。

[Web ユーザーで実行] -- Java または LotusScript コードは Web サービスを呼び出すユーザーの有効ユーザー名で実行します。
[代理で実行] -- Java または LotusScript コードは指定ユーザーの権限で実行します。ただし、Web サービスの署名者には、サーバーに対する無制限の権限があるか、任意のユーザーの代理で実行する権限があることが必要です。
[デバッグ情報を含めて Java コードをコンパイルする] -- Java エージェントの場合、デバッグに適したコードを生成します。
[リモートデバッグを許可] -- LotusScript エージェントの場合、リモートデバッグに適したコードを生成します。
[Web サービスをプロファイル] -- プロファイル用の実行時統計を収集できるようにします。
実行時セキュリティレベルの設定 (次の中からいずれか 1 つを設定)
- 1. 制限された操作を許可しない
- 2. 制限された操作を許可する
- 3. フルアドミニストレーター権限で制限された操作を許可する
この Web サービスのデフォルトアクセス
- [読者以上すべて] -- このオプションを選択または選択解除できます。
- [リストから選択] -- 前のオプションが選択解除されている場合、デフォルトアクセス権を与えるユーザーを列挙できます。
- [パブリックアクセスユーザーの Web サービス使用を許可する] -- データベースの文書へのパブリックアクセス権を持つユーザーにデフォルトアクセス権を与えます。

[詳細] タブ

プロパティインフォボックスの [詳細] タブの先頭で、プログラミングモデルと SOAP メッセージ形式を指定します。次のいずれか 1 つの組み合わせを選択します。デフォルト値は [RPC プログラミングモデル]、[Doc/リテラル] 形式です。以下の記述では、指定するオプションがどのように WSDL 文書に反映されるかを説明します。

[RPC プログラミングモデル]、[RPC/エンコード]
- <wsdl:message>、<wsdl:part> の場合、type= は、XSD 型または <wsdl:types> に定義された型を指定します。
- <wsdlsoap:binding> の場合、style="rpc" になります。
- <wsdl:operation>、<wsdl:input> および <wsdl:output>、<wsdlsoap:body> の場合、encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" になります。
- <wsdl:operation>、<wsdl:input> および <wsdl:output>、<wsdlsoap:body> の場合、use="encoded" になります。
[RPC プログラミングモデル]、[RPC/リテラル]
- <wsdl:message>、<wsdl:part> の場合、type= は、XSD 型を指定します。
- <wsdlsoap:binding> の場合、style="rpc" になります。
- <wsdl:operation>、<wsdl:input> および <wsdl:output>、<wsdlsoap:body> の場合、use="literal" になります。
[RPC プログラミングモデル]、[Doc/リテラル]
- <wsdl:types> は各入出力の要素を定義します。
- <wsdl:message>、<wsdl:part> の場合、element= は <wsdl:types> に定義された要素を指定します。
- <wsdlsoap:binding> の場合、style="document" になります。
- <wsdl:operation>、<wsdl:input> および <wsdl:output>、<wsdlsoap:body> の場合、use="literal" になります。
[RPC プログラミングモデル]、[ラップ]
- <wsdl:types> は、属性を持たない各操作の入力の単一複合要素および各操作の出力の単一複合要素を定義します。各複合要素は対応する操作に対して指定されます。
- <wsdl:message>、<wsdl:part> の場合、element= は <wsdl:types> で定義された要素を指定します (各 <wsdl:message> には、name="parameters" である <wsdl:part> が 1 つ定義されます)。
- <wsdl:portType>、<wsdl:operation> の場合、parameterOrder="" になります。
- <wsdlsoap:binding> の場合、style="document" になります。
- <wsdl:operation>、<wsdl:input> および <wsdl:output>、<wsdlsoap:body> の場合、use="literal" になります。
[メッセージプログラミングモデル]、[Doc/リテラル]
- <wsdl:message> の場合、それぞれ name= attribute が定義されますが、<wsdl:part> は定義されません (実際の SOAP 本文スキーマはパブリックではありません。これは、コンシューマとプロバイダ間のプライベートコントラクトです)。
- <wsdlsoap:binding> の場合、style="document" になります。
- <wsdl:operation>、<wsdl:input>、<wsdl:output>、および <wsdlsoap:body> の場合、use="literal" になります。
- <wsdl:operation> の場合、これらは、次のインターフェースを指定するサービスメソッドによってのみ生成されます。LotusScript の場合、Function methodName (doc As NotesDomDocumentNode) As NotesDomDocumentNode。Java の場合、org.w3c.dom.Document methodName (org.w3c.dom.Document doc)。
一般に、データを非直列化して具体的なデータ型にするには、「RPC」を使用します。MOM (メッセージ指向モデル) サービス操作で、データを非直列化して具体的なデータ型にするのではなく、特定のパラメータシグネチャを使用して SOAP 本文から実際の XML メッセージ構文を渡すものには、「メッセージ」を使用します。詳しくは、http://www.ibm.com/developerworks/webservices/library/ws-whichwsdl の「Which style of WSDL should I use?」(著者: Russell Butek) を参照してください。

プロパティボックスの [詳細] タブには、次の項目もあります。

[SOAP アクションの操作名をインクルード] -- この設定は、各操作の <Wsdl:binding> の下にある <wsdl:operation> の「soapAction」属性に反映されます。
- soapAction="" の場合、選択解除します。
- soapAction="nameOfOperation" の場合、選択します (nameOfOperation は <operation> の「name」属性と同じです)。
このオプションのデフォルトの設定は有効です。
[Validate service requests] -- この設定は Web サービスの実行時の動作に影響を与えます。有効な場合は、受信されたサービス要求が検証されます。デフォルトの設定は無効です。
このオプションは、Doc/リテラル SOAP メッセージ形式で、RPC プログラミングモデルの場合にのみ、使用可能です。その他の形式の場合は、このオプションは使用できません。
[ポートの種類名] -- サービスにアクセスするポートタイプ名を指定します。この指定は、WSDL 文書の <wsdl:portType> の「name」属性に対応します。Domino ではサービスごとに 1 つのポートタイプを使用できます。
[サービス要素名] -- サービス名を指定します。この指定は、WSDL 文書の <wsdl:service> の「name」属性に対応します。
[サービスポート名] -- サービスにアクセスするポートを指定します。この指定は、WSDL 文書で <wsdl:service> の下にある <wsdl:port> の「name」属性に対応します。Domino ではサービスごとに 1 つポートを使用できます。

エディタペイン

Web サービスのエディタペインは Java または LotusScript のコードから構成されます。

データ型 -- Java または LotusScript のコードは各データ型集合のクラスを定義します。WSDL 文書では、これらのクラスは <complexType> 要素として表され、また、列挙制限 (ファセット) を持つ <simpleType> 要素として表されます。プリミティブデータ型およびプリミティブデータ型の配列は、下記の「Java と LotusScript のマッピング」で説明するように、直接マッピングされます。
実装 (または PortType) クラス -- Java または LotusScript のコードは、Web サービスの各操作に対するパブリックメソッド、関数、サブルーチンを含むクラスを定義します。WSDL 文書では、これらの操作は <wsdl:portType> の下の <wsdl:operation> 要素として表されます。クラス名はプロパティボックスの [基本] タブの [PortType class] に一致する必要があります (「PortType」という用語は WSDL 文書に関する W3C 仕様からきています)。

単純な場合としては、操作に入力パートではない出力パートがある、Java または LotusScript のコードのパラメータが操作の <wsdl:input> メッセージにマップされる、戻り値が <wsdl:output> メッセージにマップされるなどがあります。それ以外の場合、Java では、インターフェース javax.xml.rpc.holders.Holder (StringHolder、FloatHolder など) を実装するクラスであるパラメータに出力パートと入出力パートがマップされます。LotusScript では同様に、lsxsd.lss (STRING_HOLDER、SINGLE_HOLDER など) に定義されている HOLDER クラスに出力パートと入出力パートがマップされます。

また、操作は呼び出し元にエラーを返すこともあります。WSDL 文書で操作に対して指定された <wsdl:fault> メッセージに対応する障害サブクラスを通じて、または WS_FAULT 基本クラス (LotusScript) または lotus.domino.types.Fault か java.lang.Exception クラス (Java) を直接使用してエラーを返します。

新しい Java Web サービスを作成すると、スケルトン実装クラス Untitled が作成されます。

WSDL 文書を Web サービスにインポートした場合、WSDL の内容に基づいて実装クラスが生成されます。クラスのパブリックプロトタイプメソッド、関数、サブルーチンは、WSDL 文書にある最初の <service> 要素の最初の <port> 要素に対して定義された Web サービス操作に対応します。プロトタイプメソッドで参照されている他のクラスまたは型も、そのパブリックデータメンバーと共に WSDL 文書から生成されることがあります。プロトタイプインターフェースを変更した場合、対応する WSDL 文書は Web サービスの保存時に変更されます。そのような変更をモニターし、防止するには、[WSDL インターフェースの更新を警告] プロパティを使用します。

実装クラスを最初から作成する場合、そのプロトタイプメソッド、関数、サブルーチンによって、WSDL 文書に定義されるメッセージと操作が決まります。
ライブラリ -- LotusScript コードはライブラリに格納できます。次の制限は、Domino 7.x の Web サービスのみに適用されます。名前空間定数は実装クラスと同じ場所に置く必要があります。列挙クラスおよび関連する「リスト」オブジェクトと定数は、実装クラスと同じ場所に置く必要があります。上記の制限は、Domino Designer 8.0 を使用して作成された Web サービスには適用されません。
Java に関する注意 -- Java コードはキャッシュされ、Web サービスの複数のインスタンス間で共有されるため、パフォーマンスは向上しますが、次のような制約があります。1 つのインスタンスで行われた変更はすべてのインスタンスに影響があるため、静的データは使用しないでください。クラスとオブジェクトのスコープはインスタンスをまたがることがあるため、同期は行わないでください。