1.2.14. WS-ReliableMessaging

1.2.14.1. 事前準備

データベースがOracleの場合

1. データベース作成とデータベースのユーザ登録

   データベースの作成とデータベースのユーザ登録を行います。
   SYSユーザで以下のSQL文を実行します。

   SQL> CREATE TABLESPACE <テーブルスペース名> 
      2 LOGGING 
      3 DATAFILE <データファイル名> SIZE <データファイルサイズ>
      4 AUTOEXTEND ON
      5 EXTENT MANAGEMENT LOCAL
      6 SEGMENT SPACE MANAGEMENT AUTO;
   SQL>CREATE USER <ユーザ名>  PROFILE "DEFAULT" 
      2 IDENTIFIED BY <パスワード> DEFAULT TABLESPACE <テーブルスペース名> 
      3 ACCOUNT UNLOCK;
   SQL>GRANT CONNECT TO <ユーザ名>;
   SQL>GRANT DBA, CREATE SESSION, RESOURCE TO <ユーザ名>;
   	

   
   

   Memo
   SQL文を実行するときには、データベース管理システムに付属するコマンドを使用します(例としてsqlplusを使用する場合は"sqlplus sys/<パスワード> as SYSDBA"のようにデータベースへ接続します)
   

2. JDBCドライバのコピー

   操作対象のドメインが起動されているときは、一旦終了します。
   JDBCドライバライブラリ（ <ORACLE_HOME>/jdbc/lib配下にあるojdbc6.jar、orai18n.jar）を、<WebOTX_DIR>/domains/<ドメイン名>/lib/extへコピーします。
   コピー後、操作対象のドメインを起動します。

3. データソースの登録

   WebOTX統合運用管理ツールを用いてJDBCデータソースを登録します。統合運用管理ツールの画面上で操作対象のドメイン｜リソースをクリックします。次に「JDBCデータソース」を右クリックして「JDBCデータソースの登録」を選択します。「リソースの操作」画面が開きます。この画面を用いてJDBCデータソースを登録します。このとき、以下の点を確認してから登録します。
   
   「一般」タブにおいて、次のように設定します。
   

   • 「データソースの種別」で「OracleのJDBC Optional Package API」を選択
   • 「JDBC仕様のメジャーバージョン」で「4」を選択
   • 「JTA連携有無」をチェック

   
   図1.2.14.1-1

   「拡張」タブの「JTAのトランザクション毎に１つの物理コネクションを使用するかどうか」をチェックします。
   

   
   図1.2.14.1-2

4. 初期設定

   WebOTX統合運用管理ツールを用いて設定します。統合運用管理ツールの画面上で操作対象のドメイン｜アプリケーションサーバ｜Webサービスをクリックします。次に「WS-ReliableMessaging」をクリックして、WS-ReliableMessagingの属性設定画面が表示されます。この画面でを以下の点を確認してから更新します。
   
   「JDBCデータソースのJNDI名」は前述のデータソースの登録で指定したJNDI名を指定します。
   複数ドメインから1つのデータベースを共有して使う場合にドメイン毎にデータベースのテーブルを分けるため、「テーブル名プレフィックス」でテーブル名プレフィックスを指定します。
   

   設定後、操作対象のドメインを再起動します。

   
   図1.2.14.1-3

5. テーブルの作成

   WebOTX統合運用管理ツールを用いてデータベースのテーブルを作成します。統合運用管理ツールの画面上で操作対象のドメイン｜アプリケーションサーバ｜Webサービスをクリックします。次に「WS-ReliableMessaging」を右クリックして「テーブルの作成」を選択します。「テーブルの作成」画面が開きます。この画面で「実行」ボタンをクリックしてテーブルを作成します。

   
   図1.2.14.1-4

データベースがDerbyの場合

1. データベース作成とデータベースのユーザ登録
   

   データベースの作成とデータベースのユーザ登録を行います。
   Derbyに付属するijツールで以下のコマンドを実行します。

   ij>CONNECT 'jdbc:derby://localhost:1527/<データベース名>;create=true;user=<ユーザ名>;password=<パスワード>';
   

2. JDBCドライバのコピー
   

   操作対象のドメインが起動されているときは、一旦終了します。
   JDBCドライバライブラリ（<DERBY_HOME>/lib配下にあるderbyclient.jar）を、<WebOTX_DIR>/domains/<ドメイン名>/lib/extへコピーします。
   コピー後、操作対象のドメインを起動します。

3. データソースの登録
   

   WebOTX統合運用管理ツールを用いてJDBCデータソースを登録します。統合運用管理ツールの画面上で操作対象のドメイン｜リソースをクリックします。次に「JDBCデータソース」を右クリックして「JDBCデータソースの登録」を選択します。「リソースの操作」画面が開きます。この画面を用いてJDBCデータソースを登録します。このとき、以下の点を確認してから登録します。
   
   「一般」タブにおいて、次のように設定します。

   • 「データソースの種別」で「DerbyのJDBC Optional Package API」を選択
   • 「JDBC仕様のメジャーバージョン」で「4」を選択
   • 「JTA連携有無」をチェック

   
   図1.2.14.1-5

   「拡張」タブの「JTAのトランザクション毎に１つの物理コネクションを使用するかどうか」をチェックします。
   

   
   図1.2.14.1-6

4. 初期設定
   

   WebOTX統合運用管理ツールを用いて設定します。統合運用管理ツールの画面上で操作対象のドメイン｜アプリケーションサーバ｜Webサービスをクリックします。次に「WS-ReliableMessaging」をクリックして、WS-ReliableMessagingの属性設定画面が表示されます。この画面でを以下の点を確認してから更新します。
   
   「JDBCデータソースのJNDI名」は前述のデータソースの登録で指定したJNDI名を指定します。
   複数ドメインから1つのデータベースを共有して使う場合、ドメイン毎にデータベースのテーブルを分けるため、「テーブル名プレフィックス」でテーブル名プレフィックスを指定します。
   

   設定後、操作対象のドメインを再起動します。

   
   図1.2.14.1-7

5. テーブルの作成
   

   WebOTX統合運用管理ツールを用いてデータベースのテーブルを作成します。統合運用管理ツールの画面上で操作対象のドメイン｜アプリケーションサーバ｜Webサービスをクリックします。次に「WS-ReliableMessaging」を右クリックして「テーブルの作成」を選択します。「テーブルの作成」画面が開きます。この画面で「実行」ボタンをクリックしてテーブルを作成します。
   
   

   
   図1.2.14.1-8

1.2.14.2. Webサービスの作成

• nec-jaxws.xmlが存在する場合
  WSDLファイルに定義
• nec-jaxws.xmlが存在しない場合
  設定ファイルに定義

Memo
nec-jaxws.xmlが存在しない場合、Webサービスのアノテーション定義をもとにWSDLが生成されるため、WSDLから独立した設定ファイルを作成する必要があります。設定ファイルの内容はWebサービスのWSDL定義にポリシー・アサーションを追加したものになります。
設定ファイルの名称は以下のようにします。
　　wsit-<Webサービス実装クラス名>.xml
たとえばcom.nec.AddNumbersPortTypeImpl.classがWebサービス実装クラスであった場合、設定ファイル名は「wsit-com.nec.AddNumbersPortTypeImpl.xml」となります。 この設定ファイルはWEB-INF/classesなど、CLASSPATHのルートに配置してください。

JAX-WS準拠Webサービスの作成

JAX-WS準拠WebサービスのWSDLに、WS-RM Policyを追加することでWS-ReliableMessaging機能が有効になります。 JAX-WS準拠Webサービスの作成方法は、Webサービスの チュートリアルで説明しています。 新規作成、WSDLファイルから作成のどちらでも構いません。

WSDLファイルにWS-RM Policyを追加

WS-ReliableMessaging 機能を有効にするためには、WSDLファイルにWS-RM Policyの追加が必要です。
追加する内容は次のとおりです。

1. WS-RM Policyで使用する名前空間を追加します。
2. wsdl:definitions要素の子要素としてポリシー定義を追加します。
3. wsdl:binding要素の子要素としてwsp:PolicyReference要素を追加して、ポリシーを参照します。

以下のように設定した場合のwsdl記載例を示します。

• WS-ReliableMessagingを有効
• 同じ順序で配信
• 1回のみ配信

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions targetNamespace="http://nec.webotx.com" name="webServiceService"
    ...
    <!--1.WS-RM Policyで使用する名前空間を追加します。-->
    xmlns:wsp="http://www.w3.org/ns/ws-policy"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
    xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata"
    xmlns:wsrm="http://docs.oasis-open.org/ws-rx/wsrmp/200702"
    ...
    <!--2.wsdl:definitions要素の子要素としてポリシー定義を追加します。-->
    <wsp:Policy wsu:Id="WebServiceServicePortBindingPolicy">
        <wsp:ExactlyOne>
            <wsp:All>
                <wsam:Addressing wsp:Optional="false"/>
                <wsrm:RMAssertion>
                    <wsp:Policy>
                        <wsrm:DeliveryAssurance>
                            <wsp:Policy>
                                <wsrm:InOrder/>
                                <wsrm:ExactlyOnce/>
                            </wsp:Policy>
                        </wsrm:DeliveryAssurance>
                    </wsp:Policy>
                </wsrm:RMAssertion>
            </wsp:All>
        </wsp:ExactlyOne>
    </wsp:Policy>
    ...
    <!--3.wsdl:binding要素の子要素としてwsp:PolicyReference要素を追加して、ポリシーを参照します。-->
    <binding name="WebServiceServicePortBinding" type="tns:WebServiceService">
        <wsp:PolicyReference URI="#WebServiceServicePortBindingPolicy"></wsp:PolicyReference>
        ...
    </binding>
    ...
</definitions>

※太字の箇所は追加した内容です。WS-ReliableMessaging機能を利用する場合、<wsam:Addressing wsp:Optional="false"/>と<wsrm:RMAssertion>は必須です。

WS-RM Policyで使用する名前空間

WS-RM Policyで使用する名前空間は下記です。

ポリシー定義で利用可能なアサーション

ポリシー定義で利用可能なWS-RM Policyのアサーションは下記です。

WebOTX独自のアサーション

WS-Policyにより設定できるアサーション

WSDLのポリシーに設定できるアサーションは、WS-RM Policyで定義しているアサーションの以外にWebOTX独自のアサーションもあります。

WebOTX独自のアサーションで利用する名前空間は以下の通りです。

WebOTX独自のアサーションについて説明します。

以下のように設定した場合のWSDL記載例を示します。

• Exponentialアルゴリズムによって再送間隔を調整する
• シーケンス存続期間は2日間

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<definitions targetNamespace="http://nec.webotx.com" name="webServiceService"
    ...
    xmlns:wsp="http://www.w3.org/ns/ws-policy"
    xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
    xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata"
    xmlns:wsrm="http://docs.oasis-open.org/ws-rx/wsrmp/200702"
    <!--WebOTX独自のアサーションで利用する名前空間を追加します。-->
    xmlns:wo92rmp="http://nec.com/ws-rx/wsrmp/201312" 
    ...
    <wsp:Policy wsu:Id="WebServiceServicePortBindingPolicy">
        <wsp:ExactlyOne>
            <wsp:All>
                <wsam:Addressing wsp:Optional="false"/>
                <wsrm:RMAssertion>
                    <wsp:Policy>
                        <wsrm:DeliveryAssurance>
                            <wsp:Policy>
                                <wsrm:InOrder/>
                            </wsp:Policy>
                        </wsrm:DeliveryAssurance>
                    </wsp:Policy>
                </wsrm:RMAssertion>
                <!---WebOTX独自のアサーションを追加します。-->
                <wo92rmp:RetransmissionConfig>
                    <wo92rmp:Algorithm>Exponentia</wo92rmp:Algorithm>
                </wo92rmp:RetransmissionConfig>
                <wo92rmp:ExpiresTimeout>P2D</wo92rmp:ExpiresTimeout>
            </wsp:All>
        </wsp:ExactlyOne>
    </wsp:Policy>
    ...
    <binding name="WebServiceServicePortBinding" type="tns:WebServiceService">
        <wsp:PolicyReference URI="#WebServiceServicePortBindingPolicy"></wsp:PolicyReference>
        ...
    </binding>
    ...
</definitions>

※太字の箇所は追加した内容です。

1.2.14.3. Webサービスクライアントの作成

WS-ReliableMessaging機能を利用するWebサービスクライアントの作成方法はJAX-WSに準拠した Web サービスのクライアントの作成方法と同じです。クライアント側は、1.2.14.2. Webサービスの作成の手順で作成されたWSDLを参照することで動作します。 JAX-WS準拠Webサービスのクライアントの作成方法は、アプリケーション開発ガイド(Java EE)の 1.1.6. Webサービスクライアントの作成で説明しています。
ただし、以下の点を注意ください。

1. WS-ReliableMessagingはJAX-WSの同期モードで呼び出してください。非同期モードには対応しておりません。
2. Webサービスクライアントの実装クラスに、シーケンス終了処理の追加が必要になります。

シーケンス終了処理を追加する必要があり、例を次に示します。

package main;

import com.nec.webotx.webservice.xml.ws.Closeable;

public class Main {

    /**
     * @param args
     */
    public static void main(String[] args) {
        sample.hello.HelloService port = null;
        try {
            sample.hello.HelloService_Service service = new sample.hello.HelloService_Service();
            port = service.getHelloServicePort();
            java.lang.String arg0 = "Bob";
            java.lang.String result = port.sayHello(arg0);
            System.out.println(result);
        } catch (Exception e) {
            e.printStackTrace();
        } finally { 
            if( port != null && port instanceof Closeable ) {
                ((Closeable)port).close();
            }
        }
    }
}