pluginconfig.xml ファイル

目次

 

この文書でファイルとディレクトリーのロケーションを参照する場合、 <install-home> は、 Agent Controller パッケージが unzip されたディレクトリーになります。

概要

pluginconfig.xml ファイルは、<install-home>\plugins\<plugin-name>\config 下にあります。  これは、個々に組み込まれたアプリケーションの必要性に応じ、serviceconfig.xml で定義されたグローバル環境およびアプリケーション・エイリアスを拡張するメカニズムです。  serviceconfig.xml で定義される環境設定を拡張すると、Agent Controller により起動されたすべてのアプリケーションが、その環境をすべて継承するため影響を受けます。  この「プラグイン」により、Agent Controller により開始されたその他のプロセスでそのアプリケーションが配置可能になります (例えば、CLASSPATH 環境変数にそのパスを追加するなど)。アプリケーション・エイリアス・リストの拡張により、そのリスト内のサービスのみの起動に制限するよう Agent Controller が構成されている場合、新規アプリケーションが起動されるようになります。

このように、pluginconfig.xml により、Agent Controller の基本インストールではオプションである、アドオン・コンポーネントのパッケージ化のメカニズムが提供されます。  serviceconfig.xml ファイルそのものは変更できませんが、アドオンの除去は同様に簡単です。  

エージェントでは、pluginconfig.xml および agent.xml の両方を必要とする場合があります。 agent.xml ファイルは、使用可能な (つまり、発見可能な) エージェントの検索時に、新規の Agent Controller にエージェント・アプリケーションを定義する場合に必要です。  pluginconfig.xml は、エージェントが serviceconfig.xml 環境またはエイリアス・リストの拡張を必要とする場合に必要です。 agent.xml ファイルの使用により、将来のリリースでの pluginconfig.xml の使用が置き換えられます。

ここで使用している「プラグイン」という用語は、Eclipse プラグインとはあまり関係ありません。  最初に実際のプラグインが使用されたために使用されています。  しかし、この構成ファイルが、Eclipse ワークベンチへのインストールに適合するプラグインとして認められる以外のすべてのアプリケーションを参照するため、不適切な名称となってしまいました。

pluginconfig.xml ファイルには、以下の主なセグメントが含まれています。

 

プラグイン構成

 

pluginconfig.xml ファイルに含まれている要素の階層を以下に示します。同一レベルで示される要素の順番は重要ではありません。階層のハイパーリンクは、『要素と属性』セクションの形式的要素記述にリンクされています。


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Application
            Variable
            Parameter
        Agent
            Option

       

要素と属性

 

要素: PluginConfiguration
プラグイン構成のルート要素です。  AgentControllerEnvironment は一度のみ使用可能です。その他の要素 (Option、Application、および Agent) では、複数の使用が可能です。  サブ要素は、すべて省略されます。

サブ要素:     AgentControllerEnvironment

                            Option
                            Application
                            Agent
                           
属性:

requires
(オプション) この文字列値は、この構成が依存するプラグイン名の、コンマで区切られたリストです。 TPTP 4.0 以降、プラグイン名にバージョン識別子サフィックスが追加されています。これは、下線文字とその後に続くリリースのバージョン番号から構成されます。 例: org.eclipse.tptp.platform.agentcontroller_4.0.0. 前のリリースからのプラグイン (バージョン識別子サフィックスを持たないプラグイン) への依存関係を持つアプリケーションに関するプラグイン互換性を保証するために、バージョン識別子を除く「必要項目」属性のためにプラグイン名を指定できます。この場合、Agent Controller の構成ローダーは、最初に、バージョン識別子サフィックスを含めて完全なプラグイン名を探し出すように試みます。これが正常に終わらない場合、構成ローダーは次に、バージョン識別子サフィックスを除いてプラグイン名を検索します。同じ名前を持つプラグインが複数ある場合、オペレーティング・システムによって戻された最初のプラグイン名が使用されます。

要素: AgentControllerEnvironment
AgentControllerEnvironment 要素には、1 つ以上の Variable 要素が含まれ、serviceconfig.xml で定義されたグローバル環境変数を拡張します。  これは、すべてのアプリケーションの起動で使用される環境の一部になります。


使用する要素: PluginConfiguration

サブ要素:     Variable

 

要素: Variable

この Variable 要素は、環境変数およびその環境変数を既存環境内に配置する方法を定義して、起動されるすべてのアプリケーションおよびエージェントに対する新規のデフォルト環境を形成します。 AgentControllerEnvironment 用に定義されたこれらの要素は、ゼロまたはそれ以上存在します。

使用する要素: AgentControllerEnvironment

属性:

name
この文字列値は、環境変数の名前を指定します。
value
この文字列値は、環境変数の値を指定します。
position
(オプション) この文字列値は、「append」、「prepend」、または「replace」のいずれかであり、既存のデフォルト環境を基準にこの環境を配置する場所を指示します。

要素: Option
PluginConfiguration の先頭にある Option 要素は、Agent Controller への登録時に各エージェントに渡される、任意の構成データの指定に使用されます。この情報は、各エージェントに対してクライアントに戻される、プロパティー情報に含まれます。エージェントは、それがフィットするように (またはしないように)、この情報を解釈できます。 Option 情報は、Agent Controller のオリジナルの API (下位互換性レイヤー) を使用するエージェントに対してのみ提供されます。新規 API を使用してエージェントに構成情報を提供する場合は、agent.xml 構成ファイルを使用します。

使用する要素: Agent

属性:

name
この文字列値は、オプションの名前空間を指定します。
type
この文字列値は、オプションの名前を指定します。
value
この文字列は、オプションの値を指定します。
要素: Application
Application 要素では、アプリケーションのエイリアス名および起動情報を定義または拡張します。これには、起動時にその特定のアプリケーションに対してのみ可視になる、環境設定を含めることができます。  このアプリケーション・エイリアスは、serviceconfig.xml の ApplicationAliases 要素内で定義されるリストに追加されます。


使用する要素: PluginConfiguration

サブ要素:     Variable

                            Parameter

属性:

executable
この文字列値では、「path」属性で指定されたアプリケーションの実行可能ファイルの別名を指定します。クライアントは、この名前を使用してこのアプリケーションを識別する必要があります。  extends 属性も指定されている場合は、ここで指定された名前が前に定義された別名と一致する必要があります。 
path
この文字列値では、 起動するアプリケーションの絶対パス名を指定しますこれは、アプリケーションの実行可能ファイルを起動するときに別名の代わりに使用されます。
この属性は、extends 属性が指定された場合に無視されます。 
location
(オプション) この文字列値では、実行可能ファイルを起動するディレクトリーを指定します。このディレクトリーは、実行可能ファイルの実行時の作業ディレクトリーと呼ばれることもあります。
extends
(オプション) この文字列値では、既に定義済みのアプリケーション・エイリアスの構成名を指定します。ただし、構成名はサポートされないため、この属性の値は「default」に設定する必要があります。 extends が指定されている場合 (値に関係なく)、この Application に含まれている情報により、一致するアプリケーション・エイリアスで既に定義済みの起動情報が拡張されることを示します。 path 値 (つまり、起動中の実行可能ファイル) の変更は許可されません。実行可能ファイル名に一致するファイルがない場合、Application 要素は有効になりません。

要素: Variable
この Variable 要素では、環境変数と、アプリケーションを起動するときに、その環境変数を既存環境内に配置する方法を定義します。アプリケーション用に定義されたこれらの要素は、ゼロまたはそれ以上存在します。

使用する要素: Application

属性:

name
この文字列値は、環境変数の名前を指定します。
value
この文字列値は、環境変数の値を指定します。
position
(オプション) この文字列値は、「append」、「prepend」、または「replace」のいずれかであり、デフォルト環境を基準にこの環境を配置する場所を指示します。

要素: Parameter

Parameter 要素は、起動時にアプリケーションに指定するコマンド行引数を定義します。アプリケーション用に定義されたこれらの要素は、ゼロまたはそれ以上存在します。

使用する要素: Application

属性:

value
この文字列値はコマンド行引数を指定します。
position
(オプション) この文字列値は、「append」、「prepend」、または「replace」のいずれかであり、既存のコマンド行引数を基準にこの引数を配置する場所を指示します。

要素: Agent
特定のエージェントに対する構成情報を提供します。 Agent Controller のオリジナルの  API (下位互換性レイヤー) を使用するエージェントでのみ使用されます。新規 API を使用してエージェントに構成情報を提供する場合は、agent.xml 構成ファイルを使用します。

使用する要素: PluginConfiguration

サブ要素:     Option

属性:

name
この文字列値では、この構成情報を適用するエージェントの名前を指定します。
type
(オプション) この文字列値では、エージェントのタイプを指定します。
dataChannelSize
(オプション) この文字列値では、プロセス間通信に対して割り振る共用メモリーの量を指定します。 M または K のサフィックスが付いた正整数で表現される値は、それぞれ M バイトまたは K バイトを表し、サフィックスがない場合はバイトを表します。値の例: "16M"、"8K"、または "16000"。
logFile
(オプション) この文字列では、ファイルの完全修飾パス名を指定します。指定されると、通常はデータ・チャネルを介してクライアントに届くデータが、代わりにこのファイルに書き込まれます。
client
(オプション) この文字列では、このエージェントがクライアントと対話するするかどうかを指定します。  使用可能な値は、"DYNAMIC" または "HEADLESS" です。    HEADLESS は、関連するクライアントがないことを示します。  デフォルトは DYNAMIC です。
extends
(オプション) この文字列値では、既に定義済みの Agent の構成名を指定します。ただし、構成名はサポートされないため、この属性の値は「default」に設定する必要があります。 extends が指定されている場合 (値に関係なく)、この Agent に含まれている情報により、一致する Agent 要素で既に定義済みの構成情報が拡張されることを示します。特定のエージェントに関連した Option のリストの拡張に使用されます。

要素: Option
Agent 要素内の Option サブ要素は、  Agent Controller への登録時にそのエージェントに渡される、任意の構成データの指定に使用されます。   エージェントは、それがフィットするように (またはしないように)、この情報を解釈できます。

使用する要素: Agent

属性:

name
オプションを命名する任意の文字列 (つまり名前空間)
type
オプションのタイプを命名する任意の文字列 (つまりオプション名)
value
オプションの任意の文字列値

サンプル pluginconfig.xml ファイル

 

<PluginConfiguration requires="org.eclipse.tptp.platform.collection.framework">
    <AgentControllerEnvironment>
        <Variable name="CLASSPATH_MY_AGENTS" position="append"
        value="%PLUGINS_HOME%\org.eclipse.tptp.myagents\lib\coreagent.jar" />
    </AgentControllerEnvironment>

    <Application executable="MyAgent" location="%SYS_TEMP_DIR%" path="%JAVA_PATH%">

        <Variable name="CLASSPATH" position="append"
          value="%PLUGINS_HOME%\org.eclipse.tptp.myagents\jmx\lib\jmxagent.jar" />  
        <Variable name="CLASSPATH" position="append" value="%CLASSPATH_MY_AGENTS%" />  
        <Parameter position="append" value="-Dapp_home=%MY_HOME%" />  
        <Parameter position="append" value="-DagentXML=%PLUGINS_HOME%
          \org.eclipse.tptp.myagents\jmx\agentXML\MyAgent.xml" />
    </Application>

    <Option name="org.eclipse.tptp.Myagents" type="version" value="2.0"/> 

</PluginConfiguration>
 

関連参照

エージェントと Agent Controller 構成の概要


Copyright (C) 2006 Intel Corporation.