3.1.2 コンフィグレーションファイル

ebMSにはebMS全体の動作を設定するコンフィグレーションファイルがあります。本項では、コンフィグレーションファイルで設定する項目について説明します。なお、コンフィグレーションファイルはebMSの起動やCPA管理機能のコマンド実行時に参照します。

コンフィグレーションファイルの格納場所

コンフィグレーションファイルは、ebMSをインストールすることで以下の場所に格納されます。

C:\Interstage\F3FMebms\etc\ebms.cfg

/opt/FJSVebms/etc/ebms.cfg

コンフィグレーションファイルの書式

記述規約については、“付録A 定義記述規約”を参照してください。

コンフィグレーションファイルの記述

コンフィグレーションファイルは、以下のセクションから構成されます。

CONFIGURATIONセクション

コンフィグレーションファイルは以下の形式で記述します。

記述形式

[CONFIGURATION]

CPADEF_STORED_DIR = CPA管理ディレクトリ
LOG_ROTATION_SIZE = 通信ログのローテーションサイズ
LOG_ROTATION_MAX = 通信ログの保存世代数
SEND_TIMEOUT = 送信時タイムアウト時間
SEND_ERROR_OCCURED = 送信エラー発生時の挙動
USE_PAYLOAD_FILE = ペイロードとして一般ファイルを使用
PAYLOAD_FILEPATH = ペイロードとして一般ファイルを使用する場合の格納ディレクトリ

SSL_DEF_NAME = Interstage証明書環境を使用する場合のSSL定義名

記述内容の説明

a) CONFIGURATIONセクション

ebMSの動作を制御するために必要な情報を記述します。以下に記述内容を示します。

キーワード	省略	データ型	記述方法	記述内容の説明
CPADEF_STORED_DIR	可	文字列	絶対パス名で指定します。ただし、FJ_EBMS_CPADEF_STORED_DIRと指定した場合および省略した場合は、以下の値を指定したものとみなします。 C:\Interstage\F3FMebms\cpa /opt/FJSVebms/cpa	CPA管理情報を格納するディレクトリを指定します。
LOG_ROTATION_SIZE	可	数値	1000～100000の数値で指定します。省略値は10000です。	通信ログに記録するおよその行数を指定します。指定した行数を過ぎると、世代交代が発生します。なお、世代交代の詳細については、“2.6.4 通信ログの世代交代”を参照してください。
LOG_ROTATION_MAX	可	数値	1～100の数値で指定します。省略値は5です。	通信ログの保存世代数を指定します。通信ログが指定された保存世代数を超えた場合、最も古い通信ログから削除します。
SEND_TIMEOUT	可	数値	60～86400の数値で指定します。省略値は300です。	SOAPの通信タイムアウト時間を秒で指定します。受信側での異常や回線異常などにより通信時間が指定時間を超えた場合には、通信回線を強制的に切断します。通信回線の性能と送信するペイロード長によっては通信時間が長くなりタイムアウトが発生する場合があります。このため通信時間を考慮して余裕のある値を設定してください。
SEND_ERROR_OCCURED	可	文字列	STOP (SEND_ERROR_OCCURED が省略されている場合はSTOPが指定されたものとみなします）	エラーが発生したイベントチャネルからの送信処理を停止します。
SEND_ERROR_OCCURED	可	文字列	CONTINUE	エラーが発生した場合、次のメッセージの送信処理を継続します。
USE_PAYLOAD_FILE	可	文字列	LARGE_PAYLOAD_ONLY (USE_PAYLOAD_FILE が省略されている場合はLARGE_PAYLOAD_ONLYが指定されたものとみなします）	メッセージを送信する際、通信パラメタ「PayloadFilePath」が指定されている場合、指定されているファイルをペイロードとして送信します。指定されていない場合、イベントチャネルに格納されたイベントデータ内に設定されているボディデータをペイロードとして送信します。メッセージを受信する際には、ペイロードが2Mバイト以下の場合はイベントデータ内のボディデータに設定し、2Mバイトを超える場合はペイロードをファイルに出力します。出力先のディレクトリはコンフィグレーションファイルの「PAYLOAD_FILE_PATH」で指定したディレクトリになります。
USE_PAYLOAD_FILE	可	文字列	ALWAYS	メッセージを送信する際、通信パラメタ「PayloadFilePath」が指定されている場合、指定されているファイルをペイロードとして送信します。指定されていない場合、イベントチャネルに格納されたイベントデータ内に設定されているボディデータをペイロードとして送信します。メッセージを受信する際には、常にペイロードをファイルに出力します。出力先のディレクトリはコンフィグレーションファイルの「PAYLOAD_FILE_PATH」で指定したディレクトリになります。
PAYLOAD_FILEPATH	可	文字列	絶対パス名で指定します。省略した場合には、以下の値を指定したものとみなします。 C:\Interstage\F3FMebms\payload /opt/FJSVebms/payload	USE_PAYLOAD_FILE にLARGE_PAYLOAD_ONLY を指定している場合、メッセージを受信した際に、2Mバイトを超えるペイロードが添付されていた時のみ指定したディレクトリにファイル出力します。 USE_PAYLOAD_FILE に ALWAYS を指定している場合、メッセージを受信する際に、常に指定したディレクトリにペイロードをファイル出力します。
SSL_DEF_NAME	可	文字列	文字列で指定します。以下の形式で指定してください。 "-Dcom.fujitsu.interstage.soapx.sslname=ssl定義名"	Interstage証明書環境を使用する場合のSSL定義名を指定します。

すべてのキーワードを省略する場合にも、コンフィグレーションファイルは削除しないでください。
CPADEF_STORED_DIRで指定したディレクトリにはユーザデータなど（CPA管理機能が作成するファイル以外）のファイルを置かないでください。CPA管理機能が作成するファイル以外のファイルを置いた場合はebMSの動作を保証しません。
SEND_ERROR_OCCURED に CONTINUE を指定している場合、エラーが発生すると送信失敗したメッセージは以下のようになります。
- メッセージを再送する設定にしていた場合、かつ、送信失敗した原因として ebms1215, ebms1216, ebms1238 のメッセージが出力されている場合は ebMS によって自動的に再送されます。
- ebms1215, ebms1216, ebms1238 以外のメッセージが出力されている場合は、メッセージを構築するまでにエラーが発生したため、メッセージを再送する設定にしていても、メッセージは再送されません。
メッセージ受信時にペイロードがファイルに出力される場合、ファイル名は ebMS が、自動的に生成します。アプリケーションはファイル名を通信パラメタで獲得することができます。詳細は“6.2.3 通信パラメタ一覧”を参照してください。
メッセージ送受信時にファイルを用いる場合、ebMS は送信済みペイロードファイルおよび受信済みペイロードファイルを一切削除しません。
PAYLOAD_FILEPATH に相対パス名を設定することは可能ですが、ebMSを起動した場所からの相対パスが設定されます。ebMSの受信機能にとってのカレントディレクトリからの相対パスは設定されません。混乱の元ですので、絶対パスで指定することを推奨します。
Interstage証明書環境およびSSL定義名についての詳細は、“セキュリティシステム運用ガイド”を参照してください。
旧証明書環境を使用する場合には SSL_DEF_NAME は指定しないでください。
Interstage CollaborationRing から使用する場合には、 Interstage CollaborationRing のマニュアル記述を優先させてください。