Création d'un composant personnalisé

L'adaptateur de journal générique fournit un certain nombre de composants prédéfinis qui peuvent être utilisés pour créer des adaptateurs en vue de traiter des fichiers journaux d'application. Si ces composants ne répondent pas à vos besoins, l'adaptateur de journal générique peut être étendu en créant des composants personnalisés qui peuvent être inclus dans le contexte d'un fichier de configuration d'adaptateur.

Dans créer un composant personnalisé, procédez comme suit :

Extraction du code source de l'adaptateur de journal générique

Si vous souhaitez référencer le code source de l'adaptateur de journal générique pendant que vous développez votre propre composant d'adaptateur de journal générique, consultez le projet de plug-in org.eclipse.hyades.logging.adapter qui se trouve dans le référentiel Eclipse CVS. Pour cela :

Création d'une classe Java

Vous devez créer une classe Java qui contienne le code de votre nouveau composant :

  1. Créez un projet de plug-in pour contenir le nouveau composant.
  2. Créez une classe Java dans votre projet. En fonction du rôle que le nouveau composant jouera, il doit implémenter l'une des interfaces suivantes définies dans le package org.eclipse.hyades.logging.adapter :
    IProcessUnit
    étend IComponent avec les méthodes permettant de traiter le composant. Des matrices d'objets sont passées entre les composants afin que la principale méthode de traitement, processEventItems, prenne une matrice d'objets comme entrée et renvoie une matrice d'objets. Tous les composants doivent implémenter IProcessUnit. IComponent contient les méthodes d'accesseurs en consultation et en modification pour toutes les propriétés de composant, une méthode de mise à jour permettant d'obtenir les propriétés de composant de la configuration et des méthodes permettant de démarrer et d'arrêter le composant.
    ISensor
    étend IProcessUnit. A utiliser lors de l'implémentation d'un composant détecteur. La méthode getNext renvoie le paquet de données suivant à partir de la source détectée. La méthode de vidage vide les éventuelles données restantes dans la source qui a été mise en cache par le détecteur. L'interface contient aussi un accesseur en consultation et un accesseur en modification pour le type de détecteur défini dans le fichier de schéma de détecteur sensor.xsd.
    IExtractor
    étend IProcessUnit. A utiliser lors de l'implémentation d'un composant extracteur. Comme un détecteur renvoie généralement les données sous la forme de chaînes à l'extracteur et comme l'extracteur extrait des messages complets à partir de ces chaînes, un extracteur doit implémenter une méthode processStrings qui prenne comme entrée une matrice de chaînes et renvoie une matrice d'objets MessageString. La classe MessageString est aussi définie dans le package org.eclipse.hyades.logging.adapter.
    IParser
    étend IProcessUnit. A utiliser lors de l'implémentation d'un composant d'analyseur syntaxique.
    IFormatter
    étend IProcessUnit. A utiliser lors de l'implémentation d'un composant formateur.
    IOutputter
    étend IProcessUnit. A utiliser lors de l'implémentation d'un composant outputter.

    Une autre possibilité de création d'une nouvelle classe de composants consiste à étendre les classes d'implémentation par défaut pour IComponent, IProcessUnit, ISensor et IExtractor dans le package org.eclipse.hyades.logging.adapter.impl. Le projet org.eclipse.hyades.logging.adapter contient des exemples des composants des packages de composants associés.

  3. Une fois que vous avez terminé le code, enregistrez les modifications.

Ajout de dépendances de plug-ins

Comme vous étendez les classes d'adaptateur de journal générique, vous devez inclure le plug-in d'adaptateur de journal générique et ses dépendances dans votre plug-in.

  1. Ouvrez le fichier plugin.xml et ajoutez les dépendances suivantes :
    org.eclipse.hyades.logging.adapter
    org.eclipse.hyades.logging.core

Configuration du plug-in comme une extension

Pour configurer votre plug-in comme une extension de composant de l'adaptateur de journal générique :

  1. Ajoutez l'extension suivante au fichier plugin.xml :
    <extension 
       point="org.eclipse.hyades.logging.adapter.adapterComponent"> 
      <componentClassname 
            name="executable_class_name"> 
      </componentClassname> 
    </extension> 
    où executable_class_name est le nom de la classe Java que vous avez créée pour implémenter votre nouveau composant d'adaptateur de journal générique.
  2. Enregistrez le fichier plugin.xml.

 

Tâches connexes
Test du composant personnalisé