Agent Controller 構成ファイル
Agent Controller の構成は、2 セットの構成ファイルで指定します。1 つのセットは基本構成であり、エンジンのデフォルトの設定が記述されています。もう 1 つのセットはプラグイン構成であり、エンジンのアプリケーション固有の設定が記述されています。この資料では、各構成の詳細および構成拡張機能の記述方法について説明します。
この資料で参照されているディレクトリー <install directory> は、Agent Controller をアンパックしたパスに対応します。このディレクトリーは、構成ファイル内で %RASERVER_HOME% としても参照されます。
基本構成
基本構成は <install directory>/config/serviceconfig.xml ファイルより成り、このファイルは XML スキーマ <install directory>/config/serviceconfig.xsd を使用して作成されます。基本構成では、システム環境変数、アプリケーション構成、Agent Controller の接続などのデフォルトの設定が指定されています。基本構成はすべての構成で利用でき、エンジン・サービスが開始するときにロードされます。基本構成に対する変更はすべてグローバルに適用されるので、アプリケーション開発者はこの基本構成ファイルを変更しないでください。プラグインおよびアプリケーションに固有の設定を指定するには、プラグイン構成を使用する必要があります (後で説明します)。
プラグイン構成
各ユーザー定義アプリケーションに対し、構成ファイルおよび依存関係にあるものがプラグイン・ディレクトリー <install directory>/plugin/<plug-in name> に格納されていなければなりません。<plug-in name> は、アプリケーションを識別する固有の名前です。プラグイン構成ファイル pluginconfig.xml は、プラグイン・ディレクトリーの config サブディレクトリーに格納する必要があります。通常、JAR ファイルは、プラグイン・ディレクトリーの lib サブディレクトリーに格納します。開発者は、XML スキーマ <install directory>/config/pluginconfig.xsd を使用して、プラグイン構成ファイルを作成できます。
要素と属性
要素: AgentControllerConfiguration
基本構成のルート要素です。この設定は、エンジン・サービスを開始するために使用されます。
使用する要素: 基本構成
サブ要素: AgentControllerEnvironment、Application、Hosts、Service、Agent、Option、Plugin
属性:
- activeConfiguration
- エンジン開始時にロードする構成を指定します。
- filePort
- Agent Controller ファイル転送サービスが listen するポートを指定します。デフォルト値は 10005 です。
- isDataMultiplexed
- プロファイルおよびロギング・データを Agent Controller のコントロール・チャネルを経由して伝送するかどうかを指定します。デフォルトでは、データ・チャネルはデータ伝送に任意のポートを使用し、ファイアウォールの存在によってブロックされることがあります。コントロール・チャネルを経由してデータを転送することによって、事前定義されたポートのセットを、ファイアウォールを通過した着信接続要求に対して開くことができます。これらのポートには、デフォルト・ポートの 10002、保護されたポートの 10003、およびファイル・サーバー・ポートの 10005 が含まれます。この属性のデフォルト値は false です。
- jvm
- Java 仮想マシン動的ランタイム・ライブラリー (jvm.dll または libjvm.so) の完全修飾パスです。
- loggingDetail
- HIGH を指定すると、エンジンの行番号ロギングが使用可能になります。
- loggingDirectory
- エンジンのログ・ファイル servicelog.log が作成されるディレクトリーです。
- loggingLevel
- ログ・メッセージの重大度フィルターです。
- port
- 着信する非セキュア・クライアント接続を listen するためのエンジン・ポートです。
- processPolling
- プロセス状況のアクティブ検査を使用可能にするかどうかを指定します。この属性は、主に Windows システムで使用され、プロセスが終了すると、常に Agent Controller に通知するようにします。デフォルト値は true です。
- securedPort
- 着信するセキュア・クライアント接続を listen するためのエンジン・ポートです。
- version
- エンジンのバージョンです。
要素: PluginConfiguration
プラグイン構成のルート要素です。この設定は、基本構成がロードされた後でロードされます。
使用する要素: プラグイン構成
サブ要素: AgentControllerEnvironment、Application、Service、Agent、Option
属性:
- requires
- この構成が依存するプラグイン名の、コンマで区切られたリストです。TPTP 4.0 以降、プラグイン名にバージョン識別子サフィックスが追加されています。これは、下線文字とその後に続くリリースのバージョン番号から構成されます。 例: org.eclipse.tptp.platform.agentcontroller_4.0.0. 前のリリースからのプラグイン (バージョン識別子サフィックスを持たないプラグイン) への依存関係を持つアプリケーションに関するプラグイン互換性を保証するために、バージョン識別子を除く「必要項目」属性のためにプラグイン名を指定することができます。この場合、Agent Controller の構成ローダーは、最初に、バージョン識別子サフィックスを含めて完全なプラグイン名を探し出すように試みます。これが正常に終わらない場合、構成ローダーは次に、バージョン識別子サフィックスを除いてプラグイン名を検索します。同じ名前を持つプラグインが複数ある場合、オペレーティング・システムによって戻された最初のプラグイン名が使用されます。
要素: AgentControllerEnvironment
この構成によって設定されるグローバル環境変数のプレースホルダーです。これらの環境変数はシステムに対して公開され、基本構成を含む他のすべての構成が使用できます。
使用する要素: AgentControllerConfiguration、PluginConfiguration
サブ要素: Variable
属性:
- configuration
- 環境変数が追加される構成の名前です。
要素: Application
アプリケーション固有の環境に対するプレースホルダーです。内部の設定は、その特定のアプリケーションのみが参照できます。
使用する要素: AgentControllerConfiguration、PluginConfiguration
サブ要素: Variable、Parameter
属性:
- configuration
- アプリケーションが追加される構成の名前です。
- executable
- アプリケーションの名前です。クライアントは、この名前を使用してこのアプリケーションを識別する必要があります。
- path
- このアプリケーションを実行するプログラムの実際の完全修飾パスです。
- location
- このアプリケーションの作業ディレクトリーです。
- extends
- 同じアプリケーションが既に定義されている構成名です。この属性を指定すると、現在の設定が上位に追加されます。
要素: Hosts
ホスト情報に対するプレースホルダーです。エンジンは、この要素を使用して、特定のホストの接続を許可または禁止します。
使用する要素: AgentControllerConfiguration
サブ要素: Allow、Deny
属性:
configuration
このホスト情報を使用する構成の名前です。
要素: Allow
エンジンへの接続を許可されているホストを指定します。
使用する要素: Hosts
属性:
- host
- ホストの名前または IP アドレスです。
- net
- サブネットです。
- mask
- サブネット・マスクです。
要素: Deny
エンジンへの接続を禁止されているホストを指定します。
使用する要素: Hosts
属性:
- host
- ホストの名前または IP アドレスです。
- net
- サブネットです。
- mask
- サブネット・マスクです。
要素: Service
エンジンの開始時にロードするユーザー定義モジュールを指定します。
使用する要素: AgentControllerConfiguration、PluginConfiguration
サブ要素: Option
属性:
- configuration
- このサービスがロードされる構成の名前です。
- name
- サービスの名前です。
- path
- 動的ロード・ライブラリーの完全修飾パスです。
要素: Agent
エージェント固有の情報を指定します。
使用する要素: AgentControllerConfiguration、PluginConfiguration
サブ要素: Option
属性:
- configuration
- このエージェント構成を使用する構成の名前です。
- name
- エージェントの名前です。
- type
- エージェントのタイプです。
- dataChannelSize
- プロセス間通信のために割り振る共用メモリーの大きさです。
- logFile
- エージェントから送信されたメッセージを書き込むログ・ファイルの完全修飾パスです。
- client
- このエージェントが動的かヘッドレスかを指定します。
要素: Option
名前と値のペアを格納するために使用します。
使用する要素: AgentControllerConfiguration、PluginConfiguration、Service、Agent
属性:
- name
- オプションの名前です (つまり名前空間)。
- type
- オプションのタイプです (つまりオプション名)。
- value
- オプションの値です。
要素: Plugin
プラグイン構成を検索するディレクトリーを指定します。
使用する要素: AgentControllerConfiguration
属性:
pathプラグイン構成を検索する完全修飾ディレクトリーです。
要素: Variable
環境変数です。
使用する要素: Application、AgentControllerEnvironment
属性:
- name
- 環境変数の名前です (CLASSPATH など)。
- value
- 環境変数の値です。
- position
- この値を既存の値の後に付加するか、前に付加するか、または既存の値と置き換えるかを指定します。
要素: Parameter
プログラム・パラメーターです。
使用する要素: Application
属性:
- value
- プログラム・パラメーターの値です。
- position
- このパラメーターを既存のパラメーターの後に付加するか、前に付加するか、または既存のパラメーターと置き換えるかを指定します。