Innehåll
Obs!
Vid referenser till fil- och katalogplatser i det här dokumenten är <install-home> den katalog där agentkontrollantpaketet zippades upp.
Filen pluginconfig.xml finns under <install-home>\plugins\<plugin-name>\config. Den utgör mekanismen för utökning av de globala miljö- och tillämpningsalias som definieras i serviceconfig.xml enligt behoven för enskilda tillämpningar. En utökning av de miljöinställningar som definieras i serviceconfig.xml påverkar alla tillämpningar (inklusive agenter) som startas av agentkontrollanten, eftersom de alla ärver den miljön. Därför kan att ett "insticksprogram" göra så att dess tillämpningar kan hittas av andra processer som startas av agentkontrollanten (t.ex. genom att lägga till sin sökväg i miljövariabeln CLASSPATH). Att utöka listan över tillämpningsalias är ett sätt för en ny tillämpning att startas, om agentkontrollanten är konfigurerad att begränsa sina starttjänster till tillämpningarna i listan.
På så sätt tillhandahåller pluginconfig.xml en mekanism för paketering av tilläggskomponenter som är valfria vid basinstallationen av agentkontrollanten. Eftersom filen serviceconfig.xml inte själv är ändrad är det lika lätt att ta bort tilläggskomponenterna.
Agenter kan kräva både en pluginconfig.xml och en agent.xml. Filen agent.xml krävs för att definiera en agenttillämpning om du vill att den nya agentkontrollanten ska kunna upptäcka den när den söker efter tillgängliga agenter. Filen pluginconfig.xml krävs om agenten behöver utöka miljön eller aliaslistan för serviceconfig.xml. Användningen av filen agent.xml kommer att ersätta användningen av pluginconfig.xml i en framtida version.
Obs!
Termen "insticksprogram" är här bara en lös referens till ett Eclipse-insticksprogram. Den började användas eftersom faktiska insticksprogram användes från början. Men nu är det en felbenämning, eftersom den här konfigurationsfilen kan referera till vilken tillämpning som helst utan att den paketerats som ett insticksprogram som lämpar sig för installation i Eclipse-arbetsmiljön.
Filen pluginconfig.xml innehåller följande huvudsegment:
Hierarkin för de element som finns i filen pluginconfig.xml visas nedan. Ordningen på de element som visas på samma nivå är oväsentlig. Länkar i hierarkilänken till den formella elementbeskrivningen i avsnittet Element och attribut.
PluginConfiguration
AgentControllerEnvironment
Variable
Option
Application
Variable
Parameter
Agent
Option
Element: PluginConfiguration
Underelement: AgentControllerEnvironment
Option
Application
Agent
- requires
- (valfritt) Det här strängvärdet är en kommaavgränsad lista över namn på insticksprogram som den här konfigurationen är beroende av. Fr.o.m. TPTP 4.0 har ett suffix som anger versions-ID lagts till namnet för insticksprogrammet. Det består av ett understreck följt av versionsnumret för utgåvan. Exempel: org.eclipse.tptp.platform.agentcontroller_4.0.0. För att säkra kompatibilitet med insticksprogrammet för tillämpningar som har beroenden på insticksprogram från tidigare utgåvor (insticksprogram som inte har suffix som anger versions-ID) kan du välja att ange namnet för insticksprogrammet för attributet "requires" undantaget versions-IDt. I det fallet försöker agentkontrollantens konfigurationsinläsningsfunktion först att hitta det fullständiga namnet för insticksprogrammet inkluderat suffixet för versions-ID. Om det inte går söker konfigurationsinläsningsfunktionen efter namnet för insticksprogrammet utan suffixet för versions- ID. Om det finns fler än ett insticksprogram med samma namn används det första namnet för insticksprogram som returneras av operativsystemet.
Används av: PluginConfiguration
Underelement: Variable
Det här Variable-elementet definierar en miljövariabel och hur den ska placeras inom den befintliga miljön för att en ny standardmiljö ska bildas för alla tillämpningar och agenter som startats. Det kan finnas noll eller flera av de här elementen definierade för AgentControllerEnvironment
Används av: AgentControllerEnvironment
Attribut:
- name
- Det här strängvärdet anger namnet på miljövariabeln.
- value
- Det här strängvärdet anger värdet för miljövariabeln.
- position
- (valfritt) Det här strängvärdet är något av alternativen "append", "prepend" och "replace", och anger var miljön ska placeras i relation till den befintliga standardmiljön.
Element: Option
Option, som är ett toppnivåelement i
PluginConfiguration, används för att ange slumpmässiga konfigurationsdata som kommer att skickas till
alla agenter som registrerar sig i agentkontrollanten. Den här
informationen inkluderas i den egenskapsinformation som returneras för varje agent, till en klient. Agenten kan välja att tolka informationen om så anses lämpligt (eller att inte tolka den).
Option-information ges endast till agenter som använder det ursprungliga APIt
(lager för bakåtkompatibilitet) för agentkontrollanten. Använd konfigurationsfilen agent.xml
för att tillhandahålla konfigurationsinformation till en agent som använder det nya APIt.
Element: ApplicationAnvänds av: Agent
Attribut:
- name
- Det här strängvärdet anger namnområdet för alternativet.
- type
- Det här strängvärdet anger namnet på alternativet.
- value
- Den här strängen anger värdet för alternativet.
Används av: PluginConfiguration
Underelement: Variable
- executable
- Det här strängvärdet anger aliasnamnet för den körbara fil för tillämpningen som anges i sökvägsattributet. Klienter måste använda det namnet för att identifiera tillämpningen Om attributet extends också anges ska det namn som anges här matcha ett tidigare definierat alias.
- path
- Det här strängvärdet anger fullständigt sökvägsnamn för den tillämpning som ska startas. Det används istället för aliasnamnet när du startar den körbara filen för tillämpningen.
Attributet ignoreras om attributet extends anges.- location
- (valfritt) Det här strängvärdet anger den katalog som den körbara filen ska startas från, även kallad arbetskatalogen för den körbara filen när den körs.
- extends
- (valfritt) Det här strängvärdet anger konfigurationsnamnet för ett tidigare definierat tillämpningsalias. Konfigurationsnamn kan emellertid inte användas, så värdet för det här attributet ska anges som "default". Om extends finns (oavsett värde), anger det att den information som finns i tillämpningen ska utöka den startinformation som tidigare definierats i matchande tillämpningsalias. Det är inte tillåtet att ändra värdet path (t.ex. körbar fil som startas). Om ingen matchning hittas för namnet på den körbara filen har det här Application-elementet ingen verkan.
Element: Variable
Det här Variable-elementet definierar en miljövariabel och hur den ska placeras inom den befintliga miljön när tillämpningen startas. Det kan finnas noll eller flera av de här elementen definierade för Application
Används av: Application
Attribut:
- name
- Det här strängvärdet anger namnet på miljövariabeln.
- value
- Det här strängvärdet anger värdet för miljövariabeln.
- position
- (valfritt) Det här strängvärdet är något av alternativen "append", "prepend" och "replace", och anger var miljön ska placeras i relation till standardmiljön.
Elementet Parameter definierar ett kommandoradsargument som ges till tillämpningen när den startas. Det kan finnas noll eller flera av de här elementen definierade för Application
Används av: Application
Attribut:
- value
- Det här strängvärdet anger ett kommandoradsargument.
- position
- (valfritt) Det här strängvärdet är något av alternativen "append", "prepend" och "replace", och anger var argumentet ska placeras i relation till de befintliga kommandoradsargumenten.
Element: Agent
Tillhandahåller konfigurationsinformation för en viss agent. Används endast av agenter som använder det ursprungliga
APIt (lager för bakåtkompatibilitet) för agentkontrollanten. Använd konfigurationsfilen agent.xml
för att tillhandahålla konfigurationsinformation till en agent som använder det nya APIt.
Används av: PluginConfiguration
Underelement: Option
Attribut:
- name
- Det här strängvärdet anger namnet på den agent som konfigurationsinformationen ska tillämpas på.
- type
- (valfritt) Det här strängvärdet anger en typ av agent.
- dataChannelSize
- (valfritt) Det här strängvärdet anger den mängd delat minne som ska allokeras för kommunikation mellan processer. Värdena har formen av ett positivt heltal med suffixet M eller K för att ange megabyte respektive kilobyte, eller utan suffix, vilket anger byte. Exempelvärden: "16M", "8K" och "16000".
- logFile
- (valfritt) Det här strängvärdet anger ett fullständigt sökvägsnamn för en fil. Om det anges skrivs de data som normalt skulle gå genom datakanalen till klienten till den här filen istället.
- client
- (valfritt) Den här strängen anger om den här agenten interagerar med en klient. Möjliga värden är "DYNAMIC" och "HEADLESS". HEADLESS anger att det inte finns någon associerad klient. Standardvärdet är DYNAMIC.
- extends
- (valfritt) Det här strängvärdet anger konfigurationsnamnet för en tidigare definierad agent. Konfigurationsnamn kan emellertid inte användas, så värdet för det här attributet ska anges som "default". Om extends finns (oavsett värde), anger det att den information som finns i den här agenten ska utöka den konfigurationsinformation som tidigare definierats i matchande Agent-element. Används för att expandera listan med alternativ som associeras med en viss agent.
Element: Option
Ett Option-underelement inom ett Agent-element
används för att ange slumpmässiga konfigurationsdata som kommer att skickas till
agenten när den registrerar sig i agentkontrollanten. Agenten kan välja att tolka informationen om så anses lämpligt (eller att inte tolka den).
Används av: Agent
Attribut:
- name
- en slumpmässig sträng som namnger alternativet (dvs. namnområde)
- type
- en slumpmässig sträng som namnger typen för alternativet (dvs. alternativnamn)
- value
- ett slumpmässigt strängvärde för alternativet
<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>
Närliggande referens
Översikt över konfiguration för agent och agentkontrollant
Copyright (C) 2006 Intel Corporation.