Filen pluginconfig.xml

Innhold

 

Merk

Når du refererer til plasseringen av filer eller kataloger i dette dokumentet, er <install-home> katalogen der agentkontrollerpakken ble pakket opp.

Innledning

Filen pluginconfig.xml ligger under <install-home>\plugins\<plugin-name>\config.  Det globale miljøet og applikasjonsaliaser som er definert i serviceconfig.xml, utvides i henhold til behovene applikasjonene som er pakket separat.  Når miljøinnstillingene som er definert i serviceconfig.xml utvides, påvirkes alle applikasjoner (også agenter) som startes av agentkontrolleren, ettersom de alle arver miljøet.  Dette gjør det mulig for en "plugin" å angi at det skal være mulig for andre prosesser som er startet av agentkontrolleren, å finne applikasjonene (f.eks. ved å legge banen til i miljøvariabelen CLASSPATH). Når applikasjonens aliasliste utvides, kan en ny applikasjon startes hvis agentkontrolleren er konfigurert slik at oppstartstjenestene begrenses til de som står på listen.

Filen pluginconfig.xml kan brukes til å pakke tilleggskomponenter som er valgfrie for grunnleggende installering av agentkontrolleren.  Ettersom det ikke foretas endringer i selve serviceconfig.xml-filen, er det enkelt å fjerne tilleggskomponentene.  

Agenter kan kreve både en pluginconfig.xml-fil og en agent.xml-fil. Filen agent.xml kreves for å definere en agentapplikasjon hvis du vil at den nye agentkontrolleren skal kunne gjøre dette når det søkes etter tilgjengelige agenter.   Filen pluginconfig.xml kreves hvis agenten skal utvide aliaslisten eller miljøet for serviceconfig.xml. Bruken av filen agent.xml vil erstatte bruk av pluginconfig.xml i en fremtidig utgave.

Merk

Betegnelsen "plugin" slik den brukes her, er bare en løs referanse til en Eclipse-plugin.  Betegnelsen oppstod fordi det i utgangspunktet ble brukt reelle plugin-moduler.   Nå er imidlertid betegnelsen misvisende siden denne konfigurasjonsfilen kan referere til enhver applikasjon uten at det betyr at det er en plugin-modul som nødvendigvis er egnet for installering i Eclipse-arbeidsbenken.

Filen pluginconfig.xml inneholder følgende hovedsegmenter:

 

Plugin-konfigurasjon

 

Hierarkiet av elementene i filen pluginconfig.xml vises nedenfor. Rekkefølgen til elementer som vises på samme nivå, har ingen betydning. Hyperlinker i hierarkilinken til den formelle elementbeskrivelsen i delen Elementer og attributter.


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Application
            Variable
            Parameter
        Agent
            Option

       

Elementer og attributter

 

Element: PluginConfiguration
Dette er rotelementet til plugin-konfigurasjonen. Det er bare tillatt med én forekomst av   AgentControllerEnvironment. Alle øvrige elementer (Option, Application, og Agent) tillater flere forekomster.  Alle underelementer kan utelates.

Underelementer:     AgentControllerEnvironment

                            Option
                            Application
                            Agent
                           
Attributter:

requires
(valgfritt) Denne strengverdien er en liste over plugin-navn med komma som skilletegn, og som denne konfigurasjonen er avhengig av. Fra og med TPTP 4.0 er det lagt til et suffiks for versjons-ID i plugin-navn. Det består av et understrekingstegn etterfulgt av versjonsnummeret for utgaven. For eksempel org.eclipse.tptp.platform.agentcontroller_4.0.0. For å sikre plugin-kompatibilitet for applikasjoner med avhengigheter i plugin-moduler fra tidligere utgaver (plugin-moduler som ikke har en versjons-ID-suffiks), kan du oppgi plugin-navnet for attributtet "requires" uten versjons-IDen. I dette tilfellet vil innlastingsprogrammet for agentkontrollerens konfigurasjon først forsøke å finne det fullstendige plugin-navnet med versjons-ID-suffikset. Hvis det ikke lykkes, søker innlastingsprogrammet etter plugin-navnet uten versjons-ID-suffikset. Hvis det er flere plugin-moduler med samme navn, brukes det første plugin-navnet som blir returnert av operativsystemet.

Element: AgentControllerEnvironment
Elementet AgentControllerEnvironment omslutter en eller flere variabelelementer som utvider de globale miljøvariablene som er definert i serviceconfig.xml.  Dette blir en del av miljøet som brukes ved oppstart av alle applikasjoner.


Brukes av: PluginConfiguration

Underelementer:     Variable

 

Element: Variable

Dette Variable-elementet definerer en miljøvariabel og hvordan den skal plasseres i det eksisterende miljøet for å danne det nye standardmiljøet for alle applikasjoner og agenter som startes. Det kan være null eller flere av disse elementene definert for AgentControllerEnvironment.

Brukes av: AgentControllerEnvironment

Attributter:

name
Denne strengverdien angir navnet på miljøvariabelen.
value
Denne strengverdien angir verdien for miljøvariabelen.
position
(valgfritt) Denne strengverdien kan være "append", "prepend" eller "replace" og angir hvor dette miljøet skal plasseres i forhold til det eksisterende standardmiljøet.

Element: Option
Option som et toppelement i PluginConfiguration brukes til å angi vilkårlige konfigurasjonsdata som skal overføres til hver agent som registrerer seg selv hos agentkontrolleren. Denne informasjonen inkluderes i egenskapsinformasjonen som returneres for hver agent, til en klient. Agenten kan tolke denne informasjonen (eller ikke) hvis det er behov for det. Option-informasjon er bare tilgjengelig for agenter som bruker opprinnelig API (bakoverkompatibilitetslag) for agentkontrolleren. Bruk konfigurasjonsfilen agent.xml til å oppgi konfigurasjonsinformasjon til en agent ved hjelp av den nye APIen.

Brukes av: Agent

Attributter:

name
Denne strengverdien angir navneområdet for alternativet.
type
Denne strengverdien angir navnet på alternativet.
value
Denne strengen angir verdien for alternativet.
Element: Application
Application-elementet definerer et aliasnavn eller utvider et aliasnavn og starter informasjon for en applikasjon. Det kan inkludere miljøinnstillinger som bare er synlige når denne bestemte applikasjonen startes.  Applikasjonsaliaset legges til på listen som er definert i ApplicationAliases-elementet i serviceconfig.xml.


Brukes av: PluginConfiguration

Underelementer:     Variable

                            Parameter

Attributter:

executable
Denne strengverdien angir aliasnavnet for applikasjonens utførbare fil som er angitt i baneattributtet. Klienter må bruke dette navnet til å identifisere denne applikasjonen.  Hvis attributtet extends også er angitt, samsvarer navnet som oppgis her med et tidligere definert alias. 
path
Denne strengverdien angir det fullstendige banenavnet til applikasjonen som skal startes. Den brukes i stedet for aliasnavnet når den utførbare filen for applikasjonen startes.
Attributtet ignoreres hvis attributtet extends er angitt. 
location
(valgfritt) Denne strengverdien angir katalogen som den utførbare filen skal startes fra. Den refereres noen ganger til som arbeidskatalogen for den utførbare filen mens den kjører.
extends
(valgfritt) Denne strengverdien angir konfigurasjonsnavnet for et applikasjonsalias som er definert tidligere. Konfigurasjonsnavn støttes ikke. Verdien av dette attributtet må derfor settes til "default". Hvis extends finnes (uavhengig av verdi), angir dette at informasjonen i denne applikasjonen skal inkludere oppstartsinformasjonen som er definert tidligere i det samsvarende applikasjonsaliaset. Det er ikke tillatt å endre verdien for path (den kjørbare filen som startes). Hvis det ikke blir funnet samsvar med navnet på den kjørbare filen, har applikasjonselementet ingen virkning.

Element: Variable
Dette Variable-elementet definerer en miljøvariabel og hvordan den skal plasseres i det eksisterende miljøet når applikasjonen startes. Det kan være null eller flere av disse elementene definert for Application.

Brukes av: Application

Attributter:

name
Denne strengverdien angir navnet på miljøvariabelen.
value
Denne strengverdien angir verdien for miljøvariabelen.
position
(valgfritt) Denne strengverdien kan være "append", "prepend" eller "replace" og angir hvor dette miljøet skal plasseres i forhold til standardmiljøet.

Element: Parameter

Parameter-elementet definerer et kommandolinjeargument som skal gis til applikasjonen når den startes. Det kan være null eller flere av disse elementene definert for Application.

Brukes av: Application

Attributter:

value
Denne strengverdien angir et kommandolinjeargument.
position
(valgfritt) Denne strengverdien kan være "append", "prepend" eller "replace" og angir hvor dette argumentet skal plasseres i forhold til eksisterende kommandolinjeargumenter.

Element: Agent
Oppgir konfigurasjonsinformasjon for en bestemt agent. Brukes bare av agenter som bruker opprinnelig   API (bakoverkompatibilitetslag) for agentkontrolleren. Bruk konfigurasjonsfilen agent.xml til å oppgi konfigurasjonsinformasjon til en agent ved hjelp av den nye APIen.

Brukes av: PluginConfiguration

Underelementer:     Option

Attributter:

name
Denne strengverdien angir navnet på agenten som konfigurasjonsinformasjonen skal brukes på.
type
(valgfritt) Denne strengverdien angir typen agent.
dataChannelSize
(valgfritt) Denne strengverdien angir hvor mye delt minne som skal tildeles for kommunikasjon mellom prosessene. Hvis verdien har et positivt heltall med suffikset M eller K, angir dette henholdsvis Megabyte eller Kilobyte, og uten suffiks angir byte. Eksempelverdier: "16M", "8K" eller "16000".
logFile
(valgfritt) Denne strengen angir et fullstendig kvalifisert banenavn for en fil. Hvis denne strengen er angitt, vil dataene som vanligvis går gjennom datakanalen til klienten, bli skrevet til denne filen i stedet.
client
(valgfritt) Denne strengen angir om det er interaksjon mellom agenten og en klient.  Mulige verdier er "DYNAMIC" eller "HEADLESS".   HEADLESS angir at det ikke er tilknyttet noen klient.   Standard er DYNAMIC.
extends
(valgfritt) Denne strengverdien angir konfigurasjonsnavnet for en agent som er definert tidligere. Konfigurasjonsnavn støttes ikke. Verdien av dette attributtet må derfor settes til "default". Hvis extends finnes (uavhengig av verdi), angir dette at informasjonen i denne agenten skal inkludere konfigurasjonsinformasjonen som er definert tidligere i det samsvarende agentelementet. Brukes for å utvide listen over Options som er tilknyttet en bestemt agent.

Element: Option
Option som et underelement i et Agent-element  brukes til å angi vilkårlige konfigurasjonsdata som skal overføres til agenten når den registrerer seg selv hos agentkontrolleren.  Agenten kan tolke denne informasjonen (eller ikke) hvis det er behov for det.

Brukes av: Agent

Attributter:

name
en vilkårlig streng som navngir alternativet (for eksempel navneområde)
type
en vilkårlig streng som navngir typen alternativ (for eksempel navn på alternativ)
value
en vilkårlig strengverdi for alternativet

Eksempel på filen 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>
 

Beslektet referanse

Konfigurasjonsoversikt for agent og agentkontroller


Copyright (C) 2006 Intel Corporation.