Datei pluginconfig.xml

Inhalt

 

Hinweis

Bei Verweisen auf Datei- und Verzeichnispositionen in diesem Dokument steht <install-home> für das Verzeichnis, in dem sich das Paket des Agentencontrollers entpackt wurde.

Einführung

Die Datei pluginconfig.xml befindet sich unter <install-home>\plugins\<plugin-name>\config.  Sie ist der Mechanismus zur Erweiterung der globalen Umgebung und der Anwendungsaliasnamen, die in der Datei serviceconfig.xml nach den Bedürfnissen der einzeln gepackten Anwendungen definiert sind.   Wenn die Umgebungseinstellungen erweitert werden, die in der Datei serviceconfig.xml definiert sind, hat dies Auswirkungen auf alle Anwendungen (einschließlich der Agenten), die vom Agentencontroller gestartet werden, da sie alle diese Umgebung übernehmen.  Dies ermöglicht es einem "Plug-in", seine Anwendungen für andere Prozesse lokalisierbar zu machen, die vom Agentencontroller gestartet werden (zum Beispiel durch Hinzufügen seines Pfads zur Umgebungsvariablen CLASSPATH). Wenn die Liste der Anwendungsaliasnamen erweitert wird, kann so eine neue Anwendung gestartet werden, wenn der Agentencontroller so konfiguriert ist, dass er zum Starten nur die Services in der Liste verwenden darf.

Somit stellt die Datei pluginconfig.xml einen Mechanismus zur Paketierung von Add-on-Komponenten dar, die für die Basisinstallation des Agentencontrollers optional sind.  Da die Datei 'serviceconfig.xml' selbst nicht geändert wird, ist die Entfernung der Add-ons ebenso einfach.  

Für Agenten kann sowohl die Datei pluginconfig.xml als auch die Datei agent.xml erforderlich sein. Die Datei agent.xml ist zum Definieren einer Agentenanwendung erforderlich, wenn Sie möchten, dass der neue Agentencontroller gestartet wird, wenn Sie nach verfügbaren Agenten suchen (das heißt, wenn sie entdeckt werden können).  Die Datei pluginconfig.xml ist erforderlich, wenn der Agent die Umgebung oder Aliasliste in serviceconfig.xml erweitern muss. Die Verwendung der Datei agent.xml ersetzt die Verwendung der Datei pluginconfig.xml in zukünftigen Releases.

Hinweis

Die hier verwendete Bezeichnung "plugin" bezieht sich nur in einem weiteren Sinn auf ein Eclipse-Plug-in.  Sie wurde verwendet, weil anfangs tatsächlich Plug-ins verwendet wurden.  Inzwischen ist sie aber irreführend, da diese Konfigurationsdatei auf eine beliebige Anwendung verweisen kann, ohne das ein Einschluss als Plug-in erforderlich wäre, das für die Installation in einer Eclipse-Workbench geeignet ist.

Die Datei pluginconfig.xml enthält folgende Hauptsegmente:

 

Plug-in-Konfiguration

 

Im Folgenden wird die Hierarchie der Elemente dargestellt, die in der Datei pluginconfig.xml enthalten sind. Die Reihenfolge der auf einer Ebene angezeigten Elemente ist ohne Bedeutung. Hyperlinks in der Hierarchie verlinken zu einer formalen Elementbeschreibung im Abschnitt Elemente und Attribute.


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Anwendung
            Variable
            Parameter
        Agent
            Option

       

Elemente und Attribute

 

Element: PluginConfiguration
Das ist das Stammelement der Plug-in-Konfiguration. Nur eine Vorkommen von   'AgentControllerEnvironment' ist zulässig. Alle anderen Elemente (Option, Anwendung und Agent) können mehrmals vorkommen.   Alle Unterelemente können übersprungen werden.

Unterelemente:     AgentControllerEnvironment

                            Option
                            Anwendung
                            Agent
                           
Attribute:

requires
(Optional) Dieser Zeichenfolgewert ist eine durch Kommata getrennte Liste aus Plug-in-Namen, von der diese Konfiguration abhängt. Ab TPTP 4.0 wurde ein Kennungssuffix zu den Namen der Plug-ins hinzugefügt. Es beseht aus einem Unterstreichungszeichen, gefolgt von der Versionsnummer für das Release. Zum Beispiel: org.eclipse.tptp.platform.agentcontroller_4.0.0. Um Plug-in-Kompatibilität für Anwendungen zu gewährleisten, die Abhängigkeiten zu Plug-ins aus früheren Releases haben (Plug-ins ohne Versionskennungssuffix), haben Sie die Möglichkeit, den Plug-in-Namen für das Attribut "requires" ohne die Versionskennung anzugeben. In diesem Fall versucht das Konfigurationsladeprogramm von Agent Controller zunächst, den vollen Plug-in-Namen einschließlich Versionskennungssuffix zu lokalisieren. Ist dies nicht erfolgreich, so such das Konfigurationsladeprogramm nach dem Plug-in-Namen ohne Versionskennungssuffix. Gibt es mehr als ein Plug-in mit dem gleichen Namen, so wird der zuerst vom Betriebssystem zurückgegebene Plug-in-Name verwendet.

Element: AgentControllerEnvironment
Das Element 'AgentControllerEnvironment' umschließt mindestens ein Element des Typs 'Variable', das die globalen Umgebungsvariablen erweitert, die in der Datei 'serviceconfig.xml' definiert sind.  Diese werden Bestandteil der Umgebung, die beim Starten aller Anwendungen verwendet wird.


Verwendet von: PluginConfiguration

Unterelemente:     Variable

 

Element: Variable

Dieses Element 'Variable' definiert eine Umgebungsvariable und wie sie innerhalb dieser vorhandenen Umgebung positioniert sein sollte, um die neue Standardumgebung für alle gestarteten Anwendungen und Agenten zu bilden. Für 'AgentControllerEnvironment' können null oder mehrere dieser Elemente definiert werden.

Verwendet von: AgentControllerEnvironment

Attribute:

name
Dieser Zeichenfolgewert gibt den Namen der Umgebungsvariable an.
value
Dieser Zeichenfolgewert gibt den Wert der Umgebungsvariable an.
position
(Optional) Dieser Zeichenfolgewert lautet entweder "append", "prepend" oder "replace", und gibt an, an welchen Positionen sich diese Umgebung in Bezug zur vorhandenen Standardumgebung befindet.

Element: Option
Eine Option wird als wichtiges Element in 'PluginConfiguration' zum Angeben beliebiger Konfigurationsdaten verwendet, die an jeden Agenten übergeben werden, der sich selbst beim Agentencontroller registriert. Diese Informationen sind in die Eigenschafteninformationen eingeschlossen, die für jeden Agenten an einen Client zurückgegeben werden. Der Agent kann diese Informationen interpretieren (oder auch nicht), wenn sie passen. Informationen zur Option werden nur für Agenten angegeben, die die ursprüngliche API (abwärtsgerichtete Kompatibilitätsschichten) des Agentencontrollers verwenden. Verwenden Sie die Konfigurationsdatei agent.xml zum Angeben von Konfigurationsdaten für einen Agenten, der die neue API verwendet.

Verwendet von: Agent

Attribute:

name
Dieser Zeichenfolgewert gibt den Namensbereich für die Option an.
type
Dieser Zeichenfolgewert gibt den Namen für die Option an.
value
Diese Zeichenfolge gibt den Wert für die Option an.
Element: Anwendung
Das Element 'Anwendung' definiert oder erweitert einen Aliasnamen und Startinformationen für eine Anwendung. Es kann Umgebungseinstellungen enthalten, die nur für diese konkrete Anwendung sichtbar sind, wenn sie gestartet wird.  Dieser Anwendungsaliasname wird zu der Liste hinzugefügt, die im Element 'ApplicationAliases' in der Datei serviceconfig.xml definiert ist.


Verwendet von: PluginConfiguration

Unterelemente:     Variable

                            Parameter

Attribute:

executable
Dieser Zeichenfolgewert gibt den Aliasnamen für die ausführbare Datei der Anwendung an, die im Pfadattribut angegeben ist. Die Clients müssen diesen Namen zum Identifizieren dieser Anwendung verwenden.   Wenn auch das Attribut extends angegeben ist, muss der hier angegebene Name mit dem vorher definierten Aliasnamen identisch sein.  
path
Dieser Zeichenfolgewert gibt den vollständigen Pfadnamen der Anwendung an, die gestartet werden soll. Dieser Wert wird anstatt des Aliasnamens verwendet, wenn die ausführbare Datei der Anwendung gestartet wird.
Das Attribut wird ignoriert, wenn das Attribut extends angegeben ist.  
location
(Optional) Dieser Zeichenfolgewert gibt das Verzeichnis an, in dem die ausführbare Datei gestartet werden soll. Manchmal wird dieses Verzeichnis auch als Arbeitsverzeichnis für die ausführbare Datei bezeichnet, während sie ausgeführt wird.
extends
(Optional) Dieser Zeichenfolgewert gibt den Konfigurationsnamen für einen davor definierten Anwendungsaliasnamen an. Da die Konfigurationsnamen jedoch nicht unterstützt werden, muss für dieses Attribut der Wert "default" eingestellt werden. Wenn das Attribut extends vorhanden ist (unabhängig vom Wert), bedeutet dies, dass die in dieser Anwendung enthaltenen Informationen die Startinformationen erweitern müssen, die davor im entsprechenden Anwendungsaliasnamen definiert wurden. Es ist nicht zulässig, den Wert für path zu ändern (das heißt, die ausführbare Datei, die gerade gestartet wird). Wenn für den Namen der ausführbaren Datei keine Übereinstimmung gefunden wird, hat das Element 'Anwendung' keine Auswirkung.

Element: Variable
Dieses Element 'Variable' definiert eine Umgebungsvariable und wie sie innerhalb der vorhandenen Umgebung positioniert sein muss, wenn die Anwendung gestartet wird. Für eine Anwendung können null oder mehrere dieser Elemente definiert werden.

Verwendet von: Anwendung

Attribute:

name
Dieser Zeichenfolgewert gibt den Namen der Umgebungsvariable an.
value
Dieser Zeichenfolgewert gibt den Wert der Umgebungsvariable an.
position
(Optional) Dieser Zeichenfolgewert lautet entweder "append", "prepend" oder "replace", und gibt an, an welchen Positionen sich diese Umgebung in Bezug zur Standardumgebung befindet.

Element: Parameter

Das Element 'Parameter' definiert einen Befehlszeilenparameter, der beim Start an die Anwendung übergeben werden soll. Für eine Anwendung können null oder mehrere dieser Elemente definiert werden.

Verwendet von: Anwendung

Attribute:

value
Dieser Zeichenfolgewert gibt einen Befehlszeilenparameter an.
position
(Optional) Dieser Zeichenfolgewert lautet entweder "append", "prepend" oder "replace" und gibt an, wo dieses Argument in Bezug zu den vorhandenen Befehlszeilenparametern gespeichert werden soll.

Element: Agent
Stellt die Konfigurationsdaten für einen bestimmten Agenten bereit. Wird nur von Agenten verwendet, die die ursprüngliche  API (abwärtsgerichtete Kompatibilitätsschichten) des Agentencontrollers verwenden. Verwenden Sie die Konfigurationsdatei 'agent.xml' zum Angeben von Konfigurationsdaten für einen Agenten, der die neue API verwendet.

Verwendet von: PluginConfiguration

Unterelemente:     Option

Attribute:

name
Dieser Zeichenfolgewert gibt den Namen des Agenten an, auf den diese Konfigurationsdaten angewendet werden sollen.
type
(Optional) Dieser Zeichenfolgewert gibt einen Agententyp an.
dataChannelSize
(Optional) Dieser Zeichenfolgewert gibt die Menge des gemeinsam genutzten Speichers an, der für die Interprozesskommunikation zugeordnet werden soll. Die Werte besitzen das Format einer positiven ganzen Zahl mit dem Suffix M oder K, wobei M für Megabyte und K für Kilobyte steht; wenn kein Suffix angegeben ist, bedeutet dies, dass die Angabe in Byte erfolgt. Beispielwerte: "16M", "8K" oder "16000".
logFile
(Optional) Diese Zeichenfolge gibt einen vollständig qualifizierten Pfadnamen einer Datei an. Wenn eine Angabe gemacht wurde, werden die Daten, die normalerweise über den Datenkanal an den Client gesendet werden, stattdessen in diese Datei geschrieben.
client
(Optional) Diese Zeichenfolge gibt an, ob dieser Agent mit einem Client interagiert.   Gültige Werte sind "DYNAMIC" und "HEADLESS".    HEADLESS gibt an, dass kein Client zugeordnet ist.   Die Standardeinstellung ist DYNAMIC.
extends
(Optional) Dieser Zeichenfolgewert gibt den Konfigurationsnamen für einen davor definierten Agenten an. Da die Konfigurationsnamen jedoch nicht unterstützt werden, muss für dieses Attribut der Wert "default" eingestellt werden. Wenn das Attribut extends vorhanden ist (unabhängig vom Wert), bedeutet dies, dass die in diesem Agenten enthaltenen Informationen die Konfigurationsdaten erweitern müssen, die davor im entsprechenden Element 'Agent' definiert wurden. Sie werden zum Erweitern der Liste der Optionen verwendet, die einem bestimmten Agenten zugeordnet ist.

Element: Option
Das Unterelemente 'Option' im Element 'Agent'  wird zum Angeben der Konfigurationsdaten verwendet, die an den Agenten übergeben werden, wenn er sich selbst beim Agentencontroller registriert.   Der Agent kann diese Informationen interpretieren (oder auch nicht), wenn sie passen.

Verwendet von: Agent

Attribute:

name
Eine beliebige Zeichenfolge zur Benennung der Option (des Namensbereichs)
type
Eine beliebige Zeichenfolge zur Benennung des Optionstyps (des Optionsnamens)
value
Ein beliebiger Zeichenfolgewert für die Option

Beispieldatei 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>
 

Zugehörige Verweise

Übersicht über die Konfiguration des Agenten und von Agent Controller


Copyright (C) 2006 Intel Corporation.