Filen agent.xml

Obs!

Vid referenser till fil- och katalogplatser i det här dokumenten är <install-home> den katalog där agentkontrollantpaketet zippades upp.

Introduktion

Startkonfigurationsfilen för en agent (agent.xml) innehåller statisk information som agentkontrollanten måste ha tillgång till för att starta och hantera en agent. Den statiska informationen inbegriper bland annat följande:

Filen agent.xml måste vara placerad i en katalog som är namngiven efter agenten.   Katalogen med agentnamnet måste finnas i den katalog som anges av Agent-elementet i filen serviceconfig.xml.Till exempel skulle konfigurationsfilen för en agent med namnet org.eclipse.tptp.TimeCollector finnas i <install-home>/agents/org.eclipse.tptp.TimeCollector/agent.xml. Agentkontrollanten använder katalognamnet till att identifiera agenter som begärs med namn.   Informationen i konfigurationsfilen agent.xml är metadata för den agenten.

Observera att agentkontrollanten läser agent.xml-filer för alla agenter endast en gång, vid start.   Om du ändrar innehållet i filerna eller lägger till nya agentkataloger måste du därför stara om agentkontrollanten för att ändringarna ska börja gälla.

Element och attribut

Element: Agent
Det här är rotelementet för agentkonfigurationsfilen. I den definieras metadata för en agent. Ett objekt kan begära metadata för en agent och sedan använda informationen enligt behov. Underelementen i listan nedan används av agentkontrollanten för start och hantering av agenten.  Fler underelement kan definieras av agentutvecklare för retur av mer information som metadata.  Metadata är användbart för en klient som ska fatta beslut under körning om vilken agent som ska användas för en viss uppgift.

Underelement:     Interface
                            SingleInstance
                            Bound
                            MaxControllers
                            MaxObservers
                            ConfigFile
                            LaunchConfiguration

Attribut:

Name
Det här strängvärdet är det unika namnet för agenten. Det här värdet förväntas vara detsamma som det namn som används av agenten när den registreras för agentkontrollanten.  Om värdena inte är desamma ger begäran om en agent olika resultat beroende på om agenten redan körs.

Element:Interface
Strängvärdet för det här elementet är namnet på ett gränssnitt som kan användas med den här agenten. Det kan finnas noll eller flera gränssnittselement i ett agentelement.   Ett gränssnitt är ett unikt namn för en uppsättning kommandon som kan användas med en agent.

Används av:       Agent

Element:SingleInstance
Heltalsvärdet för det här elementet är antingen 0 eller 1.  0 (false) anger att det kan finnas flera förekomster av agenten samtidigt. 1 (true) anger att endast en förekomst av agenten tillåts.   Om värdet 1 anges nekar agentkontrollanten begäran om nya förekomster av agenten om det redan finns en aktiv förekomst.

Används av:       Agent

Element: Bound
Heltalsvärdet för det här elementet är antingen 0 eller 1.  0 (false) anger att agenten inte är bunden till en tillämpning. 1 (true) anger att agenten är bunden till en tillämpning.   En agent som är bunden till en tillämpning kan endast startas av den tillämpningen. Därför startar agentkontrollanten inte en agent om värdet för Bound är 1.

Används av:       Agent

Element: MaxControllers
Heltalsvärdet för det här elementet är -1, 0 eller ett positivt värde. -1 anger "ingen gräns". Agentkontrollanten avvisar begäran för kontrollbehörighet till den här agenten om antalet begäran överskrider det här värdet.   Behörigheterna för en kontrollant definieras av agentutvecklaren. Den förväntade användningen är att begränsa det antal objekt som kan begära åtgärder som står i konflikt med varandra, till exempel att starta och avbryta insamling av data.

Används av:       Agent

Element: MaxObservers
Heltalsvärdet för det här elementet är -1, 0 eller ett positivt värde. -1 anger "ingen gräns". Agentkontrollanten avvisar begäran för observationsbehörighet till den här agenten om antalet begäran överskrider det här värdet.   Behörigheterna för en observatör definieras av agentutvecklaren. Den förväntade användningen är att begränsa det antal objekt som kan begära åtgärder av frågetyp, till exempel tillhandahålla data som är statiska eller samlas in (till exempel på begäran av en kontrollant).

Används av:       Agent

Element: ConfigFile
Strängvärdet för det här elementet anger den fullständiga sökvägen och filnamnet för en extra konfigurationsfil som innehåller dynamisk konfigurationsinformation som är tillgänglig för agenten.  Det här är en valfri fil vars ändamål och innehåll definieras av agentutvecklaren. Den förväntade användningen är att agenten läser sin egen konfigurationsinformation från den här filen antingen vid start eller vid ett annat tillfälle.

Används av:       Agent

Element: LaunchConfiguration
Identifierar startkonfigurationsparametrar för den här agenten.

Används av:       Agent
                   
Underelement:     launchInfo
 

Element: launchInfo
Kapslar in information som används för start av en körbar fil.

Används av:       LaunchConfiguration

Underelement:     Application

Element: Application
Elementet Application definierar den information som används för start av en tillämpning.  Det körbara attributvärdet kan ange en tillämpning med dess aliasnamn (se elementet ApplicationAliases i serviceconfig.xml) eller pathname för den körbara filen som ska startas.   Värdet matchas först mot listan med alias som erhålls från serviceconfig.xml när agentkontrollanten startas.  Om ingen matchning hittas används startinformationen som ingår i elementet Application som det är.  Om en matchning hittas används startinformationen som definierats för det aliaset tillsammans med den information som definierats här, enligt beskrivningen nedan.

Används av:       LaunchConfiguration
                   
Underelement:     Variable
                            Parameter                          

Attribut:

executable

Det här strängvärdet anger namnet på den tillämpning som ska startas. Det kan antingen vara ett aliasnamn eller ett pathname för den körbara fil som ska startas.   Om det är ett aliasnamn ersätts namnet på den körbara filen med det sökvägsvärde som angetts i aliaset.

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. Om det utelämnas och den körbara filen inte matchar ett alias körs tillämpningen från den katalog där agentkontrollanten finns.   Om det utelämnas och den körbara filen matchar ett alias används den plats som angetts för aliaset.

Element: Variable
Det här Variable-elementet definierar en miljövariabel och hur den ska placeras i den befintliga miljön.   När det placeras i ett Application-element justerar det den miljö som används när tillämpningen startas.   Det kan finnas noll eller flera av de här elementen definierade för en tillämpning. Om det körbara attributet för en tillämpning anger ett alias tillämpas miljövariabelinställningarna för aliaset på standardmiljön och sedan tillämpas de miljövariabler som definierats här.

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" eller "replace" och anger var miljön ska placeras ska placeras i relation till den befintliga miljön. Om det utelämnas läggs variabeln till till miljön.

Element: Parameter
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 Om det körbara attributet för en tillämpning anger ett alias tillämpas kommandoradsargumenten för aliaset och sedan tillämpas de kommandoradsargument som definierats här.

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" eller "replace" och anger var argumentet ska placeras i relation till de befintliga kommandoradsargumenten. Om det utelämnas läggs argumentet till till kommandoraden.

Exempel på filen agent.xml

<Agent Name="org.eclipse.tptp.TimeCollector">
    <Interface>org.eclipse.tptp.agent</Interface>
    <Interface>org.eclipse.tptp.collector</Interface>
    <SingleInstance>0</SingleInstance>
    <Bound>0</Bound>
    <MaxControllers>-1</MaxControllers>
    <MaxObservers>-1</MaxObservers>
    <ConfigFile>c:\tptp\agents\org.eclipse.tptp.TimeCollector\config\agentconfig.xml</ConfigFile>
        <LaunchConfiguration>

            <launchInfo>
                <Application executable=".\TimeCollector.exe">

                    <Parameter value="-serviceconfig ..\config\serviceconfig.xml" />

                </Application>

            </launchInfo>
        </LaunchConfiguration>
</Agent>


Närliggande referens

Översikt över konfiguration för agent och agentkontrollant


Copyright (C) 2005, 2006 Intel Corporation.