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/<plugin name> に
格納されていなければなりません。<plugin name> は、アプリケーションを
識別する固有の名前です。プラグイン構成ファイル pluginconfig.xml は、
プラグイン・ディレクトリーの config サブディレクトリーに格納する必要が
あります。通常、JAR ファイルは、プラグイン・ディレクトリーの lib サブディレクトリーに
格納します。開発者は、XML スキーマ <install directory>/config/pluginconfig.xsd を使用して、
プラグイン構成ファイルを作成できます。
エレメントと属性
エレメント: AgentControllerConfiguration
基本構成のルート・エレメントです。この設定は、エンジン・サービスを開始するために使用されます。
使用するエレメント: 基本構成
サブエレメント: AgentControllerEnvironment、Application、Hosts、Service、Agent、Option、Plugin
属性:
- activeConfiguration
- エンジン開始時にロードする構成を指定します。
- jvm
- Java 仮想マシン動的ランタイム・ライブラリー (jvm.dll または libjvm.so) の完全修飾パスです。
- loggingDetail
- HIGH を指定すると、エンジンの行番号ロギングが使用可能になります。
- loggingDirectory
- エンジンのログ・ファイル servicelog.log が作成されるディレクトリーです。
- loggingLevel
- ログ・メッセージの重大度フィルターです。
- port
- 着信する非セキュア・クライアント接続を listen するためのエンジン・ポートです。
- securedPort
- 着信するセキュア・クライアント接続を listen するためのエンジン・ポートです。
- version
- エンジンのバージョンです。
エレメント: PluginConfiguration
プラグイン構成のルート・エレメントです。この設定は、基本構成がロードされた後でロードされます。
使用するエレメント: プラグイン構成
サブエレメント: AgentControllerEnvironment、Application、Service、Agent、Option
属性:
- requires
- この構成が依存するプラグイン名の、コンマで区切られたリストです。
エレメント: 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
- このパラメーターを既存のパラメーターの後に付加するか、前に付加するか、または既存のパラメーターと置き換えるかを指定します。