Fichiers de configuration du contrôleur d'agent
La configuration du contrôleur d'agent est définie par deux jeux de fichiers de configuration.
Le premier jeu est la configuration de base qui décrit les paramètres par défaut du moteur.
Le deuxième est la configuration du plug-in qui décrit les paramètres spécifiques à l'application
du moteur.
Le présent document décrit de manière détaillée chaque configuration et indique comment rédiger des extensions de configuration.
Le répertoire <répertoire d'installation> indiqué dans ce document correspond au chemin dans lequel se trouvent les fichiers du contrôleur d'agent. Dans les fichiers de configuration %RASERVER_HOME% fait également référence à ce répertoire.
Configuration de base
La configuration de base est définie dans le fichier <répertoire d'installation>/config/serviceconfig.xml généré à l'aide du schéma XML <répertoire d'installation>/config/serviceconfig.xsd.
Ce fichier définit les paramètres par défaut, tels que les variables d'environnement système, les configurations d'applications et la connectivité du contrôleur d'agent. La configuration de base sera disponible pour toutes les configurations et est chargée lors du démarrage du service du moteur. Les développeurs d'application ne doivent pas modifier ce fichier de configuration de base car toute modification effectuée dans la configuration de base sera globale. Les configurations de plug-in (décrites ci-dessous) doivent être utilisées pour spécifier les paramètres spécifiques à l'application et au plug-in.
Configuration du plug-in
Chaque application définie par l'utilisateur doit disposer de son propre fichier de configuration et de dépendances se trouvant dans le répertoire du plug-in <répertoire d'installation>/plugin/<nom du plug-in> où <nom du plug-in> correspond à un nom unique qui identifie l'application. Le fichier de configuration du plug-in pluginconfig.xml doit se trouver dans le sous-répertoire config du répertoire du plug-in.
Généralement, les fichiers JAR se trouvent dans le sous-répertoire lib du répertoire du plug-in.
Les développeurs peuvent utiliser le schéma XML <répertoire d'installation>/config/pluginconfig.xsd
afin de créer plus facilement le fichier de configuration du plug-in.
Eléments et attributs
Elément : AgentControllerConfiguration
Elément principal de la configuration de base. Les paramètres permettent de démarrer le service du moteur.
Utilisé par : Configuration de base
Sous-éléments : AgentControllerEnvironment, Application, Hosts, Service, Agent, Option, Plugin
Attributs :
- activeConfiguration
- Indique la configuration à charger lors du démarrage du moteur
- filePort
- Indique le port mis à l'écoute par le service de transfert de fichier du contrôleur d'agent. La valeur par défaut est 10005.
- isDataMultiplexed
- Indique si des données de profilage et de consignation doivent être transmises sur le canal de contrôle du contrôleur d'agent. Par défaut, le canal de données utilise un port arbitraire pour la transmission de données et peut être bloqué si un pare-feu a été mis en place. Transférer des données sur le canal de contrôle permet à un nombre prédéfini de ports d'être ouverts pour recevoir des demandes de connexion à travers le pare-feu. Ces ports comprennent le port par défaut 10002, le port de sécurité 10003, et le port de serveur de fichiers 10005. La valeur par défaut pour cet attribut est faux.
- jvm
- Chemin complet de la bibliothèque d'exécution dynamique (jvm.dll ou libjvm.so) de la machine JVM (Java Virtual Machine)
- loggingDetail
- Active la journalisation du numéro de ligne du moteur si HIGH est indiqué
- loggingDirectory
- Répertoire dans lequel le fichier journal du moteur servicelog.log est créé
- loggingLevel
- Filtre de gravité des messages journaux
- port
- Port du moteur pour l'écoute de la connexion client non sécurisée entrante
- processPolling
- Indique si la vérification active du statut du processus est activée ou non. Cet attribut est principalement utilisé sur les systèmes Windows afin de garantir que le contrôleur d'agent est bien averti à chaque fois qu'un processus prend fin. Sa valeur par défaut est true.
- securedPort
- Port du moteur pour l'écoute de la connexion client sécurisée entrante
- version
- version du moteur
Elément : PluginConfiguration
Il s'agit de l'élément principal de la configuration du plug-in. Les paramètres sont chargés une fois la configuration de base chargée.
Utilisé par : Configuration du plug-in
Sous-éléments : AgentControllerEnvironment, Application, Service, Agent, Option
Attributs :
- requiert
- Une liste de noms de plug-ins séparés par des virgules, 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 ayant des dépendances de plug-in des versions antérieures (plug-ins n'ayant pas de suffixe identificateur de version), vous pouvez spécifier le nom du plug-in pour 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
Signet indiquant l'emplacement des variables d'environnement globales fournies par cette configuration.
Elles sont publiées sur le système et toutes les autres configurations, incluant la configuration de base peuvent y accéder.
Utilisé par : AgentControllerConfiguration, PluginConfiguration
Sous-éléments : Variable
Attributs :
- configuration
- nom de la configuration dans laquelle les variables d'environnement doivent être ajoutées
Elément : Application
Signet indiquant l'emplacement de l'environnement spécifique à l'application. Les paramètres de l'environnement sont visibles uniquement dans cette application particulière.
Utilisé par : AgentControllerConfiguration, PluginConfiguration
Sous-éléments : Variable, Parameter
Attributs :
- configuration
- nom de la configuration dans laquelle l'application doit être ajoutée
- exécutable
- nom de l'application. Les clients doivent utiliser ce nom pour identifier cette application
- chemin
- chemin complet du programme que cette application doit exécuter
- emplacement
- répertoire de travail de cette application
- étend
- nom de la configuration pour laquelle la même application est déjà définie. Ajoute les paramètres en cours dans la partie supérieure
Elément : Hosts
Signet indiquant l'emplacement des informations d'hôte. Permet au moteur de permettre ou de refuser la connexion de certains hôtes.
Utilisé par : AgentControllerConfiguration
Sous-éléments : Allow, Deny
Attributs :
configurationnom de la configuration utilisée par les informations d'hôte
Elément : Allow
Indique quels hôtes sont autorisés à se connecter au moteur.
Utilisé par : Hosts
Attributs :
- hôte
- nom ou adresse IP de l'hôte
- net
- sous-réseau
- masque
- masque de sous-réseau
Elément : Deny
Indique quels hôtes ne sont pas autorisés à se connecter au moteur.
Utilisé par : Hosts
Attributs :
- hôte
- nom ou adresse IP de l'hôte
- net
- sous-réseau
- masque
- masque de sous-réseau
Elément : Service
Indique quel module défini par l'utilisateur à charger lors du démarrage du moteur.
Utilisé par : AgentControllerConfiguration, PluginConfiguration
Sous-éléments : Option
Attributs :
- configuration
- nom de la configuration avec laquelle ce service doit être chargé
- nom
- nom du service
- chemin
- chemin complet de la bibliothèque de chargement dynamique
Elément : Agent
Indique les informations spécifiques à l'agent.
Utilisé par : AgentControllerConfiguration, PluginConfiguration
Sous-éléments : Option
Attributs :
- configuration
- nom de la configuration avec laquelle cette configuration d'agent est utilisée
- nom
- nom de l'agent
- type,
- type de l'agent
- dataChannelSize
- montant de mémoire partagée à attribuer pour les communications entre les processus
- Fichier journal
- chemin complet du fichier journal dans lequel l'agent place les messages
- client
- indique si cet agent est dynamique ou sans en-tête
Elément : Option
Permet de stocker une paire nom-valeur.
Utilisé par : AgentControllerConfiguration, PluginConfiguration, Service, Agent
Attributs :
- nom
- nom de l'option (c'est-à-dire espace de nom)
- type,
- type de l'option (c'est-à-dire nom de l'option)
- valeur
- valeur de l'option
Elément : Plugin
Indique le répertoire dans lequel rechercher des configurations de plug-in
Utilisé par : AgentControllerConfiguration
Attributs :
cheminrépertoire complet dans lequel rechercher des configurations de plug-in
Elément : Variable
Variable d'environnement.
Utilisé par : Application, AgentControllerEnvironment
Attributs :
- nom
- nom de la variable d'environnement (par exemple, CLASSPATH)
- valeur
- valeur de la variable d'environnement
- emplacement
- indique si cette valeur doit être ajoutée ou si elle doit remplacer la valeur existante
Elément : Parameter
Paramètre du programme.
Utilisé par : Application
Attributs :
- valeur
- valeur du paramètre de programme
- emplacement
- indique si ce paramètre doit être ajouté ou s'il doit remplacer le paramètre existant