7.7 CPA拡張定義ファイル

ビジネスメッセージを交換するために必要な情報のうち,CPAファイルに記載されているだけではuCosminexus Message Service for ebXMLが動作するのに不足している情報を定義します。ユーザーは,メッセージ交換定義導入コマンドを実行することによって,CPA拡張定義ファイルで定義した情報をメッセージ交換定義ファイルに追加します。

CPA拡張定義ファイルの作成は任意です。ただし,CPA拡張定義ファイルを作成する場合,ファイルの情報はメッセージ交換定義導入コマンドの引数として使用されるため,コマンド実行前にあらかじめファイルを作成しておいてください。

<この節の構成>
(1) 形式
(2) ファイルの格納先
(3) 定義例

(1) 形式

XML形式です。CPA拡張定義ファイルの記述形式を,次の表に示します。

表7-10 CPA拡張定義ファイルの記述形式

項番要素記述内容デフォルト値任意/必須
1

CPAExtendInfo

CPA拡張定義ファイルのルート要素です。任意(HTTPベーシック認証またはXML電子署名をする場合は必須)
2

├SignatureRequired

ビジネスメッセージに対してXML電子署名をするかどうかを指定します。
次のどちらかの値を指定します。
  • always
    該当するメッセージ交換定義ファイルを使用して送信されるすべてのビジネスメッセージに対してXML電子署名をすることを示します。
  • never
    該当するメッセージ交換定義ファイルを使用して送信されるビジネスメッセージに対してXML電子署名をしないことを示します。
never任意(XML電子署名をする場合は必須)
3

├SignPayload

ビジネスメッセージに対してXML電子署名をする場合に,ビジネスメッセージに添付するペイロードを電子署名対象とするかどうかを指定します。この項目は,項番1の指定が"always"の場合だけ有効になります。それ以外の場合は,無視されます。
次のどちらかの値を指定します
  • always
    該当するメッセージ交換定義を使用して送信されるすべてのビジネスメッセージに添付されるペイロードを署名対象とします。
  • never
    該当するメッセージ交換定義を使用して送信されるすべてのビジネスメッセージに添付されるペイロードを署名対象としません。
always任意
4

├DurationTime

送信メッセージの永続期限の最小値を,XMLスキーマのDuration形式で指定します。DurationTime要素の指定を省略した場合,送信メッセージの永続期間はCPAファイルのリトライ情報(RetriesおよびRetryInterval)から,次の式どおりに算出されます。

送信メッセージの永続期間=最小再送時間間隔×(最大再送回数+1)(秒)

CPAファイルにリトライ情報がない場合,値は0となります。
また,CPAファイルのリトライ情報の値に現実的でない大きな値を指定した場合,上に示す計算結果がDuration形式として不正な値になることがあります。
なし。任意
5

├AccessAuthenticationInfo

HTTP認証をすることを示す要素です。任意(HTTPベーシック認証をする場合は必須)
6

│ └Basic

ベーシック認証をすることを示す要素です。任意(HTTPベーシック認証をする場合は必須)
7

│  ├UserId

HTTPベーシック認証をする場合に,使用するユーザー名を指定します。なし。任意(HTTPベーシック認証をする場合は必須)
8

│  └Password

HTTPベーシック認証をする場合に,使用するパスワードを指定します。なし。任意(HTTPベーシック認証をする場合は必須)
9

└ConnectionTimeout

HTTPコネクションのタイムアウト時間を指定します。
TCP/IPコネクション確立時に,指定した期間反応がない場合は,通信エラーとします。
指定の範囲は,1~3,000(秒)です。
90任意

(凡例)-:該当しません。


XMLスキーマのDuration形式
CPA拡張定義ファイルのDurationTime要素を記述するときに使用するDuration形式について説明します。
PnYnMnDTnHnMnS
nにはそれぞれ数値を入力します。
  • P:期間を示します。入力必須です。
  • nY:年数を示します。
  • nM:月数を示します。
  • nD:日数を示します。
  • T:日付と時間の区切り文字です。
  • nH:時間を示します。
  • nM:分を示します。
  • nS:秒を示します。
XMLスキーマのDuration形式の記述例を,次に示します。
  • P1D
    1日を表します。
  • P1Y2D
    1年と2日を表します。
  • PT50S
    50秒を表します。

(2) ファイルの格納先

CPA拡張定義ファイルの格納先は任意です。

なお,次のディレクトリにサンプルファイルがあります。サンプルファイルを定義ファイルの格納ディレクトリにコピーして編集してください。

(3) 定義例