Le fichier pluginconfig.xml

Sommaire

 

Remarque

Lorsque nous faisons référence aux emplacements de fichiers et de répertoires dans le présent document, sachez que <install-home> correspond au répertoire dans lequel le package du contrôleur d'agent a été extrait.

Introduction

Le fichier pluginconfig.xml figure sous <install-home>\plugins\<plugin-name>\config.  Il s'agit du mécanisme permettant d'étendre l'environnement global et les alias d'application définis dans le fichier serviceconfig.xml, et ce en fonction de chaque application empaquetée.  L'extension des paramètres d'environnement définis dans serviceconfig.xml a une incidence sur l'ensemble des applications (y compris sur les agents) lancées par le contrôleur d'agent, puisqu'elles héritent toutes de cet environnement.  Ainsi, un "plug-in" peut permettre aux autres processus démarrés par le contrôleur d'agent de localiser ses applications (par exemple, en ajoutant son chemin à la variable d'environnement CLASSPATH). L'extension de la liste des alias d'applications permet de lancer une nouvelle application si le contrôleur d'agent est configuré de manière à n'utiliser comme services de lancement que ceux figurant dans la liste.

Par conséquent, grâce au fichier pluginconfig.xml, il est possible de regrouper des composants complémentaires, facultatifs lors de l'installation de base du contrôleur d'agent.  Le fichier serviceconfig.xml n'étant pas modifié, la suppression des fonctions complémentaires est une opération tout aussi facile.  

Les agents peuvent nécessiter à la fois un fichier pluginconfig.xml et un fichier agent.xml. Le fichier agent.xml doit contenir une définition d'application d'agent si vous souhaitez que le nouveau contrôleur d'agent puisse localiser l'application lors de la recherche des agents disponibles.  Le fichier pluginconfig.xml est requis si l'agent a besoin d'étendre la liste des alias ou les environnements définis dans serviceconfig.xml. Dans une version ultérieure, le fichier pluginconfig.xml remplacera le fichier agent.xml.

Remarque

Le terme "plug-in" utilisé ici ne constitue qu'une vague référence à un plug-in Eclipse.  L'emploi de ce terme tient au fait que de véritables plug-ins étaient utilisés à l'origine.  Toutefois, ce nom est désormais inapproprié puisque ce fichier de configuration peut faire référence à n'importe quelle application, et non uniquement aux applications encapsulées en tant que plug-ins installables dans le plan de travail Eclipse.

Le fichier pluginconfig.xml contient les segments principaux suivants :

 

Configuration de plug-in

 

La hiérarchie des éléments contenus dans le fichier pluginconfig.xml est présentée ci-dessous. L'ordre des éléments indiqués sur un même niveau n'a pas d'importance. Les liens hypertextes de la hiérarchie mènent aux descriptions des éléments formels de la section Eléments et attributs.


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Application
            Variable
            Parameter
        Agent
            Option

       

Eléments et attributs

 

Elément : PluginConfiguration
Il s'agit de l'élément principal de la configuration du plug-in. Une seule occurrence de l'environnement de contrôleur d'agent  AgentControllerEnvironment est autorisée. Tous les autres éléments (Option, Application et Agent) acceptent plusieurs occurrences.  Tout sous-élément peut être omis.

Sous-éléments :     AgentControllerEnvironment

                            Option
                            Application
                            Agent
                           
Attributs :

requiert
(facultatif) Cette valeur de chaîne consiste en une liste de noms de plug-ins séparés par une virgule, dont dépend la configuration. A partir de TPTP 4.0, un suffixe identificateur de version a été ajouté aux noms des plug-ins. Il est constitué par un caractère de soulignement suivi par le numéro de version. Par exemple : org.eclipse.tptp.platform.agentcontroller_4.0.0. Pour assurer la compatibilité des plug-ins avec les applications présentant des dépendances de plug-in de versions antérieures (plug-ins ne disposant pas de suffixe identificateur de version), vous pouvez indiquer le nom du plug-in dans l'attribut "requires" en omettant l'identificateur de version. Dans ce cas, le chargeur de configuration du contrôleur d'agent essayera d'abord de localiser le nom complet du plug-in, y compris le suffixe identificateur de version. En cas d'échec, le chargeur de configuration recherchera le nom du plug-in sans le suffixe identificateur de version. S'il trouve plusieurs plug-ins portant le même nom, c'est le premier plug-in retourné par le système d'exploitation qui sera utilisé.

Elément : AgentControllerEnvironment
L'élément AgentControllerEnvironment inclut un ou plusieurs éléments Variable qui étendent les variables d'environnement globales définies dans le fichier serviceconfig.xml.  Ces éléments font alors partie intégrante de l'environnement et sont utilisés pour lancer toutes les applications.


Utilisé par : PluginConfiguration

Sous-éléments :     Variable

 

Elément : Variable

L'élément Variable définit une variable d'environnement ; il indique également la manière dont celle-ci doit être placée dans l'environnement existant afin de constituer le nouvel environnement par défaut de toutes les applications et agents lancés. Zéro ou plusieurs de ces éléments peuvent être définis pour l'élément AgentControllerEnvironment

Utilisé par : AgentControllerEnvironment

Attributs :

name
Cette valeur de chaîne définit le nom de la variable d'environnement.
value
Cette valeur de chaîne définit la valeur de la variable d'environnement.
position
(facultatif) Cette valeur de chaîne est de type "append" (ajouter à la fin), "prepend" (ajouter au début) ou "replace" (remplacer). Elle indique où placer cet environnement par rapport à l'environnement par défaut existant.

Elément : Option
L'élément Option est utilisé comme élément principal dans PluginConfiguration afin de définir des données de configuration arbitraires qui seront transférées à chaque agent s'enregistrant auprès du contrôleur d'agent. Ces informations sont incluses dans les informations de propriété renvoyées au client pour chaque agent. L'agent peut ou non interpréter ces informations. Les informations relatives à l'élément Option ne sont fournies qu'aux agents qui utilisent l'API d'origine (couches de compatibilité amont) du contrôleur d'agent. Utilisez le fichier de configuration agent.xml pour fournir des informations de configuration à un agent qui a recours à la nouvelle API.

Utilisé par : Agent

Attributs :

nom
Cette valeur de chaîne définit l'espace de nom de l'option.
type,
Cette valeur de chaîne définit le nom de l'option.
value
Cette chaîne définit la valeur de l'option.
Elément : Application
L'élément Application définit ou étend un nom d'alias, ainsi que les informations de lancement d'une application. Cet élément peut inclure des paramètres d'environnement visibles uniquement par l'application en question lorsque celle-ci est lancée.  L'alias d'application est ajouté à la liste définie dans l'élément ApplicationAliases du fichier serviceconfig.xml.


Utilisé par : PluginConfiguration

Sous-éléments :     Variable

                            Parameter

Attributs :

exécutable
Cette valeur de chaîne indique le nom d'alias de l'exécutable d'application défini dans l'attribut path. Les clients doivent utiliser ce nom pour identifier l'application.  Si l'attribut extends est également défini, le nom fourni ici doit correspondre à un alias défini précédemment. 
path
Cette valeur de chaîne définit le chemin complet de l'application à lancer. Elle est utilisée en lieu et place du nom d'alias lors du lancement de l'exécutable de l'application.
Cet attribut est ignoré si l'attribut extends est défini. 
emplacement
(facultatif) Cette valeur de chaîne indique le répertoire à partir duquel l'exécutable doit être lancé (on parle parfois de répertoire de travail de l'exécutable lorsque ce dernier est en cours d'exécution).
étend
(facultatif) Cette valeur de chaîne indique le nom de la configuration d'un alias d'application défini précédemment. Toutefois, les noms de configuration ne sont pas pris en charge ; vous devez donc affecter à cet attribut la valeur "default". Lorsque l'attribut extends est présent (quelle que soit sa valeur), les informations contenues dans cette application doivent s'ajouter aux informations de lancement définies précédemment dans l'alias d'application correspondant. Il est interdit de modifier la valeur path (c'est-à-dire l'exécutable en cours de lancement). Si aucune correspondance n'est trouvée avec le nom de l'exécutable, l'élément Application reste sans effet.

Elément : Variable
Cet élément Variable définit une variable d'environnement et la manière dont elle doit se positionner au sein de l'environnement existant lorsque l'application est lancée. Pour chaque application, le nombre d'éléments définis peut être nul.

Utilisé par : Application

Attributs :

name
Cette valeur de chaîne définit le nom de la variable d'environnement.
value
Cette valeur de chaîne définit la valeur de la variable d'environnement.
position
(facultatif) Cette valeur de chaîne est de type "append" (ajouter à la fin), "prepend" (ajouter au début) ou "replace" (remplacer). Elle indique où placer cet environnement par rapport à l'environnement par défaut.

Elément : Parameter

L'élément Parameter définit un argument de ligne de commande à fournir à l'application lors de son lancement. Pour chaque application, le nombre d'éléments définis peut être nul.

Utilisé par : Application

Attributs :

value
Cette valeur de chaîne définit un argument de ligne de commande.
position
(facultatif) Cette valeur de chaîne est de type "append" (ajouter à la fin), "prepend" (ajouter au début) ou "replace" (remplacer). Elle indique où placer cet argument par rapport aux arguments de ligne de commande existants.

Elément : Agent
Fournit des informations de configuration pour un agent particulier. Ces informations ne sont utilisées que par les agents qui ont recours à l'API d'origine  (couches de compatibilité amont) du contrôleur d'agent. Utilisez le fichier de configuration agent.xml pour fournir des informations de configuration à un agent qui a recours à la nouvelle API.

Utilisé par : PluginConfiguration

Sous-éléments :     Option

Attributs :

nom
Cette valeur de chaîne indique le nom de l'agent auquel doivent être appliquées les informations de configuration.
type,
(facultatif) Cette valeur de chaîne définit un type d'agent.
dataChannelSize
(facultatif) Cette valeur de chaîne définit la quantité de mémoire partagée à allouer à la communication interprocessus. Il s'agit d'un entier positif auquel est ajouté le suffixe M (pour méga-octet) ou K (pour kilo-octet) ; n'indiquez aucun suffixe si vous souhaitez utiliser des octets. Par exemple : "16M", "8K" ou "16000".
Fichier journal
(facultatif) Cette chaîne indique le chemin qualifié complet d'un fichier. Lorsque vous définissez cet attribut, les données ne sont plus transmises au client via le canal de données mais sont inscrites dans ce fichier.
client
(facultatif) Cette chaîne indique si l'agent interagit ou non avec un client.  Les valeurs possibles sont "DYNAMIC" ou "HEADLESS".   La valeur HEADLESS permet d'indiquer qu'aucun client n'est associé.  La valeur par défaut est DYNAMIC.
étend
(facultatif) Cette valeur de chaîne indique le nom de la configuration d'un agent défini précédemment. Toutefois, les noms de configuration ne sont pas pris en charge ; vous devez donc affecter à cet attribut la valeur "default". Lorsque l'attribut extends est présent (quelle que soit sa valeur), les informations contenues dans l'élément Agent doivent s'ajouter aux informations de configuration définies précédemment dans l'élément Agent correspondant. Cet attribut permet d'étendre la liste des options associées à un agent donné.

Elément : Option
Le sous-élément  Option est utilisé dans un élément Agent afin de définir des données de configuration arbitraires qui sont transférées à l'agent lorsque celui-ci s'enregistre auprès du contrôleur d'agent.  L'agent peut ou non interpréter ces informations.

Utilisé par : Agent

Attributs :

nom
chaîne arbitraire permettant de nommer l'option (c'est-à-dire l'espace de nom)
type,
chaîne arbitraire permettant de nommer le type de l'option (c'est-à-dire le nom de l'option)
value
valeur de chaîne arbitraire de l'option

Exemple de fichier 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>
 

Référence connexe

Présentation de la configuration de l'agent et du contrôleur d'agent


Copyright (C) 2006 Intel Corporation.