Soubor pluginconfig.xml

Obsah

 

Poznámka

Při odkazování na umístění souborů a adresářů v tomto dokumentu představuje <install-home> adresář, kam byl rozbalen balíček Řadiče agentů.

Úvod

Soubor pluginconfig.xml se nachází v adresáři <install-home>\plugins\<plugin-name>\config.  Je to mechanizmus pro rozšíření globálního prostředí a aliasů aplikací definovaných v souboru serviceconfig.xml podle potřeb jednotlivě vytvořených balíků aplikací.  Rozšíření nastavení prostředí definovaného v souboru serviceconfig.xml má dopad na všechny aplikace (včetně agentů) spouštěné Řadičem agentů, protože všechny dědí toto prostředí.  To umožňuje "modulu plug-in" zajistit vyhledatelnost jeho aplikací jinými procesy spuštěnými Řadičem agentů (např. přidáním jeho cesty do proměnné prostředí CLASSPATH). Rozšíření seznamu aliasů aplikací je prostředkem ke spuštění nové aplikace, pokud je Řadič agentů zkonfigurován tak, aby omezil své služby spouštění pouze na aplikace v seznamu.

Soubor pluginconfig.xml tudíž poskytuje mechanizmus pro balení přídavných komponent, které jsou volitelné při základní instalaci Řadiče agentů.  Protože se neupravuje samotný soubor serviceconfig.xml, je odebrání přídavných komponent stejně snadné.  

Agenti mohou vyžadovat soubor pluginconfig.xml i soubor agent.xml. K definování nové aplikace typu agent je zapotřebí soubor agent.xml, pokud chcete, aby ji našel nový řadič agentů při hledání dostupných agentů (tj. aby byl schopen ji zjistit).  Soubor pluginconfig.xml je povinný, pokud agent potřebuje rozšířit prostředí nebo seznam aliasů v souboru serviceconfig.xml. Použití souboru agent.xml nahradí v budoucí verzi použití souboru pluginconfig.xml.

Poznámka

Termín "modul plug-in" je zde použit pouze jako volný odkaz na modul plug-in platformy Eclipse.  Důvodem je to, že původně se používaly skutečné moduly plug-in.  Nyní se však jedná o nesprávný název, protože tento konfigurační soubor může odkazovat na libovolnou aplikaci, která nemusí být zabalena jako modul plug-in vhodný pro instalaci do pracovní plochy platformy Eclipse.

Soubor pluginconfig.xml obsahuje následující hlavní segmenty:

 

Konfigurace modulu plug-in

 

Hierarchie prvků obsažených v souboru pluginconfig.xml je zobrazena níže. Pořadí prvků zobrazených na stejné úrovni je nepodstatné. Hypertextové odkazy v hierarchii odkazují na formální popis prvků v sekci Prvky a atributy.


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Application
            Variable
            Parameter
        Agent
            Option

       

Prvky a atributy

 

Prvek: PluginConfiguration
Toto je kořenový prvek konfigurace modulu plug-in. Povolen je pouze jeden výskyt dílčího prvku  AgentControllerEnvironment. Všechny další prvky (Option, Application, a Agent) mohou mít více výskytů.  Kterýkoli dílčí prvek může být vynechán.

Dílčí prvky:     AgentControllerEnvironment

                            Option
                            Application
                            Agent
                           
Atributy:

requires
(volitelné) Tato hodnota typu řetězec je čárkami oddělený seznam názvů modulů plug-in, na kterých je tato konfigurace závislá. V TPTP 4.0 byla k názvům modulů plug-in přidána přípona s identifikátorem verze. Přípona sestává ze znaku podtržení následovaného číslem verze daného vydání. Například: org.eclipse.tptp.platform.agentcontroller_4.0.0. Aby byla zajištěna kompatibilita modulů plug-in pro aplikace obsahující závislosti na modulech plug-in z předchozích verzí (tedy těch, které neobsahují příponu s identifikátorem verze), máte možnost zadat název modulu plug-in do atributu "requires" bez identifikátoru verze. V tomto případě se zaváděč konfigurace Řadiče agentů nejdříve pokusí najít úplný název modulu plug-in včetně přípony s identifikátorem verze. Není-li úspěšný, zaváděč konfigurace pak hledá název modulu plug-in bez přípony s identifikátorem verze. Pokud existuje více než jeden modul plug-in se stejným názvem, bude použit první název modulu plug-in vrácený operačním systémem.

Prvek: AgentControllerEnvironment
Prvek AgentControllerEnvironment obklopuje jeden nebo více prvků Variable, které rozšíří proměnné prostředí definované v souboru serviceconfig.xml.  Tato rozšíření se stanou součástí prostředí použitého při spouštění všech aplikací.


Použito v: PluginConfiguration

Dílčí prvky:     Variable

 

Prvek: Variable

Tento prvek Variable definuje proměnnou prostředí a to, jak má být umístěna ve stávajícím prostředí, aby vytvořila nové výchozí prostředí pro všechny spuštěné aplikace a agenty. Těchto prvků může být pro prvek AgentControllerEnvironment definováno libovolně mnoho, nebo nemusí být definován žádný.

Použito v: AgentControllerEnvironment

Atributy:

name
Tato hodnota typu řetězec určuje název proměnné prostředí.
value
Tato hodnota typu řetězec určuje hodnotu proměnné prostředí.
position
(volitelné) Touto hodnotou typu řetězec je jedna z hodnot "append", "prepend" nebo "replace", indikující, kam umístit toto prostředí vzhledem ke stávajícímu výchozímu prostředí.

Prvek: Option
Prvek Option jako nejvyšší prvek v prvku PluginConfiguration se používá k určení libovolných konfiguračních dat, která budou předána každému agentu, který se zaregistruje u Řadiče agentů. Tyto informace jsou součástí informací o vlastnostech, které jsou za každého agenta vraceny klientovi. Agent může tyto informace interpretovat (nebo ne) podle toho, jak je vhodné. Informace z prvku Option jsou dávány pouze agentům, které používají původní rozhraní API (vrstvy zpětné kompatibility) Řadiče agentů. K poskytování konfiguračních informací agentu používajícímu nové rozhraní API použijte konfigurační soubor agent.xml.

Použito v: Agent

Atributy:

name
Tato hodnota typu řetězec určuje obor názvů pro volitelný doplněk.
type
Tato hodnota typu řetězec určuje název volitelného doplňku.
value
Tato hodnota typu řetězec určuje hodnotu volitelného doplňku.
Prvek: Application
Prvek Application definuje nebo rozšiřuje zástupné jméno a informace pro spuštění pro aplikaci. Může obsahovat nastavení prostředí, která jsou viditelná pouze pro tuto konkrétní aplikaci při jejím spuštění.  Tento alias aplikace je přidán do seznamu definovaného v rámci prvku ApplicationAliases v souboru serviceconfig.xml.


Použito v: PluginConfiguration

Dílčí prvky:     Variable

                            Parameter

Atributy:

executable
Tato hodnota typu řetězec určuje zástupný název pro spustitelný soubor aplikace zadaný v atributu path. Klienti musejí používat tento název k identifikaci této aplikace.  Pokud je uvedený také atribut extends, zde uvedený název by se měl shodovat s předtím definovaným aliasem. 
path
Tato hodnota typu řetězec určuje úplný název cesty k aplikaci, která se má spustit. Používá se místo zástupného jména při spouštění spustitelného souboru aplikace.
Atribut je ignorován, pokud je zadaný atribut extends
location
(volitelné) Tato hodnota typu řetězec určuje adresář, z něhož má být spuštěn spustitelný soubor; někdy je označovaný jako pracovní adresář pro právě spuštěný spustitelný soubor.
extends
(volitelné) Tato hodnota typu řetězec určuje název konfigurace pro předtím definovaný alias aplikace. Názvy konfigurace však nejsou podporované, takže hodnota tohoto atributu by měla být nastavena na "default". Pokud je přítomen atribut extends (nehledě na hodnotu), označuje, že informace obsažené v tomto prvku Application by měly rozšiřovat informace pro spuštění předtím definované v odpovídajícím aliasu aplikace. Není dovoleno měnit hodnotu atributu path (tj. spouštěný spustitelný soubor). Pokud není pro název spustitelného souboru nalezena shoda, nemá tento prvek Application žádný efekt.

Prvek: Variable
Tento prvek Variable definuje proměnnou prostředí a to, jak má být umístěna ve stávajícím prostředí, když se aplikace spouští. Těchto prvků může být pro aplikaci definováno libovolně mnoho, nebo nemusí být definován žádný.

Použito v: Application

Atributy:

name
Tato hodnota typu řetězec určuje název proměnné prostředí.
value
Tato hodnota typu řetězec určuje hodnotu proměnné prostředí.
position
(volitelné) Touto hodnotou typu řetězec je jedna z hodnot "append", "prepend" nebo "replace", indikující, kam umístit toto prostředí vzhledem k výchozímu prostředí.

Prvek: Parameter

Prvek Parameter definuje argument příkazového řádku, který se předá aplikaci při jejím spuštění. Těchto prvků může být pro aplikaci definováno libovolně mnoho, nebo nemusí být definován žádný.

Použito v: Application

Atributy:

value
Tato hodnota typu řetězec určuje argument příkazového řádku.
position
(volitelné) Touto hodnotou typu řetězec je jedna z hodnot "append", "prepend" nebo "replace" indikující, kam umístit tento argument vzhledem ke stávajícím argumentům příkazového řádku.

Prvek: Agent
Poskytuje konfigurační informace pro konkrétního agenta. Používají jej pouze agenti používající původní   rozhraní API (vrstvy zpětné kompatibility) Řadiče agentů. K poskytování konfiguračních informací agentu používajícímu nové rozhraní API použijte konfigurační soubor agent.xml.

Použito v: PluginConfiguration

Dílčí prvky:     Option

Atributy:

name
Tato hodnota typu řetězec určuje název agenta, pro který by se měly tyto konfigurační informace použít.
type
(volitelné) Tato hodnota typu řetězec určuje typ agenta.
dataChannelSize
(volitelné) Tato hodnota typu řetězec určuje množství sdílené paměti, která má být přidělena pro komunikaci mezi procesy. Hodnoty mají formu kladného celého čísla s příponou M nebo K označující Megabajty respektive Kilobajty, nebo nemají žádnou příponu, což označuje bajty. Vzorové hodnoty: "16M", "8K" nebo "16000".
logFile
(volitelné) Tato hodnota typu řetězec určuje úplný název cesty k souboru. Pokud je zadaná, data, která by normálně procházela datovým kanálem ke klientovi, budou místo toho zapisována do tohoto souboru.
client
(volitelné) Tato hodnota typu řetězec určuje, zda tento agent provádí interakci s klientem.  Možné hodnoty jsou "DYNAMIC" nebo "HEADLESS".   HEADLESS označuje, že není přidružen žádný klient.  Výchozí hodnota je DYNAMIC.
extends
(volitelné) Tato hodnota typu řetězec určuje název konfigurace pro předtím definovaného agenta. Názvy konfigurace však nejsou podporované, takže hodnota tohoto atributu by měla být nastavena na "default". Pokud je přítomen atribut extends (nehledě na hodnotu), označuje, že informace obsažené v tomto prvku Agent by měly rozšiřovat konfigurační informace předtím definované v odpovídajícím prvku Agent. Používá se k rozšíření seznamu prvků Option přidružených ke konkrétnímu agentu.

Prvek: Option
Dílčí prvek Option v rámci prvku Agent   se používá k určení libovolných konfiguračních dat, která budou předána agentu, když se zaregistruje u Řadiče agentů.  Agent může tyto informace interpretovat (nebo ne) podle toho, jak je vhodné.

Použito v: Agent

Atributy:

name
libovolný řetězec pojmenovávající volitelný doplněk (tj. obor názvů)
type
libovolný řetězec pojmenovávající typ volitelného doplňku (tj. název volitelného doplňku)
value
libovolná hodnota typu řetězec pro volitelný doplněk

Ukázkový soubor 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>
 

Související odkazy

Přehled konfigurace agenta a Řadiče agentů


Copyright (C) 2006 Intel Corporation.