Agent Controller 構成ファイル
Agent Controller 構成は、2 つの構成ファイル・セットによって指定されます。最初のセットは、エンジンのデフォルト設定を記述する基本構成です。2 番目のセットは、エンジンのアプリケーション固有の設定を記述するプラグイン構成です。この文書では、それぞれの構成の詳細および構成拡張機能の作成方法について説明します。
この文書で、<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 サブディレクトリーになければなりません。通常、プラグイン・ディレクトリーの lib サブディレクトリーに JAR ファイルがあります。開発者は、XML スキーマ <install directory>/config/pluginconfig.xsd を使用して、プラグイン構成ファイルを構成することができます。
エレメントおよび属性
エレメント: AgentControllerConfiguration
これは、基本構成のルート・エレメントです。設定値は、エンジン・サービスの開始に使用されます。
何によって使用されるか: 基本構成
サブエレメント: AgentControllerEnvironment、Application、Hosts、Service、Agent、Option、Plugin
属性:
- activeConfiguration
- エンジンの始動時にロードする構成を指定します。
- filePort
- Agent Controller ファイル転送サービスが listen するポートを指定します。デフォルト値は 10005 です。
- isDataMultiplexed
- プロファイルおよびロギング・データを Agent Controller のコントロール・ チャネルで伝送するかどうかを指定します。デフォルトでは、データ・チャネルはデータ伝送に任意のポートを使用するため、ファイアウォールがあるとブロックされる可能性があります。データをコントロール・チャネルで転送すると、接続要求がファイアウォールを通過して着信するように、事前に定義された一連のポートがオープンされます。これらのポートには、デフォルト・ポート 10002、機密保護機能のあるポート 1003、およびファイル・サーバー・ポート 10005 があります。この属性のデフォルト値は false です。
- jvm
- Java 仮想マシン・ダイナミック・ランタイム・ライブラリー (jvm.dll または libjvm.so) の完全修飾パス。
- loggingDetail
- HIGH と指定すると、エンジンの行番号のロギングを可能にします。
- loggingDirectory
- エンジン・ログ・ファイル servicelog.log が作成されるディレクトリー。
- loggingLevel
- ログ・メッセージの重大度フィルター。
- port
- 保護されていない着信クライアント接続を listen するエンジン・ポート。
- processPolling
- プロセス状況のアクティブ検査を使用可能にするかどうかを指定します。この属性は、プロセスが終了するたびに Agent Controller に通知されるようにするために、主に Windows システムで使用されます。デフォルト値は true です。
- securedPort
- 保護された着信クライアント接続を listen するエンジン・ポート。
- version
- エンジンのバージョン。
エレメント: PluginConfiguration
これは、プラグイン構成のルート・エレメントです。設定値は、基本構成がロードされた後にロードされます。
何によって使用されるか: プラグイン構成
サブエレメント: AgentControllerEnvironment、Application、Service、Agent、Option
属性:
- 必要項目
- この構成が依存するプラグイン名のコンマで区切られたリスト。
エレメント: 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
- オプションの名前 (namespace など)。
- type
- オプションのタイプ (option name など)。
- value
- オプションの値。
エレメント: Plugin
これは、プラグイン構成を検索するディレクトリーを指定します。
何によって使用されるか: AgentControllerConfiguration
属性:
pathプラグイン構成を検索するための完全修飾ディレクトリー。
エレメント: Variable
環境変数。
何によって使用されるか: Application、AgentControllerEnvironment
属性:
- name
- 環境変数の名前 (CLASSPATH など)。
- value
- 環境変数の値。
- position
- この値を既存の値の後に付加するか、前に付加するか、または既存の値を置き換えるかを指定します。
エレメント: Parameter
プログラム・パラメーター。
何によって使用されるか: Application
属性:
- value
- プログラム・パラメーターの値。
- position
- このパラメーターを既存のパラメーターの後に付加するか、前に付加するか、または既存のパラメーターを置き換えるかを指定します。