7.4 MSH実行環境定義ファイル(mshenv.xml)

MSH実行環境の定義を記述します。

<この節の構成>
(1) 形式
(2) ファイルの格納先
(3) 定義できるコンテナ
(4) 定義できるキー
(5) 定義例

(1) 形式

XML形式です。記述形式の詳細については,「7.2 定義ファイルの形式」を参照してください。

(2) ファイルの格納先

<MSH実行環境ディレクトリ>は,実行環境参照定義ファイル(EXEC_ENV_REF_DEFコンテナのEXEC_ENV_IO_DIR_PATHキー)で指定した値です。

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

(3) 定義できるコンテナ

(4) 定義できるキー

MSH実行環境定義ファイルで定義できるキー要素の一覧を,次の表に示します。

表7-5 MSH実行環境定義ファイルのキー要素一覧

項番コンテナキー説明デフォルト値必須/任意
1システム情報
SYSTEM_INFO
ドメイン名
DOMAIN_NAME
MSH実行環境が構築されたシステムのドメイン名を128バイト以内で指定します。MSH実行環境が構築されているuCosminexus Message Service for ebXMLシステムのホスト名称任意
2サーバ識別子
SERVER_ID
MSH実行環境が構築されたマシンを識別するためのIDを8文字以下の英数文字列で指定します。
複数のebXMLサーバで同一のデータベースを共有する場合,それぞれのebXMLサーバで異なる値を指定してください。
MSHSV任意
3文字コード種別
ENCODING
MSH実行環境がデータのサイズチェックに使用する文字コード種別を指定します。
指定できる値は,"MS932"または"UTF-8"です。HiRDBシステムをOSに登録したときに指定した文字コード種別と同じになるように指定してください。
プラットフォームのデフォルト文字コード任意
4エンドポイント
END_POINT
送信タイマー登録先
TIMER_SEND
送信タイマーがuCosminexus Message Service for ebXMLからの追加・削除要求を受け付けるためのエンドポイントを指定します。
この指定値は,デフォルトのポート番号(1099)でRMIレジストリを起動しない場合に限って指定してください。uCosminexus Message Service for ebXMLでは,通常デフォルトポート番号(1099)でRMIレジストリを起動するので,通常はユーザーが指定する必要はありません。
ポート番号を変更する場合の指定方法を,次に示します。
rmi://localhost:<ポート番号>/MSH_SEND_TIMER
なお,ここで指定したポート番号は,RMIレジストリ起動コマンドを実行するときに,引数として指定します。
rmi://localhost/MSH_SEND_TIMER任意
5AP通知タイマー登録先
TIMER_NOTIFY_AP
AP通知タイマーがuCosminexus Message Service for ebXMLからの追加・削除要求を受け付けるためのエンドポイントを指定します。
この指定値は,デフォルトのポート番号(1099)でRMIレジストリを起動しない場合に限って指定してください。uCosminexus Message Service for ebXMLでは,通常デフォルトポート番号(1099)でRMIレジストリを起動するので,通常はユーザーが指定する必要はありません。
ポート番号を変更する場合の指定方法を,次に示します。
rmi://localhost:<ポート番号>/ MSH_NOTIFYAP_TIMER
なお,ここで指定したポート番号は,RMIレジストリ起動コマンドを実行するときに,引数として指定します。
rmi://localhost/MSH_NOTIFYAP_TIMER任意
6メッセージサービス
MESSAGE_SERVICE
メッセージサービスのエンドポイントを指定します。
ebXMLサーバのデフォルト名称は"ebxml"です。サーバ名称を"ebxml"以外にする場合,デフォルト値"HITACHI_EJB/SERVERS/ebxml/EJB/MSH/MessageService"の"ebxml"を,指定するサーバ名称に変更してください。
ebXMLサーバの名称がデフォルトのままの場合は,ユーザーが指定する必要はありません。
HITACHI_EJB/SERVERS/
ebxml/EJB/MSH/MessageService
任意
7永続化
PERSIST
メッセージ分割サイズ
MESSAGE_ARCHIVE_DIVISION_SIZE
ビジネスメッセージ本体の分割サイズを100~15999で指定します。単位はKBです。1024※1任意
8ペイロード最大サイズ
PAYLOAD_MAX_SIZE
ペイロードの最大サイズを1~1024で指定します。単位はMBです。
ペイロードが複数ある場合,ペイロードの合計サイズの最大値を指定します。
10任意
9ペイロード最大数
PAYLOAD_MAX_NUM
1ビジネスメッセージ当たりのペイロードの最大数を,1~64で指定します。10任意
10セキュリティ
SECURITY
SSL用証明書格納ファイル
SSL_CERTIFICATE_FILE_NAME
クライアント証明書が格納されているKeyStoreファイル名をフルパス(相対的な内容を含まない)で指定します。
暗号化通信(SSLクライアント認証)をする場合,必ず指定します。
なし。任意
11SSL証明書アクセスパスワード
SSL_CERTIFICATE_ACCESS_PASSWORD
クライアント証明書が格納されているKeyStoreファイルから証明書・秘密鍵にアクセスするためのパスワードを指定します。KeyStoreでは,KeyStoreファイルにアクセスするためのパスワード,および秘密鍵を取得するためのパスワードを使用します。二つのパスワードに同じものを指定します。
暗号化通信(SSLクライアント認証)をする場合,必ず指定します。
なし。任意
12電子署名用証明書格納ファイル
CERTIFICATE_FILE_NAME
XML電子署名用証明書が格納されているKeyStoreファイル名をフルパス(相対的な内容を含まない)で指定します。
XML電子署名をする場合,必ず指定します。
なし。任意
13電子証明書用証明書アクセスパスワード
CERTIFICATE_ACCESS_PASSWORD
XML電子署名用の証明書が格納されているKeyStoreファイルから証明書・秘密鍵にアクセスするためのパスワードを指定します。KeyStoreでは,KeyStoreファイルにアクセスするためのパスワード,および秘密鍵を取得するためのパスワードを使用します。二つのパスワードに同じものを指定します。
XML電子署名をする場合,必ず指定します。
なし。任意
14トランスポート
TRANSPORT
ポート番号付与
ENABLE_PORT_FOR_HOST_HEADER
HTTPプロトコルのデフォルトのポート番号を使用した場合,HTTPヘッダのHOST要素にポート番号を与えるかどうかを指定します。
指定できる値は,"TRUE"(ポート番号を与える)または"FALSE"(ポート番号を与えない)です。大文字で指定してください。
HTTPプロトコルのデフォルトのポート番号を使用しない場合,この指定に関係なく,HTTPヘッダのHOST要素にポート番号を与えます。
FALSE任意
15SwAオプション
ENABLE_SWA_ALWAYS
送信メッセージをすべてSwA形式で送信することを指定します。指定しない場合,添付がないビジネスメッセージはすべてSOAP形式で送信されます。指定できる値は,"TRUE"(指定する)または"FALSE"(指定しない)です。大文字で指定してください。FALSE任意
16HTTPプロキシホスト
PROXY_HOST
HTTPプロトコルでビジネスメッセージを送信する場合に,使用するHTTPプロキシのホスト名を指定します。HTTPプロキシを使用しない場合,指定する必要はありません。なし。任意
17HTTPプロキシポート
PROXY_PORT
HTTPプロトコルでビジネスメッセージを送信する場合に,使用するHTTPプロキシのポート番号を指定します。HTTPプロキシを使用しない場合,指定する必要はありません。なし。任意
18HTTPプロキシ認証ユーザー
AUTH_USER
HTTPプロキシで接続ユーザー認証をする場合に使用するユーザー名を指定します。HTTPプロキシ認証をしない場合,指定する必要はありません。なし。任意
19HTTPプロキシ認証パスワード
AUTH_PASSWORD
HTTPプロキシで接続ユーザー認証をする場合に使用するパスワードを指定します。HTTPプロキシ認証をしない場合,指定する必要はありません。なし。任意
20HTTPSプロキシホスト
SSL_PROXY_HOST
HTTPSプロトコルを使用してメッセージを送信する場合に使用するHTTPSプロキシのホスト名を指定します。HTTPSプロキシを使用しない場合,指定する必要はありません。なし。任意
21HTTPSプロキシポート
SSL_PROXY_PORT
HTTPSプロトコルを使用してビジネスメッセージを送信する場合に,使用するHTTPSプロキシのポート番号を指定します。HTTPSプロキシを使用しない場合,指定する必要はありません。なし。任意
22HTTPSプロキシ認証ユーザー
SSL_AUTH_USER
HTTPSプロキシで接続ユーザー認証をする場合に使用するユーザー名を指定します。HTTPSプロキシ認証をしない場合,指定する必要はありません。なし。任意
23HTTPSプロキシ認証パスワード
SSL_AUTH_PASSWORD
HTTPSプロキシで接続ユーザー認証をする場合に使用するパスワードを指定します。HTTPSプロキシ認証をしない場合,指定する必要はありません。なし。任意
24DB情報
DB_INFO
データベース接続先
DB_CONNECT_URL
接続先となるデータベースを特定するJDBCのURLを指定します。
  • Windowsの場合
    3.6.3 HiRDBのクライアント環境変数の設定」で指定したグループ名称を指定します。指定例を次に示します。
    jdbc:hitachi:dbplib://DB=hirdb,DBID=@DABENVGRP=MSHGRP
    指定例では,"MSHGRP"が,グループ名称になります。
  • UNIXの場合
    3.6.3 HiRDBのクライアント環境変数の設定」で設定したHiRDB.iniファイルのフルパスを指定します。指定例を次に示します。
    jdbc:hitachi:hirdb://DBID=@HIRDBENVGRP=/HiRDB/Client/HiRDB.ini
    指定例では,"/HiRDB/Client/"がHiRDB.iniファイルの格納先になります。
なし。必須
25データベース接続ユーザー
DB_USER
データベースへ接続するためのユーザー名を指定します。なし。必須
26データベース接続パスワード
DB_PASSWORD
データベースへ接続するためのパスワードを指定します。なし。必須
27送信タイマー
MSH_SEND_TIMER
AP通知タイマー
MSH_NOTIFYAP_TIMER
同時通知数
NOTIFICATION_VALUE
タイマーからuCosminexus Message Service for ebXMLへ同時に通知する件数を指定します。
指定できる値は,1~100の範囲です。
10任意
28タイマー用エンドポイント
DESTINATION_NAME
MSH実行環境が提供するタイマーのエンドポイント(EJBのルックアップ名)を指定します。
ebXMLサーバのデフォルト名称は"ebxml"です。サーバ名称を"ebxml"以外にする場合,デフォルト値"HITACHI_EJB/SERVERS/ebxml/EJB/MSH/MessageService"の"ebxml"を,指定するサーバ名称に変更してください。
ebXMLサーバの名称がデフォルトのままの場合は,ユーザーが指定する必要はありません。
HITACHI_EJB/SERVERS/
ebxml/EJB/MSH/
SendTimerAdapterEJB
(MSH_SEND_TIMERコンテナの場合)
HITACHI_EJB/SERVERS/
ebxml/EJB/MSH/
NotifyApTimerAdapterEJB
(MSH_NOTIFYAP_TIMERコンテナの場合)
任意
29トレースファイル名
TRACE_FILE_NAME
タイマーが出力するトレースファイル名をフルパス(相対的な内容を含まない)で,かつ120バイト以内で指定します。実際のトレースファイル名は,"<TRACE_FILE_NAMEで指定した名称>_[番号].log"となります。トレースファイル名の指定を省略した場合は,MSH実行環境ディレクトリ下のlogディレクトリに出力されます。MshSendTimer
(MSH_SEND_TIMERコンテナの場合)
MshNotifyApTimer
(MSH_NOTIFYAP_TIMERコンテナの場合)
任意
30トレースファイル数
OUTPUT_FILE_MAX_VALUE
トレースファイルの出力ファイル数を指定します。出力ファイル数が指定値になった場合,トレースファイルはラップアラウンドされます。指定できる値の範囲は,1~16です。4任意
31トレースファイルサイズ
FILE_SIZE_MAX_VALUE
個々のトレースファイルの最大サイズを指定します。単位はバイトです。
トレースファイルのサイズが指定したサイズを超過した場合,新しいトレースファイルが作成され,出力されます。
指定できる値は,4096~2147483647の範囲です。
8388608※2任意
32トレース出力レベル
TRACE_OUTPUT_LEVEL
トレースファイルに出力する情報のレベルを指定します。
指定できる値は,0,10,20,または30です。
20任意
33文字エンコーディング
ENCODELANG
Stringクラスで文字変換に使用するエンコード文字形態を指定します。
Javaがサポートしている文字エンコーディング(MS932など),または"OFF"(Java VMがサポートしている標準エンコードを使用する)を指定します。省略した場合,"OFF"が設定されます。なお,大文字と小文字は区別されます。
OFF任意
34トレース定義
TRACE
トレースファイル名
TRACE_FILE_NAME
MSH実行環境が出力するトレースファイル名をフルパス(相対的な内容を含まない)で,かつ120バイト以内で指定します。実際のトレースファイル名は,"<TRACE_FILE_NAMEで指定した名称>_[番号].log"となります。
トレースファイル名を省略した場合は,MSH実行環境ディレクトリ下のlogディレクトリに出力されます。
MshTrace任意
35トレースファイル数
OUTPUT_FILE_MAX_VALUE
トレースファイルの出力ファイル数を指定します。指定できる値は,1~16の範囲です。16任意
36トレースファイルサイズ
FILE_SIZE_MAX_VALUE
個々のトレースファイルの最大サイズを指定します。単位はバイトです。
指定できる値は,4096~2147483647の範囲です。
16777216※3任意
37トレース出力レベル
TRACE_OUTPUT_LEVEL
トレースファイルに出力する情報のレベルを指定します。0,10,20,または30です。20任意
38メッセージ交換定義
MSGDEF
キャッシュサイズ
CACHE_NUM
メモリ上で保持するメッセージ交換定義ファイルの最大数を指定します。
指定できる値は,10~1024の範囲です。
100任意
39メッセージ制御
MESSAGING
不正メッセージ退避フラグ
INVALIDMESSAGE_KEEP_FLAG
不正なebXMLメッセージを受信した場合にそのメッセージをファイル保存するかどうかを指定します。指定できる値は,"TRUE"(保存する)または"FALSE"(保存しない)です。大文字で指定してください。
"TRUE"時のファイルの保存場所は,MSH実行環境のディレクトリ下のngmsgディレクトリです。
FALSE任意
40実行環境閉塞フラグ
MSH_ENV_CLOSE_FLAG
イベント処理中に致命的エラーが発生した場合に,MSH実行環境を閉塞するかどうかを指定します。指定できる値は,"TRUE"(閉塞する)または"FALSE"(閉塞しない)です。大文字で指定してください。TRUE任意

注※1 デフォルト値は1MBです。

注※2 デフォルト値は8MBです。

注※3 デフォルト値は16MBです。


(5) 定義例