A.32 soapsecrelconf

名前

soapsecrelconf －送達保証機能で使用する設定の操作

形式

: (1)送達保証機能の設定の追加・変更
soapsecrelconf -add {message | from | to | local}
      [-f filename] [-messageid id] [-serviceid name] [-storedir dirname] [-partnerid id]
      [-address url] [-listener listener] [-storefile filename] [-storepass password]
      [-signalias alias] [-verifyalias alias] [-keypass password] [-timeout time] [-retry num]
      [-username username] [-password password]
(2)送達保証機能の設定の削除
soapsecrelconf -del {message | from | to | local | service} [-f filename] [-messageid id]
      [-partnerid id] [serviceid id]
(3)送達保証機能の設定の一覧表示
soapsecrelconf -list {message | from | to | service} [-f filename] [-messageid id]
(4)送達保証機能の設定の詳細表示
soapsecrelconf -view {message | from | to | local} [-f filename] [-messageid id] [-partnerid id]

: (1)送達保証機能の設定の追加・変更
soapsecrelconf -add {message | from | to | local} [-M systemname]
                  [-f filename] [-messageid id] [-serviceid name] [-storedir dirname]
                  [-partnerid id] [-address url] [-listener listener]
                  [-storefile filename] [-storepass password]
                  [-signalias alias] [-verifyalias alias] [-keypass password]
                  [-timeout time] [-retry num] [-username username] [-password password]
(2)送達保証機能の設定の削除
soapsecrelconf -del {message | from | to | local | service} [-M systemname]
                  [-f filename] [-messageid id] [-partnerid id] [serviceid id]
(3)送達保証機能の設定の一覧表示
soapsecrelconf -list {message | from | to | service} [-M systemname] [-f filename] [-messageid id]
(4)送達保証機能の設定の詳細表示
soapsecrelconf -view {message | from | to | local} [-M systemname]
                  [-f filename] [-messageid id] [-partnerid id]

機能説明

soapsecrelconfコマンドは、送達保証機能の設定の追加、削除、設定内容の一覧、および設定内容の詳細を表示します。

-M systemname: マルチシステムのシステム名を指定します。
本オプションを省略すると、デフォルトシステムが対象となります。

-add { message | from | to | local }

messageを指定した場合
-messageidで指定したメッセージ種別に関する設定を追加・変更します。
fromを指定した場合
-messageidで指定したメッセージ種別に関して、-partneridで指定した、PUSHモデルにおける送信クライアントID、またはPULLモデルにおける送信サーバIDの設定を追加、変更します。fromパラメタは、送達保証を設定するクライアント、またはサーバが送達保証メッセージの受信を行うアプリケーションを持つ場合に使用します。
fromパラメタを指定した場合は、-messageidで指定するメッセージ種別と、-partneridで指定する送信者のIDが必須となります。
toを指定した場合
-messageidで指定したメッセージ種別に関して、-partneridで指定したPUSHモデルにおける受信サーバID、またはPULLモデルにおける受信クライアントIDの設定を追加、変更します。toパラメタは、送達保証を設定するクライアント、またはサーバが送達保証メッセージの送信を行うアプリケーションを持つ場合に使用します。
toパラメタを指定した場合は、-messageidで指定するメッセージ種別と、-partneridで指定する受信者のIDが必須となります。
localを指定した場合
送達保証を設定するクライアント、またはサーバに関する設定を追加・変更します。localパラメタは送達保証クライアント機能の設定の際は、PUSHモデルにおける送信クライアント、またはPULLモデルにおける受信クライアントの設定となります。
また、送達保証サーバ機能の設定の際は、PUSHモデルにおける受信サーバ、またはPULLモデルにおける送信サーバの設定となります。
localパラメタは、同一クライアント、またはサーバ内で１つのみ指定可能です。

なお、-addオプションは、必ずコマンドオプションの先頭に指定してください。

-del { message | from | to | local | service }

messageを指定した場合
-messageidで指定したメッセージ種別に関する設定を削除します。
fromを指定した場合
-messageidで指定したメッセージ種別に関して、-partneridで指定したPUSHモデルにおける送信クライアントID、またはPULLモデルにおける送信サーバIDの設定を削除します。
toを指定した場合
-messageidで指定したメッセージ種別に関して、-partneridで指定したPUSHモデルにおける受信サーバID、またはPULLモデルにおける受信クライアントIDの設定を削除します。
localを指定した場合
送達保証を設定するクライアント、またはサーバに関する設定を削除します。
serviceを指定した場合
-serviceidで指定したサービス識別子に含まれる送達保証の設定をすべて削除します。

なお、-delオプションは、必ずコマンドオプションの先頭に指定してください。

-list { message | from | to | service }

messageを指定した場合
設定ファイルに格納されたメッセージ種別の一覧を表示します。
fromを指定した場合
-messageidで指定したメッセージ種別に対するPUSHモデルの送信クライアントID、またはPULLモデルの送信サーバIDの一覧を表示します。
toを指定した場合
-messageidで指定したメッセージ種別に対するPUSHモデルの受信サーバID、またはPULLモデルの受信クライアントIDの一覧を表示します。
serviceを指定した場合
設定ファイルに格納されたサービス識別子一覧を表示します。

なお、-listオプションは、必ずコマンドオプションの先頭に指定してください。

-view { message | from | to | local }

messageを指定した場合
-messageidで指定したメッセージ種別に関する設定の詳細を表示します。
fromを指定した場合
-messageidで指定したメッセージ種別に対する-partneridで指定した PUSHモデルの送信クライアント、またはPULLモデルの送信サーバに関する設定の詳細を表示します。
toを指定した場合
-messageidで指定したメッセージ種別に対する-partneridで指定したPUSHモデルの受信サーバ、またはPULLモデルの受信クライアントに関する設定の詳細を表示します。
localを指定した場合
送達保証を設定するクライアント、またはサーバに関する設定の詳細を表示します。

なお、-viewオプションは、必ずコマンドオプションの先頭に指定してください。

-f filename

送達保証機能の設定を格納するファイル名を指定します。
本オプションを省略した場合、送達保証機能設定は以下のファイルに格納されます。

C:\Interstage\F3FMsoap\conf\issoapsecconf.xml

/opt/FJSVsoap/conf/issoapsecconf.xml

-Mオプションでdefaultを指定した場合
-Mオプションを省略した場合で、環境変数IS_SYSTEMにdefaultを設定、もしくは環境変数IS_SYSTEMが存在しない場合

/opt/FJSVsoap/MI/システム名/conf/issoapsecconf.xml

-Mオプションでdefault以外のシステム名を指定した場合
-Mオプションを省略した場合で、環境変数IS_SYSTEMにdefault以外のシステム名を設定した場合

/opt/FJSVsoap/conf/issoapsecconf.xml

-messageid id: メッセージの種別を表す識別子を指定します。メッセージ種別は同一マシン内で一意なIDである必要があります。

-serviceid id: サービス識別子を指定します。これは、GUIから行った設定を変更する場合に指定するオプションで、必須です。

-storedir dirname

メッセージを格納するディレクトリを指定します。
本オプションを省略した場合、以下のディレクトリに格納されます。

C:\Interstage\F3FMsoap\etc\reliableMessage

/opt/FJSVsoap/etc/reliableMessage

-Mオプションでdefaultを指定した場合
-Mオプションを省略した場合で、環境変数IS_SYSTEMにdefaultを設定、もしくは環境変数IS_SYSTEMが存在しない場合

/opt/FJSVsoap/MI/システム名/etc/reliableMessage

-Mオプションでdefault以外のシステム名を指定した場合
-Mオプションを省略した場合で、環境変数IS_SYSTEMにdefault以外のシステム名を設定した場合

/opt/FJSVsoap/etc/reliableMessage

-partnerid id

-add { from | to } 、-del { from | to } または -view { from | to } を指定した場合は、送達保証クライアント機能の設定の際、PUSHモデルの受信サーバID、またはPULLモデルの送信サーバIDとなります。また、送達保証サーバ機能の設定の際、PUSHモデルの送信クライアントID、またはPULLモデルの受信クライアントIDとなります。

-add localを指定した場合は、送達保証を設定するクライアント、またはサーバのIDとなります。この場合、送達保証クライアント機能の設定の際は、PUSHモデルにおける送信クライアントID、またはPULLモデルにおける受信クライアントIDとなります。また送達保証サーバ機能の設定の際は、PUSHモデルにおける受信サーバID、またはPULLモデルにおける送信サーバIDの設定となります。

-add { from | to | local }，-del { from | to }または-view { from | to }を指定した場合には、必須オプションとなります。

-address url

-add { from | to }を指定した場合で、かつ送達保証を設定するクライアントがPUSHモデルの送信クライアント、またはPULLモデルの受信クライアントである場合に有効であり、送達保証機能を提供するサーバのURLを指定します。

-add fromを指定して-addressオプションを指定すると、送達保証を設定するクライアントがPULLモデルの受信クライアントとなります。また-addressオプションを省略すると、送達保証を設定するサーバがPUSHモデルの受信サーバとなります。
-add toを指定して-addressオプションを指定すると、送達保証を設定するクライアントがPUSHモデルの送信クライアントとなります。また-addressオプションを省略すると、送達保証を設定するサーバがPULLモデルの送信サーバとなります。

-listener classname: -add fromを指定した場合に有効であり、-messageidと-partneridで指定した、PUSHモデルの送信クライアント、またはPULLモデルの送信サーバからのメッセージを受信した場合に実行する、受信アプリケーションのクラス名を指定します。ここで指定するクラスは、OnewayListenerインタフェースを実装している必要があります。OnewayListenerについての詳細は、Interstage V9.1.0の“SOAPサービスユーザーズガイド”の“Messaging方式のアプリケーションの実装”を参照してください。
-add fromを指定した場合には、必須オプションとなります。

-storefile filename

-addを指定した場合に有効であり、SOAP電子署名の付加やSOAP電子署名を検証する場合に使用する秘密鍵やサイト証明書を格納した証明書管理ファイルのファイル名を指定します。

  -add {from | to}を指定した場合、メッセージの送信者／受信者が作成したSOAP電子署名を検証で使用するサイト証明書が格納された証明書管理ファイルのファイル名を指定します。
  -add localを指定した場合、SOAP電子署名の付加の場合に使用する秘密鍵が格納された証明書管理ファイルのファイル名を指定します。
  本オプションは、クライアントシステム環境および旧バージョンで作成した証明書環境においてsoapSetSecurityコマンドで作成した証明書管理ファイルとは異なる証明書管理ファイルに格納された秘密鍵や証明書を使用する場合に指定します。本オプションを省略した場合、クライアントシステム環境および旧バージョンで作成した証明書環境ではsoapSetSecurityコマンドで作成した証明書管理ファイルに含まれる秘密鍵やサイト証明書を用いてSOAP電子署名の付加やSOAP電子署名を検証します。

それ以外の環境では、Interstage証明書環境で作成した証明書管理ファイルに含まれる秘密鍵やサイト証明書を用いてSOAP電子署名の付加やSOAP電子署名を検証します。

-storepass password: -addを指定した場合に有効であり、-storefileで指定した証明書管理ファイルにアクセスするためのパスワードを指定します。

-signalias alias

  -add localを指定した場合に有効です。
  SOAP電子署名を付加する場合に使用する秘密鍵の別名を指定します。
  本オプションは、送達保証を設定するクライアント、またはサーバがSOAP電子署名を付加する際に、クライアントシステム環境および旧バージョンで作成した証明書環境においてsoapSetSecurityコマンドが用意する秘密鍵とは異なる秘密鍵を使用する場合に指定します。-signaliasオプションを指定する場合、-storefile、-storepass、-keypassは必須オプションとなります。
  本オプションを省略した場合、クライアントシステム環境および旧バージョンで作成した証明書環境においてsoapSetSecurityコマンドで作成した秘密鍵を用いてSOAP電子署名を付加します。

それ以外の環境では、config.propertiesのcom.fujitsu.interstage.soapx.websecで指定したSSL定義名を用いてSOAP電子署名を付加します。

-verifyalias alias

-add { from | to }を指定した場合に有効です。

送達保証の通信相手となるクライアント、またはサーバが作成したSOAP電子署名を検証する場合に使用するサイト証明書の別名を指定します。
-add { from | to }を指定した場合に本オプションを省略した場合、送達保証機能を利用した通信時にSOAP電子署名を利用しません。(署名オプション無し)

-keypass password: -add localを指定した場合に有効です。
-signaliasで指定した秘密鍵を復号化するためのパスワードを指定します。

-timeout time

-add messageを指定した場合に有効です。
-messageidで指定したメッセージ種別に対応したメッセージの送信タイムアウトの時間を指定します。時間は数字と単位の組で指定します。単位として、日(d), 時間(h), 分(m), 秒(s)を指定することが可能です。以下に指定例を示します。

-timeout 10m ：10分
-timeout 100s ： 100秒

-retry number: -add messageを指定した場合に有効であり、-messageidで指定したメッセージ種別に対応したメッセージがエラーにより送信できなかった場合や、送信タイムアウトが発生した場合に、メッセージを再送する最大回数を指定します。

-username username: -add { from | to }を指定し、かつ送達保証のクライアント機能の設定時に有効です。送達保証機能でBasic認証を行う際のユーザ名を指定します。

-password password: -add { from | to }を指定し、かつ送達保証のクライアント機能の設定時に有効です。送達保証機能でBasic認証を行う際のパスワードを指定します。

注意事項

本コマンドを使用してサーバシステムの送達保証のための設定を追加または削除した場合、同時にWebサービス情報編集ツールやsoapmodifyddコマンドを使用して、送達保証機能の設定を追加または削除する必要があります。
-messageidオプション、および-partneridオプションで指定したidは、送達保証メッセージの格納用ディレクトリ名、およびファイル名として使用します。そのため、使用するOSで、ディレクトリ名、ファイル名として使用可能な文字を指定してください。ディレクトリ名、ファイル名として使用できない文字を指定した場合、送達保証機能の実行時にエラーとなります。

使用例(太字は入力を示します)

1. 送達保証機能のメッセージ種別の設定を追加・変更します。
  > soapsecrelconf -add message -messageid purchaseOrder -timeout 10m -retry 5
2. 送達保証機能の送達保証を設定するクライアント、またはサーバに関する設定をします。
  > soapsecrelconf -add local -partnerid buyer
3. 送達保証機能のメッセージ受信者に関する設定をします(送達保証のクライアント機能の設定時)。
  > soapsecrelconf -add to -messageid purchaseOrder -partnerid seller
-address http://seller.url/ -verifyalias selleralias -serviceid PurchaseService
4. 送達保証機能のメッセージ送信者に関する設定をします(送達保証のサーバ機能の設定時)。
  > soapsecrelconf -add from -messageid purchaseOrder -partnerid buyer -verifyalias buyeralias -lisner samples.SampleSellerListner -serviceid PurchaseService
5. 送達保証機能のメッセージ種別に関する設定を削除します。
  > soapsecrelconf -del message -messageid purchaseOrder
6. 送達保証機能のメッセージ送信者に関する設定を削除します。
  > soapsecrelconf -del from -messageid purchaseOrder -partnerid buyer
7. 送達保証機能のメッセージ受信者に関する設定を削除します。
  > soapsecrelconf -del to -messageid purchaseOrder -partnerid seller
8. 送達保証機能のサービスに関する設定を削除します。
  > soapsecrelconf -del service -serviceid urn:OrderService
9. 送達保証機能の送達保証を設定するクライアント、またはサーバに関する設定を削除します。
  > soapsecrelconf -del local
10. 送達保証機能のメッセージ種別の一覧を表示します。
  > soapsecrelconf -list message
11. 送達保証機能のメッセージ送信者の一覧を表示します。
  > soapsecrelconf -list from -messageid purchaseOrder
   From Party ID=buyer1
   From Party ID=buyer2
12. 送達保証機能のメッセージ受信者の一覧を表示します。
  > soapsecrelconf -list to -messageid purchaseOrder
   To Party ID=seller1
   To Party ID=seller2
13. 送達保証機能のサービス一覧を表示します。
  > soapsecrelconf -list service
   Message ID=purchaseOrder
   From service=buyerService
   Message ID=paymentOrder
   To service=sellerService
14. 送達保証機能のメッセージ種別に関する設定の詳細を表示します。
  > soapsecrelconf -view message -messageid purchaseOrder
   Message ID=purchaseOrder
   From partyId=buyer
   From listenerClass=samples.reliable.SampleMediator
   From address=null
   From getServiceName=buyerService
   From sigalias=buyer
   From username=null
   From password=null
   MessageStoreFactory
   StoreParameter name=directory
   StoreParameter value=./mediator_furikomi
15. 送達保証機能のメッセージ送信者に関する設定の詳細を表示します。
  > soapsecrelconf -view from -messageid purchaseOrder -partnerid buyer
   Message ID=purchaseOrder
   From partyId=buyer
   From listenerClass=samples.reliable.SampleMediator
   From address=null
   From getServiceName=buyerService
   From sigalias=buyer
   From username=null
   From password=null
   MessageStoreFactory
   StoreParameter name=directory
   StoreParameter value=./mediator_furikomi
16. 送達保証機能のメッセージ受信者に関する設定の詳細を表示します。
  > soapsecrelconf -view to -messageid purchaseOrder -partnerid seller
   To partyId=seller
   To address=null
   To getServiceName=sellerService
   To sigalias=seller
   To username=null
   To password=null
17. 送達保証機能の送達保証を設定するクライアント、またはサーバに関する設定の詳細を表示します。
  > soapsecrelconf -view local

Local partyId=mediator
Local sigalias=mediator