Filen agent.xml

Merk

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

Innledning

Oppstartskonfigurasjonsfilen for agenten (agent.xml) inneholder statisk informasjon som agentkontrolleren trenger for å starte og administrere en agent. Denne statiske informasjonen omfatter følgende:

Filen agent.xml må ligge under en katalog som er navngitt for selve agenten. Katalogen med agentnavnet må ligge i katalogen angitt av Agent-elementet i filen serviceconfig.xml.En agent med navnet org.eclipse.tptp.TimeCollector har for eksempel en konfigurasjonsfil i <install-home>/agents/org.eclipse.tptp.TimeCollector/agent.xml.Agentkontrolleren bruker katalognavnet til å identifisere agenter som det er sendt forespørsel om på grunnlag av navn. Informasjonen i konfigurasjonsfilen agent.xml er metadataene for den agenten.

Vær oppmerksom på at Agentkontrolleren bare leser filene agent.xml for alle agenter én gang når den starter opp. Du må derfor starte agentkontrolleren på nytt hvis du endrer innholdet i disse filene eller legger til nye agentkataloger for at de skal tas i bruk.

Elementer og attributter

Element: Agent
Dette er rotelementet i agentkonfigurasjonsfilen. Det definerer metadataene for en agent. Et objekt kan sende en forespørsel om metadataene til en agent og deretter bruke denne informasjonen slik den ønsker. Underelementene som vises på listen nedenfor, brukes av agentkontrolleren til å starte opp og administrere agenten. Flere underelementer kan defineres av agentutviklere som trenger å returnere mer informasjon som metadata. Metadata er nyttig for en klient som forsøker å ta kjøretidsavgjørelser om hvilken agent som skal brukes til en bestemt oppgave.

Underelementer:     Interface
                            SingleInstance
                            Bound
                            MaxControllers
                            MaxObservers
                            ConfigFile
                            LaunchConfiguration

Attributter:

Navn
Denne strengverdien er det unike navnet til agenten. Denne verdien forventes å være den samme som navnet som brukes av agenten når den registrerer seg selv hos agentkontrolleren.   Hvis disse verdiene er ulike, vil resultatet av forespørsler etter en agent basert på navn, være avhengig av om agenten allerede kjører.

Element:Interface
Strengverdien for dette elementet er navnet på et grensesnitt som støttes av denne agenten. Det kan være null eller flere grensesnittelementer i et agentelement. Et grensesnitt er et unikt navn på et sett med kommandoer som støttes av en agent.

Brukes av:       Agent

Element:SingleInstance
Heltallsverdien for dette elementet er enten 0 eller 1. 0 (usant) indikerer at denne agenten kan ha flere forekomster som kjører samtidig. 1 (sant) indikerer at bare én enkelt forekomst av denne agenten er tillatt. Hvis 1 er definert, vil agentkontrolleren avvise forespørsler om nye forekomster av denne agenten hvis en forekomst kjører allerede.

Brukes av:       Agent

Element: Bound
Heltallsverdien for dette elementet er enten 0 eller 1. 0 (usant) indikerer at denne agenten ikke er bunnet til en applikasjon. 1 (sant) indikerer at agenten er bundet til en applikasjon. En agent som er bundet til en applikasjon, kan bare startes av denne applikasjonen. Derfor vil agentkontrolleren nekte å starte en agent hvis verdien for binding er 1.

Brukes av:       Agent

Element: MaxControllers
Heltallsverdien for dette elementet er -1, 0 eler en positiv verdi. -1 indikerer "ingen grense". Agentkontrolleren vil avvise forespørsler om kontrollerrettigheter for denne agenten hvis antall forespørsler overskrider denne verdien. Rettighetene til en kontroller blir definert av utvikleren av agenten. Den forventede bruken er å begrense antall objekter som kan sende forespørsler om motstridende handlinger, f.eks. starte og stoppe innsamling av data.

Brukes av:       Agent

Element: MaxObservers
Heltallsverdien for dette elementet er -1, 0 eler en positiv verdi. -1 indikerer "ingen grense". Agentkontrolleren vil avvise forespørsler om observeringsrettigheter for denne agenten hvis antall forespørsler overskrider denne verdien. Rettighetene til en observatør blir definert av utvikleren av agenten.Den forventede bruken er å begrense antall objekter som kan sende forespørsler om handlinger som å fremskaffe data som er statisk eller som samles inn (kanskje på grunn av en forespørsel av en kontroller).

Brukes av:       Agent

Element: ConfigFile
Strengverdien for dette elementet angir den fullstendige banen og filnavnet til en ekstra konfigurasjonsfil som inneholder dynamisk konfigurasjonsinformasjon som er tilgjengelig for agenten. Dette er en valgfri fil. Innholdet og formålet med den er definert av utvikleren av agenten. Den forventede bruken er at agenten skal lese sin egen konfigurasjonsinformasjon fra denne filen enten ved oppstart eller på et annet tidspunkt.

Brukes av:       Agent

Element: LaunchConfiguration
Identifiserer oppstartskonfigurasjonsparameterne for denne agenten.

Brukes av:       Agent
                   
Underelementer:     launchInfo
 

Element: launchInfo
Kapsler inn informasjon som brukes under oppstart av en utførbar fil.

Brukes av:       LaunchConfiguration

Underelementer:     Applcation

Element: Application
Dette Application-elementet definerer informasjonen som brukes ved oppstart av en applikasjon. Attributtverdien executable kan angi en applikasjon etter aliasnavn (se ApplicationAliases-elementet i serviceconfig.xml) eller banenavnet til den utførbare filen som skal startes. Verdien sammenliknes først med listen over aliaser som hentes fra serviceconfig.xml ved oppstart av agentkontrolleren. Hvis det ikke finnes noen verdi som samsvarer, brukes oppstartsinformasjonen i Application-elementet som det er.  Hvis det blir funnet en verdi som samsvarer, brukes oppstartsinformasjonen definert for det aliaset sammen med informasjonen som er definert her, slik det blir beskrevet nedenfor.

Brukes av:       LaunchConfiguration
                   
Underelementer:     Variable
                            Parameter                          

Attributter:

executable

Denne strengverdien angir navnet på applikasjonen som skal startes. Det kan enten være et aliasnavn eller banenavnet til den utførbare filen som skal startes.   Hvis det er et aliasnavn, blir navnet på den uførbare filen erstattet med baneverdien som er oppgitt i aliaset.

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. Hvis den utelates og den utførbare filen ikke samsvarte med et alias, kjøres applikasjonen fra katalogen der agentkontrolleren ligger.   Hvis den utelates og den utførbare filen samsvarer med et alias, brukes plasseringen som er angitt for aliaset.

Element: Variable
Dette Variable-elementet definerer en miljøvariabel og hvordan den skal plasseres i det eksisterende miljøet. Når den er plassert i et Application-element, endrer den miljøet som brukes når applikasjonen startes. Det kan være null eller flere av disse elementene definert for Application.Hvis executable-attributtet til Application spesifiserer et alias, brukes innstillingene til aliasets miljøvariabel på standardmiljøet, og deretter brukes miljøvariablene som er definert her, oppå dem.

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 viser hvor miljøvariabelen skal plasseres i forhold til det gjeldende miljøet. Hvis variabelen utelates, tilføyes den i miljø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. Hvis executable-attributtet til Application spesifiserer et alias, brukes kommandolinjeargumentene, og deretter brukes kommandolinjeargumentene som er definert her, oppå dem.

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. Hvis den utelates, legges argumentet til først på kommandolinjen.

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


Beslektet referanse

Konfigurasjonsoversikt for agent og agentkontroller


Copyright (C) 2005, 2006 Intel Corporation.