Pluginconfig.xml-tiedosto

Sisältö

 

Huomautus

Näissä ohjeissa olevissa tiedosto- ja hakemistosijaintien viittauksissa <install-home> on hakemisto, johon agentin ohjaimen paketti on purettu.

Johdanto

Pluginconfig.xml-tiedosto on hakemistossa <install-home>\plugins\<plugin-name>\config.  Sen avulla serviceconfig.xml-tiedostossa määritettyjä yleistä ympäristöä ja sovellusten valenimiä voidaan laajentaa yksittäin paketoitujen sovellusten tarpeiden mukaan. Serviceconfig.xml-tiedostoon määritettyjen ympäristöasetusten laajennus vaikuttaa kaikkiin agentin ohjaimen aloittamiin sovelluksiin (ja agentteihin), koska ne perivät kyseisen ympäristön. Tämän takia lisäosan määrittämät sovellukset voivat olla muiden agentin ohjaimen aloittamien prosessien käytettävissä (lisäosa voi esimerkiksi lisätä polun CLASSPATH-ympäristömuuttujan arvoksi). Sovelluksen valenimiluettelon laajennuksen avulla voit aloittaa uuden sovelluksen, jos agentin ohjaimen aloituspalvelut on rajoitettu vain luettelossa olevien sovellusten käyttöön.

Pluginconfig.xml-tiedoston avulla voit koota lisäosakomponenttien pakkauksia, jotka ovat valinnaisia agentin ohjaimen perusasennuksessa. Koska serviceconfig.xml-tiedostoa ei tarvitse muokata, lisäosien poisto on helppoa.  

Agentin käyttöön voidaan tarvita sekä pluginconfig.xml- että agent.xml-tiedosto. Agent.xml-tiedoston on oltava käytössä, jos haluat uuden agentin ohjaimen löytävän agenttisovelluksen käytettävissä olevien agenttien haussa. Pluginconfig.xml-tiedoston on oltava käytössä, jos agentin on laajennettava serviceconfig.xml-ympäristöä tai valenimiluetteloa. Tulevissa versioissa agent.xml-tiedosto korvaa pluginconfig.xml-tiedoston.

Huomautus

Näissä ohjeissa lisäosa-käsite ei tarkoita pelkästään Eclipse-lisäosia. Käsite on käytössä, koska aluksi käytössä olivat varsinaiset lisäosat. Tässä versiossa tämä käsite on hieman harhaanjohtava, koska tässä kokoonpanotiedostossa voi olla viittauksia mihin tahansa sovelluksiin, joiden ei tarvitse olla lisäosamuotoisia Eclipse-työympäristöön asennettavia sovelluksia.

Pluginconfig.xml-tiedosto sisältää seuraavat osat:

 

Lisäosakokoonpano

 

Alla on kuvattu pluginconfig.xml-tiedoston elementtien hierarkia. Samalla tasolla olevien elementtien välinen järjestys ei ole merkitsevä. Hierarkian hyperlinkit ovat linkkejä Elementit ja määritteet -osassa kuvattuihin muodollisiin elementtikuvauksiin.


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Application
            Variable
            Parameter
        Agent
            Option

       

Elementit ja määritteet

 

Elementti: PluginConfiguration
Tämä on lisäosakokoonpanon juurielementti. AgentControllerEnvironment-elementtien esiintymiä voi olla vain yksi. Muista elementeistä (Option, Application ja Agent) voi olla useita esiintymiä. Mikään alielementti ei ole pakollinen.

Alielementit:     AgentControllerEnvironment

                            Option
                            Application
                            Agent
                           
Määritteet:

requires
(Valinnainen) Tämä merkkijonomuotoinen arvo on pilkuin eroteltu luettelo niiden lisäosien nimistä, joille tämä kokoonpano on alisteinen. TPTP-versiosta 4.0 alkaen lisäosien nimiin on lisätty loppuliitteeksi versiotunnus. Se muodostuu alaviivasta ja version versionumerosta. Esimerkki: org.eclipse.tptp.platform.agentcontroller_4.0.0. Jos haluat säilyttää yhteensopivuuden sellaisten sovellusten kanssa, jotka ovat alisteisia aiemman version mukaisille lisäosille (joissa ei ole loppuliitteenä versiotunnusta), voit jättää versiotunnuksen pois requires-määritteeseen lisäämästäsi lisäosan nimestä. Tällöin agentin ohjaimen kokoonpanon lataustoiminto yrittää ensin etsiä täydellistä lisäosan nimeä, jossa on loppuliitteenä versiotunnus. Jos sitä ei löydy, kokoonpanon lataustoiminto etsii lisäosan nimeä, jossa ei ole loppuliitteenä versiotunnusta. Jos samannimisiä lisäosia on useita, lataustoiminto käyttää ensimmäistä käyttöjärjestelmän palauttamaa lisäosan nimeä.

Elementti: AgentControllerEnvironment
AgentControllerEnvironment-elementti sisältää vähintään yhden Variable-elementin, joka on serviceconfig.xml-tiedostoon määritettyjen yleisten ympäristömuuttujien laajennus.  Nämä laajennukset lisätään kaikkien sovellusten aloituksessa käytettävän ympäristön osiksi.


Käyttöelementti: PluginConfiguration

Alielementit:     Variable

 

Elementti: Variable

Tämä Variable-elementti määrittää ympäristömuuttujan ja sen, miten se on sijoitettava käytössä olevaan ympäristöön, jotta saadaan muodostettua kaikkien aloitettavien sovellusten ja agenttien uusi oletusympäristö. Voit määrittää näitä elementtejä AgentControllerEnvironment-elementtiin haluamasi määrän.

Käyttöelementti: AgentControllerEnvironment

Määritteet:

name
Tämä merkkijonomuotoinen arvo määrittää ympäristömuuttujan nimen.
value
Tämä merkkijonomuotoinen arvo määrittää ympäristömuuttujan arvon.
position
(Valinnainen) Tämä merkkijonomuotoinen arvo, joka voi olla "append" (liitä loppuun), "prepend" (liitä alkuun) tai "replace" (korvaa), määrittää, mihin tämä ympäristömuuttuja sijoitetaan suhteessa aiemmin määritettyyn oletusympäristöön.

Elementti: Option
Option-elementti on PluginConfiguration-elementtiin sisältyvä ylätason elementti, joka määrittää kaikille agentin ohjaimeen rekisteröityville agenteille määritettävät halutut kokoonpanotiedot. Järjestelmä lisää nämä tiedot kaikkien työasemaohjelmaan palautettavien agenttien ominaisuustietoihin. Agentti voi tulkita nämä tiedot (tai jättää ne tulkitsematta) vapaasti. Option-osan tiedot välittyvät vain agenteille, joissa on käytössä agentin ohjaimen alkuperäinen ohjelmointirajapinta (taaksepäin yhteensopivuuden takaavat kerrokset). Uutta ohjelmointirajapintaa käyttävien agenttien kokoonpanotiedot voit määrittää agent.xml-kokoonpanotiedostoon.

Käyttöelementti: Agent

Määritteet:

name
Tämä merkkijonomuotoinen arvo määrittää asetuksen nimitilan.
type
Tämä merkkijonomuotoinen arvo määrittää asetuksen nimen.
value
Tämä merkkijonomuotoinen arvo määrittää asetuksen arvon.
Elementti: Application
Application-elementti määrittää sovelluksen valenimen ja aloitustiedot tai niiden laajennuksen. Elementti voi sisältää ympäristöasetuksia, jotka ovat vain tämän sovelluksen näkyvissä sovellusta aloitettaessa. Järjestelmä lisää tämän sovelluksen valenimen serviceconfig.xml-tiedoston ApplicationAliases-elementissä määritettyyn luetteloon.


Käyttöelementti: PluginConfiguration

Alielementit:     Variable

                            Parameter

Määritteet:

executable
Tämä merkkijonomuotoinen arvo määrittää path-määritteen mukaisen sovelluksen ohjelmatiedoston valenimen. Työasemaohjelmien on käytettävä tätä nimeä tämän sovelluksen tunnisteena. Jos myös extends-määritteelle on määritetty arvo, tähän määritetyn nimen on oltava sama kuin aiemmin määritetyn valenimen. 
path
Tämä merkkijonomuotoinen arvo määrittää aloitettavan sovelluksen täydellisen polun nimen. Tämä arvo korvaa valenimen sovelluksen ohjelmatiedoston aloituksessa.
Järjestelmä ohittaa tämän määritteen arvon, jos extends-määritteelle on määritetty arvo. 
location
(Valinnainen) Tämä merkkijonomuotoinen arvo määrittää hakemiston, josta ohjelmatiedosto aloitetaan. Tätä hakemistoa kutsutaan joissakin tilanteissa ohjelmatiedoston työhakemistoksi, kun ohjelmatiedosto on ajossa.
extends
(Valinnainen) Tämä merkkijonomuotoinen arvo on aiemmin määritetyn sovelluksen valenimen kokoonpanon nimi. Koska kokoonpanojen nimet eivät kuitenkaan ole tuettuja, tämän määritteen arvon pitäisi olla default. Jos extends-määrite on käytössä (sen arvolla ei ole merkitystä), se ilmaisee, että tämän sovelluksen tiedot ovat laajennus aiemmin määritettyihin sovelluksen valenimen aloitustietoihin. Path-arvoa (eli aloitettavaa ohjelmatiedostoa) ei voi muuttaa. Jos järjestelmästä ei löydy vastaavaa ohjelmatiedoston nimeä, tällä Application-elementillä ei ole vaikutusta.

Elementti: Variable
Tämä Variable-elementti määrittää ympäristömuuttujan ja sen, miten se on sijoitettava käytössä olevaan ympäristöön sovellusta aloitettaessa. Voit määrittää näitä elementtejä haluamasi määrän Application-elementtiin.

Käyttöelementti: Application

Määritteet:

name
Tämä merkkijonomuotoinen arvo määrittää ympäristömuuttujan nimen.
value
Tämä merkkijonomuotoinen arvo määrittää ympäristömuuttujan arvon.
position
(Valinnainen) Tämä merkkijonomuotoinen arvo, joka voi olla "append" (liitä loppuun), "prepend" (liitä alkuun) tai "replace" (korvaa), määrittää, mihin tämä ympäristömuuttuja sijoitetaan suhteessa oletusympäristöön.

Elementti: Parameter

Parameter-elementti määrittää aloitettavaan sovellukseen välitettävän komentorivin argumentin. Voit määrittää näitä elementtejä haluamasi määrän Application-elementtiin.

Käyttöelementti: Application

Määritteet:

value
Tämä merkkijonomuotoinen arvo määrittää komentorivin argumentin.
position
(Valinnainen) Tämä merkkijonomuotoinen arvo, joka voi olla "append" (liitä loppuun), "prepend" (liitä alkuun) tai "replace" (korvaa), määrittää, mihin tämä argumentti sijoitetaan suhteessa aiemmin määritettyihin komentorivin argumentteihin.

Elementti: Agent
Tämä elementti määrittää tietyn agentin kokoonpanotiedot. Tämä elementti on määritettävä vain agentin ohjaimen alkuperäistä ohjelmointirajapintaa (taaksepäin yhteensopivuuden takaavia kerroksia) käyttäville agenteille. Uutta ohjelmointirajapintaa käyttävien agenttien kokoonpanotiedot voit määrittää agent.xml-kokoonpanotiedostoon.

Käyttöelementti: PluginConfiguration

Alielementit:     Option

Määritteet:

name
Tämä merkkijonomuotoinen arvo määrittää näitä kokoonpanotietoja käyttävän agentin nimen.
type
(Valinnainen) Tämä merkkijonomuotoinen arvo määrittää agentin lajin.
dataChannelSize
(Valinnainen) Tämä merkkijonomuotoinen arvo määrittää prosessien välisiin yhteyksiin varattavan yhteisen muistin määrän. Arvo voi olla positiivinen kokonaisluku, jossa on loppuliitteenä joko kirjain M (megatavua) tai K (kilotavua) tai jossa ei ole lainkaan loppuliitettä (tavua). Esimerkkiarvoja: "16M", "8K" tai "16000".
logFile
(Valinnainen) Tämä merkkijono on tiedoston tarkka polun nimi. Jos tämä arvo on määritetty, normaalisti työasemaohjelman tietokanavaan siirrettävät tiedot kirjoitetaan siirron sijasta tähän tiedostoon.
client
(Valinnainen) Tämä merkkijono määrittää, onko tämä agentti vuorovaikutuksessa työasemaohjelman kanssa. Mahdolliset arvot ovat DYNAMIC ja HEADLESS.   HEADLESS-arvo ilmaisee, ettei työasemaohjelmaliitosta ole.  Oletusarvo on DYNAMIC.
extends
(Valinnainen) Tämä merkkijonomuotoinen arvo määrittää aiemmin määritetyn agentin kokoonpanon nimen. Koska kokoonpanojen nimet eivät kuitenkaan ole tuettuja, tämän määritteen arvon pitäisi olla default. Jos extends-määrite on käytössä (sen arvolla ei ole merkitystä), se ilmaisee, että tämän agentin tiedot ovat laajennus aiemmin määritettyihin Agent-elementin valenimen kokoonpanotietoihin. Tämä määrite laajentaa tiettyyn agenttiin liitettyä asetusluetteloa.

Elementti: Option
Agent-elementin Option-alielementti määrittää valinnaiset kokoonpanotiedot, jotka välittyvät agentin ohjaimeen rekisteröityvälle agentille. Agentti voi tulkita nämä tiedot (tai jättää ne tulkitsematta) vapaasti.

Käyttöelementti: Agent

Määritteet:

name
Tämä vapaamuotoinen merkkijono määrittää asetuksen nimen (eli nimitilan).
type
Tämä vapaamuotoinen merkkijono määrittää asetuksen lajin (eli asetuksen nimen).
value
Tämä vapaamuotoinen merkkijono määrittää asetuksen arvon.

Pluginconfig.xml-esimerkkitiedosto

 

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

Aiheeseen liittyviä ohjeita

Agentin ja agentin ohjaimen yleiskuvaukset


Copyright (C) 2006 Intel Corporation.