A pluginconfig.xml fájl

Tartalom

 

Megjegyzés

Ha a dokumentumban egy fájl- vagy könyvtárhelyre hivatkozik, akkor az <install-home> az a könyvtár, amelyben az ügynökvezérlő csomag kibontásra került.

Bevezetés

A pluginconfig.xml fájl a <install-home>\plugins\<plugin-name>\config könyvtárban található.  Ez a mechanizmus a serviceconfig.xml fájlban meghatározott globális környezet, valamint az alkalmazás álnevek kiterjesztéséhez, az egyénileg kötegelt alkalmazások szükségletei szerint.  A serviceconfig.xml fájlban meghatározott környezeti beállítások kiterjesztése hatással van az ügynökvezérlő által elindított összes alkalmazásra (beleértve az ügynököket), mivel ezek öröklik a környezetet.  Ez lehetővé teszi egy "bedolgozó" számára, hogy az alkalmazásait az ügynökvezérlő által indított további folyamatok számára megtalálhatóvá tegye (pl. az elérési útjának hozzáadásával a CLASSPATH környezeti változóhoz). Az alkalmazás álnevek listájának kiterjesztése az indítandó új alkalmazás egy eszköze, ha az ügynökvezérlő csak a listában található indítási szolgáltatások engedélyezésére van beállítva.

Így a pluginconfig.xml biztosít egy mechanizmust a kiegészítő összetevők csomagolására, amelyek az ügynökvezérlő alapszintű telepítéséhez nem kötelezőek.  Mivel a serviceconfig.xml fájl nem került módosításra, a kiegészítések eltávolítása egyszerű.  

Az ügynökök egyaránt igényelhetik a pluginconfig.xml és az agent.xml fájlt. Az agent.xml fájl egy ügynökalkalmazás meghatározásához szükséges, ha a rendelkezésre álló ügynökök keresésekor igényt tart az új ügynökvezérlőre (pl. képes legyen a feltérképezésre).  A pluginconfig.xml fájl akkor szükséges, ha az ügynöknek szüksége van a serviceconfig.xml környezet vagy álnévlista kiterjesztésére. Az agent.xml fájl használata a későbbi kiadásban felül fogja írni a pluginconfig.xml használatát.

Megjegyzés

Az itt használt "bedolgozó" kifejezés az Eclipse bedolgozó egy rövid utalása.  A korábbi tényleges bedolgozók használatából alakult ki.  De ez ma már egy téves kifejezés, mivel ez a konfigurációs fájl bármilyen alkalmazásra utalhat anélkül, hogy az Eclipse munkaterületbe történő telepítéshez megfelelő bedolgozóként kerülne tördelésre.

A pluginconfig.xml fájl a következő fő szegmenseket tartalmazza:

 

Bedolgozó konfiguráció

 

A pluginconfig.xml fájlban található elemek hierarchiája alább látható. Az azonos szinten lévő elemek sorrendje érdektelen. A hierarchiában található hiperhivatkozások az elemeknek az Elemek és attribútumok című részben található leírására mutatnak.


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Application
            Variable
            Parameter
        Agent
            Option

       

Elemek és jellemzők

 

Elem: PluginConfiguration
Ez a bedolgozó konfiguráció gyökéreleme. Az   AgentControllerEnvironment elemnek csak egy előfordulása engedélyezett. Az összes többi elemnek (Option, Application, és Agent) több előfordulása is engedélyezett.  A részelemek bármelyike kihagyható.

Részelemek:     AgentControllerEnvironment

                            Option
                            Application
                           Agent
                           
Jellemzők:

requires
(elhagyható) Ez a karaktersorozat érték egy vesszővel elválasztott lista azon bedolgozó(k) nevével, amely(ek)től ezen konfigurációk függnek. A TPTP 4.0 verziójában megjelent egy verzióazonosító utótag a bedolgozók nevében. Egy aláhúzás karakterből és a kiadás verziószámából áll. Például org.eclipse.tptp.platform.agentcontroller_4.0.0. A korábbi kiadások (verziószám utótaggal nem rendelkező) bedolgozóitól függő alkalmazások kompatibilitásának megőrzése végett a "requires" attribútumban a bedolgozó neve a verzióazonosító nélkül is meghatározható. Ebben az esetben az ügynökvezérlő konfiguráció betöltője először a verzióazonosító utótagot is tartalmazó teljes név alapján próbálja megkeresni a bedolgozót. Ha ez sikertelen, akkor a konfiguráció betöltője a verzióazonosító utótag nélkül próbálja megkeresni a bedolgozót. Ha ugyanazon a néven több bedolgozó is van, akkor az operációs rendszer által elsőként visszaadott bedolgozónév kerül felhasználásra.

Elem: AgentControllerEnvironment
Az AgentControllerEnvironment elem több Variable elemet mellékel, amelyek kiterjesztik a serviceconfig.xml fájlban maghatározott globális környezeti változókat.  Ezek lesznek az összes alkalmazás indításánál használt környezet részei.


Használó: PluginConfiguration

Részelemek:     Variable

 

Elem: Variable

Ez a változó elem határozza meg a környezeti változót és annak elhelyezési módját a meglévő környezetben, az új alapértelmezett környezet kialakításához az összes elindított alkalmazáshoz és ügynökhöz. Az AgentControllerEnvironment elemhez ezen elemek közül nulla vagy több is meghatározásra kerülhet

Használó: AgentControllerEnvironment

Jellemzők:

name
Ez a karaktersorozat érték határozza meg a környezeti változó nevét.
value
Ez a karaktersorozat érték határozza meg a környezeti változó értékét.
position
(elhagyható) Ez a karaktersorozat érték az "append", "prepend" vagy a "replace", egyike, amely azt jelzi, hogy hova kell elhelyezni a környezetet relatívan a meglévő alapértelmezett környezethez.

Elem: Option
Az Option a PluginConfiguration felső szintű elemeként tetszőleges konfigurációs adatok meghatározására használható, amely az összes olyan ügynökhöz átadásra kerül, amely regisztrálja magát az ügynökvezérlővel. Ez az információ az összes ügynökhöz visszaadott tulajdonságinformációba belefoglalásra kerül az ügyfélhez. Az ügynök értelmezheti ezt az információt (vagy nem), ha megfelelőnek találja. Az eleminformációk csak olyan ügynökhöz kerülnek megadásra, amelyek az ügynökvezérlő eredeti alkalmazás programozási felületét (visszamenőleges kompatibilitás rétegek) használják. Az agent.xml konfigurációs fájl segítségével adja meg a konfigurációs információkat olyan ügynököknek, amelyek az új alkalmazás programozási felületet hasznáják.

Használó: Agent

Jellemzők:

name
Ez a karaktersorozat érték határozza meg a névtér elemét.
type
Ez a karaktersorozat érték határozza meg az elem nevét.
value
Ez a karaktersorozat határozza meg az elem értékét-
Elem: Application
Az Application elem meghatározza vagy kiterjeszti az alkalmazás álnevét és indítási információit. Ez olyan környezeti beállításokat tartalmazhat, amelyek csak ehhez az adott alkalmazáshoz láthatóak, ha el van indítva.  Ez az alkalmazás álnév hozzáadásra kerül ahhoz a listához, amely az ApplicationAliases elemben a serviceconfig.xml fájlban került meghatározásra.


Használó: PluginConfiguration

Részelemek:     Variable

                            Parameter

Jellemzők:

executable
Ez a karaktersorozat érték határozza meg az elérési út attribútumában megadott alkalmazás végrehajtható fájljának álnevét. Az alkalmazás azonosítására az ügyfeleknek ezt a nevet kell használniuk.  Ha az extends jellemző is meg van adva, akkor az itt megadott névnek meg kell egyeznie a korábban megadott álnévvel. 
path
Ez a karaktersorozat érték határozza meg az indítandó alkalmazás teljes útvonalnevét. Ez az álnév helyén kerül felhasználásra az alkalmazás végrehajtható fájljának indításakor.
A rendszer figyelmen kívül hagyja ezt a jellemzőt, ha az extends jellemző meg van adva. 
location
(elhagyható) Ez a karaktersorozat érték meghatározza a könyvtárat, amelyből a végrehajtható fájlt indítani kell, néha pedig a végrehajtható fájlhoz a futása során munkakönyvtárként kerül felhasználásra.
extends
(elhagyható) Ez a karaktersorozat érték határozza meg a konfiguráció nevét a korábban meghatározott alkalmazás álnévhez. Mivel a konfiguráció nevei nem támogatottak, ezért ennek a jellemzőnek az értékét az "alapértelmezett" értékre kell beállítani. Ha az extends jelen van (az értéktől függetlenül), akkor jelzi, hogy az Alkalmazás információinak ki kell terjeszteni az indítási információkat, amelyek korábban a megfelelő alkalmazás álnévben kerültek megadásra. A path érték módosítása nem engedélyezett (pl.: az indított végrehajtható fájl). Ha nem található egyezés a végrehajtható fájl nevével, akkor az Application elem nem lesz hatással a rendszerre.

Elem: Variable
Ez a Variable elem határozza meg a környezeti változót és annak elhelyezési módját a az alkalmazás indításakor a meglévő környezetben. Az alkalmazáshoz nulla vagy több ilyen elem is meghatározható.

Használó: Application

Jellemzők:

name
Ez a karaktersorozat érték határozza meg a környezeti változó nevét.
value
Ez a karaktersorozat érték határozza meg a környezeti változó értékét.
position
(elhagyható) Ez a karaktersorozat érték az "append", "prepend" vagy a "replace", egyike, amely azt jelzi, hogy hova kell elhelyezni a környezetet relatívan az alapértelmezett környezethez.

Elem: Parameter

A Parameter elem egy az alkalmazás indításakor hozzáadandó parancssori paramétert határoz meg. Az alkalmazáshoz nulla vagy több ilyen elem is meghatározható.

Használó: Application

Jellemzők:

value
Ez a karaktersorozat érték határozza meg parancssori paramétert.
position
(elhagyható) Ez a karaktersorozat érték az "append", "prepend" vagy a "replace" egyike, amely azt jelzi, hogy hova kell elhelyezni ezt az argumentumot relatívan a meglévő parancssori argumentumokhoz.

Elem: Agent
Egy adott ügynök konfigurációs információit adja meg. Csak azon ügynökök esetében használható, amelyek az ügynökvezérlő  eredeti alkalmazás programozási felületét (visszamenőleges kompatibilitás rétegek) használják. Az agent.xml konfigurációs fájl segítségével adja meg a konfigurációs információkat olyan ügynököknek, amelyek az új alkalmazás programozási felületet hasznáják.

Használó: PluginConfiguration

Részelemek:     Option

Jellemzők:

name
Ez a karaktersorozat érték határozza meg annak az ügynöknek a nevét, amelyhez ez a konfigurációs információ alkalmazásra kerüljön.
type
(elhagyható) Ez a karaktersorozat érték határozza meg az ügynök típusát.
dataChannelSize
(elhagyható) Ez a karaktersorozat érték határozza meg a belső feldolgozású kommunikációhoz lefoglalható osztott memória mennyiségét. Az értékek pozitív egész szám formátumúak M vagy K utótaggal a Megabyte vagy a Kilobyte jelzésére vagy utótag nélkül a byte-ok jelzésére. Példaértékek: "16M", "8K", vagy "16000".
logFile
(elhagyható) Ez a karaktersorozat határozza meg a fájl teljes képzésű elérési útjának nevét. Ha meg van adva, akkor azok az adatok, amelyek rendszerint az adatcsatornán keresztül jutnak el az ügyfélhez, ehelyett ebbe a fájlba kerülnek beírásra.
client
(elhagyható) Ez a karaktersorozat határozza meg, hogy az ügynök együttműködik-e egy ügyféllel.   A lehetséges értékeke a "DYNAMIC" vagy a "HEADLESS".   A HEADLESS jelzi, hogy nincs társított ügyfél.  Az alapértelmezett a DYNAMIC.
extends
(elhagyható) Ez a karaktersorozat érték határozza meg a konfiguráció nevét a korábban meghatározott ügynökhöz. Mivel a konfiguráció nevei nem támogatottak, ezért ennek a jellemzőnek az értékét az "alapértelmezett" értékre kell beállítani. Ha az extends jelen van (függetlenül az értékétől), akkor jelzi, hogy az ügynökbe belefoglalt információknak ki kell terjeszteniük azokat a konfigurációs információkat, amelyek korábban a megegyező Agent elemben kerültek meghatározásra. Az adott ügynökkel társított elemek listájának kibontására kerül felhasználásra.

Elem: Option
Az Option részelem az Agent elemben   tetszőleges konfigurációs adatok meghatározására kerül felhasználásra, amely átadásra kerül ahhoz az ügynökhöz, amely az ügynökvezérlőbe regisztrálta magát.  Az ügynök értelmezheti ezt az információt (vagy nem), ha megfelelőnek találja.

Használó: Agent

Jellemzők:

name
egy tetszőleges karaktersorozat az eleme megnevezésére (pl. névtartomány)
type
egy tetszőleges karaktersorozat az elem típusát megnevezve (pl. elem neve)
value
az elem tetszőleges karaktersorozat értéke

Példa pluginconfig.xml fájl

 

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

Kapcsolódó leírások

Ügynök és ügynökvezérlő konfiguráció áttekintése


Copyright (C) 2006 Intel Corporation.