Desplegar el proyecto de plug-in del analizador de anotaciones

Requisitos previos

Después de crear un proyecto de plug-in para que contenga los artefactos para un analizador de anotaciones, debe configurar el plug-in para que lo pueda utilizar el Analizador de anotaciones y rastreo. Siga los pasos que se indican a continuación:

  1. Añadir dependencias de plug-in al archivo de manifiesto del plug-in
  2. Añadir un punto de extensión para el analizador de anotaciones al archivo de manifiesto del plug-in
  3. Añadir un punto de extensión para analizadores estáticos
  4. Crear una clase de analizador ajustador
  5. Verificar los valores de plug-in del analizador de anotaciones
  6. Empaquetar el analizador de anotaciones
  7. Desplegar el analizador de anotaciones

1. Añadir dependencias de plug-in

Se deben incluir las dependencias de plug-in siguientes al archivo de manifiesto de plug-in. Abra el archivo plugin.xml en un editor de texto. Localice el elemento necesario en el archivo y añada las dependencias de plug-in al mismo. Por ejemplo:

   
<import plugin="org.eclipse.core.runtime"/>
<requires>
<import plugin="org.eclipse.hyades.logging.adapter"/>
<import plugin="org.eclipse.hyades.logging.parsers"/>
<import plugin="org.eclipse.hyades.logging.adapter.config"/>
</requires>

Nota: Los plug-ins necesarios especificados más arriba se deben situar en el directorio de plug-ins de Eclipse, o bien, se deben incluir en el espacio de trabajo actual.


2. Añadir un punto de extensión de analizador de anotaciones

Debe definir un punto de extensión para cada tipo de archivo de anotaciones de aplicación que desea analizar e importar al Analizador de anotaciones y rastreo. Más abajo se muestra un punto de extensión de ejemplo para la aplicación MyApp con un adaptador de reglas y un adaptador estático definidos:

 <extension
         point="org.eclipse.hyades.logging.parsers.logParser">
	      <parser
            name="Sample Rules Adapter for MyApp"
            icon=""
            description="%STR_MYAPP_PARSER_DESCRIPTION"
            class="RulesParser.StaticParserExtension"
            ui_name="MyApp myapp.log file"
            id="org.eclipse.hyades.logging.parsers.MyAppLogParser">
         <field
               useBrowse="true"
               defaultValue="d:\temp\sample.log"
               name="Directory"
               helpContextId=""
               tooltip="%STR_MYAPP_TOOLTIP1"
               id="file_path"
               browseType="*.log">
         </field>
         <field
               useBrowse="false"
               defaultValue="MyApp 1.0(rules), MyApp 1.0(static)"
               name="Supported versions"
               helpContextId=""
               tooltip="%STR_MYAPP_TOOLTIP2"
               ui_type="combobox"
               id="version">
         </field>
         <parserParameter
               name="MyApp 1.0(rules)"
               value="./MyAdapter/myadapter.adapter">
    </parserParameter>
	<parserParameter
               name="MyApp 1.0(static)"
               value="./MyAdapter/mystaticadapter.adapter">
         </parserParameter>

      </parser>
   </extension>

Para personalizar el punto de extensión para el analizador de anotaciones, debe realizar algunas actualizaciones:

  1. Reemplace RulesParser de este punto de extensión por el nombre del plug-in que ha creado para el proyecto de plug-in del analizador de anotaciones.
  2. Reemplace MyAdapter de este punto de extensión por el nombre de la carpeta del plug-in que contiene los archivos del adaptador.
  3. La etiqueta <parser> especifica información de alto nivel para el analizador y es un elemento obligatorio. Reemplace los atributos siguientes:
  4. La primera etiqueta <field> define el campo UI para seleccionar la ubicación del archivo de anotaciones. Es un elemento obligatorio. Reemplace los atributos siguientes:
  5. La segunda etiqueta <field> define el cuadro combinado de UI para seleccionar la versión del archivo de anotaciones que se va a importar. Es un elemento obligatorio. Reemplace los atributos siguientes:
  6. La etiqueta <parserParameter> define el archivo de configuración del adaptador que se debe utilizar para cada una de las versiones de archivo de anotaciones para las que se ofrece soporte. Reemplace los atributos siguientes:
Sugerencia: Se debe definir un Default en caso de que no se pueda encontrar una coincidencia para una versión. Si únicamente tiene un archivo de configuración del adaptador, sólo necesita disponer del Default parserParameter. Por ejemplo:
<parserParameter
   name="Default"
   value="./MyAdapter/myadapter.adapter">
</parserParameter>

Los campos especificados más arriba crean una opción para myapp.log de MyApp en el asistente de Importar anotaciones, tal como se muestra más abajo:

Asistente de Importar anotaciones mostrando myapp.log de myapp como opción que importar

Puede utilizar un archivo plugin.properties para definir determinadas propiedades en el archivo plugin.xml por si necesita tener versiones diferentes. Por ejemplo, si hay cadenas de caracteres de texto que se van a incluir en el asistente de Importar archivo de anotaciones, y que se deben traducir a diferentes idiomas, se pueden definir en el archivo plugin.properties e incluir archivos de propiedades diferentes para los idiomas para los que desea ofrecer soporte. En el archivo plugin.properties puede definir las variables de sustitución que se pueden utilizar en el archivo plugin.xml. El archivo plugin.properties para el archivo plugin.xml anterior podría ser similar al siguiente:


# Propiedades para el plug-in RulesParser

pluginName = RulesParser
providerName = MyCompany

# Mensajes de punto de extensión de logParser:
STR_MYAPP_PARSER_DESCRIPTION = Analizador de reglas de MyApp v1.0
STR_MYAPP_TOOLTIP1           = Especifique la ubicación del archivo de anotaciones
STR_MYAPP_TOOLTIP2           = Seleccione la versión del archivo de anotaciones que importar

Sugerencia: Una aplicación puede escribir datos en el archivo de anotaciones en diferentes idiomas, dependiendo del entorno local en el que se ejecute. Las clases de analizador estático o las reglas de las expresiones regulares se escriben para analizar un archivo de anotaciones en un solo idioma. Por este motivo, para ofrecer soporte para un tipo de archivo de anotaciones que se pueda escribir en varios idiomas, se debe crear un archivo de adaptador de analizador estático separado o un archivo de adaptador de reglas para cada idioma. A continuación, en el punto de extensión logParser para el tipo de archivo de anotaciones, se debe añadir una etiqueta parserParameter para cada archivo de adaptador especificando el idioma al que se aplica en el campo de nombre. No olvide añadir los valores de nombre de parserParameter a la lista en el atributo defaultValue del campo de versión. De este modo, al importar el archivo de anotaciones, el usuario puede elegir el idioma correcto del archivo de anotaciones.

Por ejemplo, se pueden añadir los parámetros de analizador siguientes al punto de extensión logParser para ofrecer soporte para la importación de anotaciones en inglés, francés y alemán:

	         <parserParameter
	         	name="MyApp 1.0(rules) English"
	         	value="./MyAdapter/myadapter_en.adapter"/>
	         <parserParameter
	         	name="MyApp 1.0(rules) French"
	         	value="./MyAdapter/myadapter_fr.adapter"/>
	         <parserParameter
	         	name="MyApp 1.0(rules) German"
	         	value="./MyAdapter/myadapter_de.adapter"/>

3. Añadir un punto de extensión para analizadores estáticos

Este paso es obligatorio si se crea un analizador estático.

Para analizadores estáticos, la clase de analizador estático que se crea se debe especificar en el plugin.xml por medio de una extensión staticParser. Este punto de extensión permite que se pueda localizar la clase cuando se utiliza para analizar un archivo en el localice la clase en el caso de Importación de anotaciones.
Añada el punto de extensión siguiente:

<extension
  point="org.eclipse.hyades.logging.adapter.config.staticParser">
  <parserClassname
    name="myLogParser33.MyStaticParser">
  </parserClassname>
</extension>

Reemplace myLogParser33.MyStaticParser por el nombre de clase de analizador Java.

4. Crear una clase de ajustador para el analizador

Cree una clase de ajustador estático que amplíe org.eclipse.hyades.logging.adapter.config.StaticParserWrapper. Utilizan esta clase los analizadores estáticos y los analizadores basados en reglas para ejecutar el archivo de configuración del adaptador asociado a la versión que selecciona el usuario en el asistente de Importación de anotaciones, utilizando el tiempo de ejecución del Adaptador de anotaciones genérico.

/*
 * Created on Apr 12, 2004
 * StaticParserExtension class created to be used in RulesParser Plug-in
 */
package RulesParser;

import org.eclipse.hyades.logging.adapter.config.StaticParserWrapper;

/**
 * @author developer
 * StaticParserExtension class
 */
public class StaticParserExtension extends StaticParserWrapper {
	public StaticParserExtension(){
		super();
		currentPlugin="RulesParser";
	}
}

5. Verificar los valores de plug-in del analizador de anotaciones

Para verificar si ha configurado correctamente el archivo de manifiesto del plug-in, puede ejecutar el proyecto de plug-in en una nueva área de trabajo de tiempo de ejecución. Siga los pasos que se indican a continuación:

  1. Conmute a la perspectiva Plug-in seleccionando Ventana > Abrir perspectiva > Otra > Desarrollo de plug-ins.
  2. En la perspectiva Desarrollo de plug-ins, seleccione el proyecto de plug-in.
  3. En la barra de herramientas, seleccione Ejecutar > Ejecutar como > Área de trabajo de tiempo de ejecución.
  4. En la nueva área de trabajo, seleccione Archivo > Importar en el menú.
  5. En el asistente de Importar, seleccione Archivo de anotaciones y, a continuación, pulse Siguiente.
  6. En la página Archivos de anotaciones, pulse Añadir para agregar un archivo de anotaciones. En la ventana Añadir archivo de anotaciones, verifique si el nuevo tipo de archivo de anotaciones está incluido en la lista Archivos de anotaciones seleccionados.
  7. Seleccione el tipo de archivo de anotaciones. Verifique si todos los campos y el texto de la pestaña Detalles son correctos.
  8. Especifique el valor para la ubicación del archivo de anotaciones.
  9. Pulse Aceptar.
  10. Pulse Finalizar para importar el archivo de anotaciones del nuevo tipo de archivo de anotaciones. Verifique si los registros del archivo de anotaciones se muestran en la vista Anotaciones.
    Sugerencia: Si no se muestra ningún registro de archivo de anotaciones en la vista Anotaciones, verifique si el componente Productor del archivo de configuración del adaptador del analizador está configurado con la clase de ejecución org.eclipse.hyades.logging.adapter.config.outputters.StaticParserOutputter.

6. Empaquetar y desplegar el plug-in del analizador de anotaciones

Despliegue local

Para desplegar el plug-in del analizador de anotaciones en un área de trabajo Eclipse, debe empaquetar los archivos de plug-in exportándolos a un archivo zip. Siga los pasos que se indican a continuación:

  1. Abra el archivo plugin.xml con el editor de Manifiestos de plug-in.
  2. Seleccione la pestaña Tiempo de ejecución y verifique si se ha incluido un archivo jar para las clases de plug-in en la lista Bibliotecas de tiempo de ejecución. Si no hay ningún archivo jar en la lista, añada uno pulsando el botón Nuevo... y especificando un nombre adecuado.
  3. Seleccione la pestaña Construir y marque las carpetas y los archivos apropiados en la lista Construcción binaria que se va a incluir en el plug-in exportado. Por ejemplo, marque plugin.xml, plugin.properties y los archivos de configuración del adaptador del analizador. Guarde los cambios del archivo plugin.xml.
  4. Exporte los archivos de plug-in seleccionando Archivo > Exportar.
  5. En el asistente de Exportar, seleccione > Plug-ins y fragmentos desplegables.
  6. Pulse Siguiente.
  7. En la página Exportar plug-ins y fragmentos, seleccione el plug-in en la lista Plug-ins y fragmentos disponibles y marque el recuadro de selección correspondiente.
  8. Seleccione el despliegue como un solo archivo ZIP en el campo Opciones de exportación.
  9. Especifique el Nombre de archivo de destino para el archivo zip.
  10. Pulse Finalizar.

Despliegue remoto

Para desplegar el analizador de anotaciones en un sistema principal remoto con el fin de poder importar archivos de anotaciones desde dicho sistema, debe crear un archivo de configuración de plug-in del controlador de agentes para el analizador de anotaciones. Siga los pasos que se indican a continuación:
  1. Abra el archivo plugin.xml con el editor de Manifiestos de plug-in.
  2. Seleccione la pestaña Tiempo de ejecución y verifique si se ha incluido un archivo jar para las clases de plug-in en la lista Bibliotecas de tiempo de ejecución. Si no hay ningún archivo jar en la lista, añada uno pulsando el botón Nuevo... y especificando un nombre adecuado.
  3. Cree una carpeta en el plug-in del analizador de anotaciones con el nombre de config.
  4. Cree un archivo denominado pluginconfig.xml en la carpeta config. Por ejemplo:

    <?xml version="1.0" encoding="UTF-8"?>
    <PluginConfiguration requires="org.eclipse.hyades.logging.parsers">
        <Application configuration="default" 
            executable="RemoteLogParserLoader"
            extends="default"
            location=="%SYS_TEMP_DIR%"
            path="%JAVA_PATH%">
            <Variable name="CLASSPATH" 
                position="prepend"
                value="%RASERVER_HOME%\plugins\RulesParser_1.0.0\parsers.jar"/>
            <Variable name="GLA_CONFIG_PATH" position="prepend" value="%RASERVER_HOME%\plugins\RulesParser_1.0.0"/>
            <Parameter position="append" value=""config_path=%GLA_CONFIG_PATH%""/>
        </Application>
    <Option name="RulesParser" type="version" value="1.0.0"/>
    </PluginConfiguration>
    

  5. Reemplace RulesParser por el nombre del proyecto de plug-in del analizador de anotaciones.
  6. Abra el archivo plugin.xml con el editor de Manifiestos de plug-in.
  7. Seleccione la pestaña Construir y marque las carpetas y los archivos apropiados en la lista Construcción binaria que se va a incluir en el plug-in exportado. Por ejemplo, marque los archivos plugin.xml, plugin.properties, el archivo de configuración del adaptador del analizador y el archivo pluginconfig.xml que acaba de crear. Guarde los cambios del archivo plugin.xml.
  8. Exporte los archivos de plug-in seleccionando Archivo > Exportar.
  9. En el asistente de Exportar, seleccione > Plug-ins y fragmentos desplegables.
  10. Pulse Siguiente.
  11. En la página Exportar plug-ins y fragmentos, seleccione el plug-in en la lista Plug-ins y fragmentos disponibles y marque el recuadro de selección correspondiente.
  12. Seleccione el despliegue como un solo archivo ZIP en el campo Opciones de exportación.
  13. Especifique el Nombre de archivo de destino para el archivo zip.
  14. Pulse Finalizar.

7. Desplegar el analizador de anotaciones

Puede desplegar el plug-in del analizador de anotaciones descomprimiendo el archivo zip que acaba de crear en el directorio eclipse de una instalación de Eclipse. Ahora ya está preparado para probar el plug-in del analizador de anotaciones recién creado utilizando el Analizador de anotaciones y rastreo.

Para desplegar el plug-in del analizador de anotaciones en un sistema remoto a fin de que se pueda importar de modo remoto un archivo de anotaciones, descomprima el archivo zip que acaba de crear en el directorio de instalación del controlador de agentes del sistema remoto. Reinicie el controlador de agentes.

 

Conceptos relacionados
Especificación del formato de suceso base común

Tareas relacionadas
Crear un analizador de anotaciones
Crear un adaptador estático
Crear un adaptador basado en reglas
Probar un analizador de anotaciones
Configurar un proyecto de plug-in para un analizador de anotaciones

Consultas relacionadas
Estructura del archivo de configuración del adaptador
Editor de configuraciones de adaptador
Gramática de las expresiones regulares