Indhold
Bemærk
Når der henvises til fil- og biblioteksplaceringer i dette dokument, er <installationsbibliotek> det bibliotek, hvor Agent Controller-pakken blev pakket ud.
Filen pluginconfig.xml er placeret under <installationsbibliotek>\plugins\<navn-på-plugin>\config. Den fungerer som mekanisme til udvidelse af de globale miljø- og programaliaser, der er defineret i serviceconfig.xml alt efter hver enkelt programbundts behov. Udvidelsen af de miljøindstillinger, der er defineret i serviceconfig.xml, har indflydelse på alle programmer (inklusive agenter), som startes af Agent Controller, da de alle overtager det pågældende miljø. Det gør det muligt for en "plugin" at gøre sine programmers placering kendte over for andre processer, der startes af Agent Controller (f.eks. ved automatisk tilføjelse af den pågældende plugins stiplacering til systemindstillingen CLASSPATH). At udvide listen med programaliaser er en praktisk metode til at få startet et nyt program, hvis Agent Controller er konfigureret til at kun at starte de serviceprogrammer, som findes på listen.
Filen pluginconfig.xml gør det derfor muligt at pakke ekstra komponenter og tilføje dem til den grundlæggende installation af Agent Controller. Da filen serviceconfig.xml i sig selv ikke ændres, er fjernelsen af ekstrakomponenterne lige så let.
Der kan være behov for både en pluginconfig.xml og en agent.xml til agenter. Filen agent.xml er nødvendig for at definere et agentprogram, hvis du vil have den nye agent controller til at søge efter tilgængelige agenter. Filen pluginconfig.xml er nødvendig, hvis agenten skal udvide miljøet serviceconfig.xml eller aliaslisten. Brugen af filen agent.xml vil i en fremtidig release komme til at erstatte brugen af pluginconfig.xml.
Bemærk
Termen "plugin" er her anvendt som en bred henvisning til en Eclipse-plugin. Denne anvendelse skyldes, at der oprindeligt blev brugt egentlige plugins. Nu om stunder er anvendelsen af termen imidlertid noget misvisende, da denne konfigurationsfil kan henvise til et program, helt uden at det er nødvendigt at pakke programmet ind som et plugin, før det kan installeres i Eclipse-arbejdsbænken.
Filen pluginconfig.xml indeholder følgende hovedsegmenter:
Hierarkiet for de elementer, der er indeholdt i filen pluginconfig.xml, er vist nedenfor. Den viste rækkefølge for elementer på samme niveau er uden betydning. Hyperlink i hierarkiet linker til den formelle elementbeskrivelse i afsnittet Elementer og attributter.
PluginConfiguration
AgentControllerEnvironment
Variable
Option
Application
Variable
Parameter
Agent
Option
Element: PluginConfiguration
Underelementer: AgentControllerEnvironment
Option
Application
Agent
- requires
- Valgfrit. Denne strengværdi er en kommasepareret liste over plugin-navne, som konfigurationen er afhængig af. Fra og med TPTP 4.0 er der tilføjet en versions-id efter plugin-navnene. Den består af et understregningstegn, efterfulgt af versionsnummeret for den pågældende release. Eksempel: org.eclipse.tptp.platform.agentcontroller_4.0.0. For at sikre plugin-kompatibilitet for programmer, der har afhængigheder på plugins fra tidligere releases (plugins, der ikke har en efterstillet versions-id), har du mulighed for at angive plugin-navnet for attributten "requires", uden versions-id. I så fald forsøger funktionen til indlæsning af konfigurationen i Agent Controller først at finde det fulde plugin-navn, inklusive versions-id. Hvis det ikke lykkes, søger funktionen efter plugin-navnet uden versions-id. Hvis der er flere plugins med samme navn, anvendes det første plugin-navn, som styresystemet returnerer.
Bruges af: PluginConfiguration
Underelementer: Variable
Elementet Variable definerer en miljøvariabel og hvordan denne skal placeres i det eksisterende miljø for at danne det nye standardmiljø for alle de programmer og agenter, der startes. Der kan være flere (eller ingen) af disse elementer defineret for AgentControllerEnvironment.
Bruges af: AgentControllerEnvironment
Attributter:
- name
- Denne strengværdi angiver navnet på miljøvariablen.
- value
- Denne strengværdi angiver værdien for miljøvariablen.
- position
- Valgfrit. Denne strengværdi kan enten være "append", "prepend" eller "replace", og angiver, hvor miljøet skal placeres i forhold til det eksisterende standardmiljø.
Element: Option
Hvis Option-elementet bruges på øverste
niveau i PluginConfiguration, angiver det vilkårlige konfigurationsoplysninger, der skal
overføres til alle agenter, der registrerer sig over for Agent Controller. Disse
oplysninger inkluderes i de egenskabsoplysninger, der returneres for hver agent til
en klient. Agenten kan fortolke oplysningerne (eller undlade at gøre det) efter behov.
Oplysninger om indstilling opgives kun til agenter, der bruger det oprindelige API
(kompatibilitet bagud) for Agent Controller. Brug konfigurationsfilen agent.xml
til at videregive konfigurationsoplysninger til en agent vha. det
nye API.
Element: ApplicationBruges af: Agent
Attributter:
- name
- Denne strengværdi giver navneområdet for indstillingen.
- type
- Denne strengværdi giver navnet på indstillingen.
- value
- Denne strengværdi giver værdien for indstillingen.
Bruges af: PluginConfiguration
Underelementer: Variable
- executable
- Denne strengværdi angiver aliasnavnet for programmets eksekvérbare fil, der er angivet i stiattributten. Klienterne skal bruge dette navn til at identificere programmet. Hvis attributten extends også er angivet , skal det navn, som angives her, matche et tidligere defineret alias.
- path
- Denne strengværdi angiver den fuldstændige stiplacering for det program, der skal startes. Denne bruges i stedet for aliaset, når programmets eksekvérbare program skal startes.
Attributten ignoreres, hvis attributten extends er angivet.- location
- Valgfrit. Denne strengværdi angiver biblioteket, hvorfra den eksekvérbare fil skal startes. Ved kørslen kaldes biblioteket sommetider for den eksekvérbare fils arbejdsbibliotek.
- extends
- Valgfrit. Denne strengværdi angiver konfigurationsnavnet for et tidligere defineret programalias. Da konfigurationsnavne imidlertid ikke er understøttet, skal attributten sættes til "default". Hvis extends er angivet (uanset værdi), angiver det, at oplysningerne indeholdt i Application-elementet skal udvide de startoplysninger, der tidligere er defineret i det matchende programalias. Det er ikke tilladt at ændre path-værdien, dvs. den eksekvérbare fil, som startes. Hvis der ikke findes en navnematch for den eksekvérbare fil, har Application-elementet ingen effekt.
Element: Variable
Elementet Variable definerer en miljøvariabel og hvordan denne skal
placeres i det eksisterende miljø, når programmet skal startes. Der kan være flere (eller ingen) af disse
elementer defineret for et Application-element.
Bruges af: Application
Attributter:
- name
- Denne strengværdi angiver navnet på miljøvariablen.
- value
- Denne strengværdi angiver værdien for miljøvariablen.
- position
- Valgfrit. Denne strengværdi kan enten være "append", "prepend" eller "replace", og angiver, hvor miljøet skal placeres i forhold til standardmiljøet.
Elementet Parameter definerer et kommandolinjeargument, der skal overføres til programmet, når dette startes. Der kan være flere (eller ingen) af disse elementer defineret for et Application-element.
Bruges af: Application
Attributter:
- value
- Denne strengværdi angiver et kommandolinjeargument.
- position
- Valgfrit. Denne strengværdi kan enten være "append", "prepend" eller "replace" og angiver, hvor argumentet skal placeres i forhold til de eksisterende kommandolinjeargumenter.
Element: Agent
Giver konfigurationsoplysninger
for en bestemt agent. Elementet bruges kun af agenter, der anvender det
oprindelig API (kompatibilitet bagud) for Agent Controller. Brug konfigurationsfilen agent.xml
til at videregive konfigurationsoplysninger til en agent vha. det
nye API.
Bruges af: PluginConfiguration
Underelementer: Option
Attributter:
- name
- Denne strengværdi angiver navnet på den agent, som konfigurationsoplysningerne skal bruges på.
- type
- Valgfrit. Denne strengværdi giver agenttypen.
- dataChannelSize
- Valgfrit. Strengværdien angiver mængden af fælles hukommelse, der skal tildelestil kommunikation mellem interne processer. Værdierne skal angives i form af et positivt heltal med suffikset M eller K for at angive henholdsvis megabyte eller kilobyte, eller intet suffiks for at angive bytes. Eksempel: "16M", "8K" eller "16000".
- logFile
- Valgfrit. Strengværdien angiver det kvalificerede stinavn for en fil. Hvis attributten angives, vil de data, der normalt sendes via datakanalen til klienten, i stedet blive skrevet til filen.
- client
- Valgfrit. Denne streng angiver, om agenten kan kommunikere med en klient. De mulige værdier er "DYNAMIC" eller "HEADLESS". HEADLESS angiver, at der ikke er nogen klient tilknyttet. Standardværdien er DYNAMIC.
- extends
- Valgfrit. Denne strengværdi angiver konfigurationsnavnet for et tidligere defineret Agent-element. Da konfigurationsnavne imidlertid ikke er understøttet, skal attributten sættes til "default". Hvis extends er angivet (uanset værdi), angiver det, at oplysningerne indeholdt i Agent-elementet skal udvide de konfigurationsoplysninger, der tidligere er defineret i det matchende Agent-element. Det bruges for at udvide listen med Options, der er knyttet til en bestemt agent.
Element: Option
Et Option-underelement
placeret i et Agent-element bruges til at angive vilkårlige
konfigurationsoplysninger, der skal overføres til agenten, når denne registrerer sig over for
Agent Controller. Agenten kan fortolke oplysningerne (eller undlade at gøre det) efter behov.
Bruges af: Agent
Attributter:
- name
- En vilkårlig streng, der navngiver indstillingen (dvs. navneområdet)
- type
- En vilkårlig streng, der navngiver indstillingens type (f.eks. et indstillingsnavn)
- value
- En vilkårlig strengværdi for indstillingen.
<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>
Relateret reference
Oversigt over agent- og Agent Controller-konfiguration
Copyright (C) 2006 Intel Corporation.