>> Home
  + Past histories
  + Links

>> download

>> documents
  + Archtecrure Guide
  + Configuration
  + Tutorial
  + API Guide
  + Seasar Service

>> samples
  + Naval Battle
  + Chat

>> BBS
  + geoboard
    (旧掲示板)

>> Mail To Amoi
Home > documents > Configuration
初期設定ファイルの仕様

はじめに
初期設定ファイルは、jp.wda.gpss.system.Main の起動パラメータの第1引数として渡される、XML書式のファイルです。
ファイルの先頭は、必ず

<?xml version="1.0" encoding="ISO-8859-1"?>

としてください。
(ただし、初期設定ファイル中で日本語文字を使用する場合は、encodingを正しく指定してください。)

また、このファイルのルートノードは、 <XMLServer> となります。
ルートノード<XMLServer>の子ノードは以下の通りです。
子ノード 説明
<system> サーバのシステム情報
<script> ECMAScriptSocklet配備情報
<socklet> Socklet配備情報
<log4j> log4jプロパティ
<system>ノード
systemノードは、XMLServerノードの子ノードで、XMLServerノードの中に必ず1つだけ記述してください。
このノードでは、サーバのシステム情報を設定します。

記述できる属性値は以下の通りです。
属性名 説明 必須
port サーバの待受けポート番号を設定します。
デフォルトのポート番号は 9090 です。
 
encoding ソケットのエンコーディング名を設定します。
デフォルトのエンコーディングは UTF-8 です。
 
buffersize メッセージ送信バッファに溜めておける、メッセージ数を設定します。
デフォルトのメッセージ数は30です。
 
timeout 接続用初期コマンドのタイムアウト時間をミリ秒単位で設定します。
0を設定すると、タイムアウトしません。
デフォルトは0(タイムアウトしない)です。
 
default 配備されていないSocklet名を指定された場合に、デフォルトのSockletを使用するかしないかを設定します。
invalidateを指定すると、デフォルトのSockletを使用しません。
デフォルトは、"validate"(デフォルトのSockletを使用する)です。
 
classpath Sockletクラスを配置するディレクトリを指定します。
相対パスで指定した場合は、GPSS_HOMEからの相対パスとして扱われます。
(ver1.04追加)
 

このノードの子ノードは以下の通りです。
子ノード 説明
<command> システムコマンドの受付を許可するホストアドレスを指定します。
<logger> システムログ取得情報を指定します。
<command>ノード
commandノードは、systemノードの子ノードで、systemノード中に何回でも記述できます。
サーバのシャットダウンなどを行なう「SystemCommandApplication」Sockletを実行できるIPアドレスを指定します。

記述できる属性値は以下の通りです。
属性名 説明 必須
allow システムコマンド実行許可IPアドレスを指定します。

このノードの子ノードは存在しません。
<script>ノード
scriptノードは、XMLServerノードの子ノードとして、XMLServerノード中に何回でも記述できます。
このノードでは、指定されたディレクトリの中にあるECMAScriptSockletを、サーバへ自動的に配備するための情報を設定します。

記述できる属性値は以下の通りです。
属性名 説明 必須
extention ECMAScriptSockletファイルの拡張子を指定します。
encoding スクリプトソースファイルのエンコーディング名を設定します。
デフォルトのエンコーディングは UTF-8 です。
 
dir ECMAScriptSockletファイルを配置するディレクトリを指定します。
class ECMAScriptSockletのインタプリタとして機能するSockletを指定します。

GPSSに付属するインタプリタとしては、FESIエンジンを使用する
jp.wda.gpss.system.JsApplication
と、MozillaプロジェクトのRhinoエンジンを使用する
jp.wda.gpss.system.RhinoJsApplication
の二つがあります。

このノードの子ノードは以下の通りです。
子ノード 説明
<init-param> ECMAScriptSockletの初期化時に渡される初期化パラメータ情報
<init-param>ノード (<script> の子ノード)
init-paramノードは、scriptノードの子ノードとして、scriptノードの中に何回でも記述できます。
このノードでは、ECMAScriptSockletの初期化パラメータを設定します。
同じ初期化パラメータ名を持つ初期化パラメータを複数設定することが出来ます。

このノードで設定された初期化パラメータ値は、GeneralSocklet#getInitParamで取得することが出来ます。

記述できる属性値は以下の通りです。
属性名 説明 必須
application 初期化パラメータを設定したいECMAScriptSocklet配備名を指定します。
key 初期化パラメータの検索キー(初期化パラメータ名)を指定します。
value 初期化パラメータ値を設定します。

このノードの、子ノードは存在しません。
<socklet>ノード
sockletノードは、XMLServerノードの子ノードとして、XMLServerノード中に何回でも記述できます。
このノードでは、Sockletをサーバへ配備するための情報を設定します。
配備名を変えることにより、同じクラスを使用する複数のSockletを、サーバへ配備することが出来ます。

記述できる属性値は以下の通りです。
属性名 説明 必須
name Socklet配備名を設定してください。
この配備名を使用して、SocketクライアントはSockletへの接続を試みます。
class Sockletクラスを指定します。
timeout クライアントからのコマンド待受けするタイムアウト時間をミリ秒単位で設定します。
0を設定すると、タイムアウトしません。
デフォルトは0(タイムアウトしない)です。
 

このノードの子ノードは以下の通りです。
子ノード 説明
<init-param> Sockletの初期化時に渡される初期化パラメータ情報
<logger> Sockletログ取得情報を指定します。
<init-param>ノード (<socklet>の子ノード)
init-paramノードは、applicationノードの子ノードとして、applicationノードの中に何回でも記述できます。
このノードでは、Sockletの初期化パラメータを設定します。
同じ初期化パラメータ名を持つ初期化パラメータを複数設定することが出来ます。

このノードで設定された初期化パラメータ値は、GeneralSocklet#getInitParamで取得することが出来ます。

記述できる属性値は以下の通りです。
属性名 説明 必須
key 初期化パラメータの検索キー(初期化パラメータ名)を指定します。
value 初期化パラメータ値を設定します。

このノードの、子ノードは存在しません。
<logger>ノード
loggerノードは、systemノードまたはsockletノードの子ノードとして、親ノード中に1回だけ記述できます。
このノードでは、org.apache.log4j.DailyRollingFileAppenderを使用したサーバログを取得するための情報を設定します。
ログ記録形式はorg.apache.log4j.PatternLayoutに従います。

より柔軟にlog4jプロパティを設定したい場合は、<log4j>ノードを使用してください。

記述できる属性値は以下の通りです。
属性名 説明 必須
mode ログ取得モードを指定します。
指定できるモード文字列は以下の通りです。

ALL
DEBUG
WARN
INFO

デフォルトではWARNとなります。
 
file ログファイルを出力する場所とファイル名を指定します。
encoding ログファイルのエンコーディング種類を指定します。
デフォルトでは"UTF-8"が用いられます。
 
layoutPattern ログ記録形式を指定します。
記録形式として使用できる文字は、
org.apache.log4j.PatternLayout
のドキュメントをご覧ください。
デフォルトの記録形式は、
"[%d{yyyy/MM/dd HH:mm:ss}] %m%n"
です。
 

このノードの子ノードは存在しません。
<log4j>ノード
<log4j>ノード