El archivo pluginconfig.xml

Contenido

 

Nota

Cuando en este documento se hace referencia a las ubicaciones de archivo y directorio, <inicio-instalación> es el directorio en el que se desempaquetó Agent Controller.

Introducción

El archivo pluginconfig.xml reside en <inicio_instalación>\plugins\<nombre_plug-in>\config.  Es el mecanismo para ampliar los alias de entorno global y de aplicación definidos en serviceconfig.xml según las necesidades de aplicaciones empaquetadas individualmente. La ampliación de los valores de entorno definidos en serviceconfig.xml tiene impacto sobre todas las aplicaciones (incluyendo los agentes) lanzados por Agent Controller ya que todas heredan ese entorno.  Esto permite a un "plugin" que sus aplicaciones sean localizables para otros procesos iniciados por Agent Controller (por ejemplo, añadiendo su vía de acceso a la variable de entorno CLASSPATH.) La manera de lanzar una aplicación nueva es ampliar la lista de alias en el caso de que Agent Controller esté configurado para restringir sus servicios de lanzamiento sólo a los de la lista.

Así, pluginconfig.xml proporciona un mecanismo para empaquetar componentes de adición que son opcionales para la instalación básica de Agent Controller.  Puesto que el mismo archivo serviceconfig.xml no se modifica, la eliminación de los añadidos es igualmente sencilla.  

Es posible que los agentes necesiten un pluginconfig.xml y un agent.xml. El archivo agent.xml es necesario para definir una aplicación de agente si desea que el controlador de agente nuevo busque agentes disponibles (es decir, que sea capaz de descubrirlos.)  pluginconfig.xml es necesario si el agente necesita ampliar el entorno serviceconfig.xml o la lista de alias. La utilización del archivo agent.xml sustituirá a la utilización de pluginconfig.xml en un próximo release.

Nota

El término "plugin" utilizado aquí solo es una ligera referencia a un plug-in de Eclipse.  Surgió porque inicialmente se utilizaron verdaderos plug-in. Pero ahora es un nombre equivocado ya que el archivo de configuración puede hacer referencia a cualquier aplicación sin que se trate de un plug-in con posibilidad de instalación en el entorno de trabajo de Eclipse.

El archivo pluginconfig.xml contiene los segmentos principales siguientes:

 

Configuración de plug-in

 

La jerarquía de los elementos contenidos en el archivo pluginconfig.xml se muestra más abajo. El orden de los elementos que se muestran en el mismo nivel no es importante. Los hiperenlaces del la jerarquía enlazan con la descripción de elemento formal en la sección Elementos y atributos.


    PluginConfiguration
        AgentControllerEnvironment
            Variable
        Option
        Application
            Variable
            Parameter
        Agent
            Option

       

Elementos y atributos

 

Elemento: PluginConfiguration
Es el elemento raíz de la configuración del plug-in. Solo se permite una aparición de AgentControllerEnvironment. El resto de elementos (Option, Application, y Agent) permiten varias apariciones. Se puede omitir cualquiera de los subelementos.

Subelementos:     AgentControllerEnvironment

                            Option
                            Application
                            Agent
                           
Atributos:

requires
(opcional) Este valor de serie es una lista separada por comas de los nombres de plug-in de los que depende esta configuración. A partir de TPTP 4.0, se ha añadido un sufijo identificador de versión a los nombres de plug-in. Consta de un carácter subrayado seguido del número de versión para el release. Por ejemplo: org.eclipse.tptp.platform.agentcontroller_4.0.0. Para asegurar la compatibilidad de plug-ins para aplicaciones que tienen dependencias sobre plug-ins de releases anteriores (plug-ins que no tienen un sufijo identificador de versión), tiene la opción de especificar el nombre de plug-in para el atributo "requires" excluyendo el identificador de versión. En este caso, el cargador de configuración de Agent Controller intentará localizar primero el nombre de plug-in completo incluyendo el sufijo identificador de versión. Si no lo consigue, el cargador de configuración buscará el nombre de plug-in excluyendo el sufijo identificador de versión. Si hay más de un plug-in con el mismo nombre, se utilizará el primer nombre de plug-in devuelto por el sistema operativo.

Elemento: AgentControllerEnvironment
El elemento AgentControllerEnvironment encierra uno o varios elementos Variable que ampliarán las variables de entorno globales definidas en serviceconfig.xml. Formarán parte del entorno utilizado en el lanzamiento de todas las aplicaciones.


Utilizado por: PluginConfiguration

Subelementos:     Variable

 

Elemento: Variable

Este elemento Variable define una variable de entorno y cómo debe situarse dentro del entorno existente para formar el entorno predeterminado nuevo para todas las aplicaciones y los agentes lanzados. Puede haber cero o más de estos elementos definidos para AgentControllerEnvironment

Utilizado por: AgentControllerEnvironment

Atributos:

name
Este valor de serie especifica el nombre de la variable de entorno.
value
Este valor de serie especifica el valor de la variable de entorno.
position
(opcional) Este valor de serie puede ser "append", "prepend" o "replace", lo que indica dónde colocar este entorno relativo al entorno predeterminado existente.

Elemento: Option
Se utiliza un Option como elemento superior de PluginConfiguration para especificar datos de configuración arbitrarios que se pasarán a cada agente que se registre a sí mismo con Agent Controller. Esta información se incluye en la información de propiedad devuelta para cada agente a un cliente. El agente puede interpretar esta información (o no) como convenga. La información de Option sólo se da a los agentes que utilizan la API original (capas de compatibilidad retroactiva) de Agent Controller. Utilice el archivo de configuración agent.xml para proporcionar información de configuración a un agente utilizando la API nueva.

Utilizado por: Agent

Atributos:

name
Este valor de serie especifica el espacio de nombres para la opción.
type
Este valor de serie especifica el nombre de la opción.
value
Esta serie especifica el valor de la opción.
Elemento: Application
El elemento Application define o amplía un nombre de alias y una información de lanzamiento para una aplicación. Puede incluir valores de entorno que solo son visibles para esta aplicación cuando se lanza. Este alias de aplicación se añade a la lista definida en el elemento ApplicationAliases de serviceconfig.xml.


Utilizado por: PluginConfiguration

Subelementos:     Variable

                            Parameter

Atributos:

executable
Este valor de serie especifica el nombre de alias para el ejecutable de la aplicación especificado en el atributo path. Los clientes deben utilizar este nombre para identificar esta aplicación. Si también se especifica el atributo extends, el nombre dado aquí debe coincidir con un alias definido anteriormente. 
path
Este valor de serie especifica el nombre de vía de acceso completo de la aplicación a lanzar. Esto se utiliza en lugar del nombre de alias al lanzar el ejecutable de la aplicación.
El atributo se ignora si se especifica el atributo extends
location
(opcional) Este valor de serie especifica el directo desde el que se lanzará el ejecutable, denominado algunas veces como directorio de trabajo del ejecutable mientras se está ejecutando.
extends
(opcional) Este valor de serie especifica el nombre de configuración para un alias de aplicación definido anteriormente. Sin embargo, los nombres de configuración no están soportados por lo que el valor de este atributo debe establecerse en "default". Si extends está presente (independientemente del valor), indica que la información contenida en esta aplicación debe ampliar la información de lanzamiento definida anteriormente en el alias de aplicación coincidente. No está permitido cambiar el valor path (es decir, el ejecutable lanzado.) Si no se encuentra ninguna coincidencia con el ejecutable, este elemento Application no surte efecto.

Elemento: Variable
Este elemento Variable define una variable de entorno y cómo debe situarse dentro del entorno existente cuando se lanza la aplicación. Puede haber cero o más de estos elementos definidos para una Application.

Utilizado por: Application

Atributos:

name
Este valor de serie especifica el nombre de la variable de entorno.
value
Este valor de serie especifica el valor de la variable de entorno.
position
(opcional) Este valor de serie puede ser "append", "prepend" o "replace", lo que indica dónde colocar este entorno relativo al entorno predeterminado.

Elemento: Parameter

El elemento Parameter define un argumento de línea de mandatos para pasarlo a la aplicación en el lanzamiento. Puede haber cero o más de estos elementos definidos para una Application.

Utilizado por: Application

Atributos:

value
Este valor de serie especifica un argumento de línea de mandatos.
position
(opcional) Este valor de serie puede ser "append", "prepend" o "replace", lo que indica dónde poner este argumento en relación a los argumentos de línea de mandatos existentes.

Elemento: Agent
Proporciona información de configuración para un agente determinado. Solo lo utilizan agentes que utilizan la API original (capas de compatibilidad retroactiva) de Agent Controller. Utilice el archivo de configuración agent.xml para proporcionar información de configuración a un agente utilizando la API nueva.

Utilizado por: PluginConfiguration

Subelementos:     Option

Atributos:

name
Este valor de serie especifica el nombre del agente al que debe aplicarse esta información de configuración.
type
(opcional) Este valor de serie especifica un tipo de agente.
dataChannelSize
(opcional) Este valor de serie especifica la cantidad de memoria compartida a asignar para la comunicación interprocesos. Los valores toman la forma de un entero positivo con el sufjo M o K para indicar Megabytes o Kilobytes respectivamente o sin sufijo, lo que indica bytes. Valores de ejemplo: "16M", "8K" o "16000".
logFile
(opcional) Esta serie especifica un nombre de vía de acceso totalmente calificado de un archivo. Si se especifica, los datos que normalmente irían a través del canal de datos al cliente se escribirán en este archivo.
client
(opcional) Esta serie especifica si este agente está interactuando con un cliente. Los valores posibles son "DYNAMIC" o "HEADLESS".   HEADLESS indica que no hay ningún cliente asociado. El valor predeterminado es DYNAMIC.
extends
(opcional) Este valor de serie especifica el nombre de configuración para un agente definido anteriormente. Sin embargo, los nombres de configuración no están soportado por lo que el valor de este atributo debe establecerse en "default". Si extends está presente (independientemente del valor), indica que la información contenida en este agente debe ampliar la información de configuración definida previamente en el elemento de agente coincidente. Se utiliza para ampliar la lista de Opciones asociadas a un agente determinado.

Elemento: Option
Un subelemento Option dentro de un elemento Agent se utiliza para especificar los datos de configuración arbitrarios que se pasarán al agente cuando se registra a sí mismo con Agent Controller. El agente puede interpretar esta información (o no) como convenga.

Utilizado por: Agent

Atributos:

name
una serie arbitraria que denomina la opción (es decir, espacio de nombres)
type
una serie arbitraria que denomina el tipo de opción (es decir, nombre de opción)
value
un valor de serie arbitrario para la opción

Archivo de ejemplo 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>
 

Consulta relacionada

Visión general de configuración de agentes y de Agent Controller


Copyright (C) 2006 Intel Corporation.