Création d'une classe de processeur de contexte

Lorsqu'il est configuré, le plug-in de processeur de contexte est démarré par le portlet d'affichage de contenu Web avant de s'afficher. Il permet de modifier le contexte en cours, par exemple l'élément à afficher.

Pourquoi et quand exécuter cette tâche

Pour créer un plug-in de processeur de contexte, vous devez créer une classe de processeur de contexte, puis enregistrer cette dernière en la déployant sur le serveur et en la sélectionnant à partir du portlet d'affichage de contenu Web.

Procédure

  1. Créez une classe Java qui implémente l'interface com.ibm.workplace.wcm.api.ContextProcessor. Cette classe doit implémenter la méthode suivante :
    /**
    * Processes the supplied <i>ContextProcessorParams</i> and updates parameters within
    * as necessary
    * 
    * @param p_currentSession The current Http Session
    * @param p_contextProcessorParams The editable <i>ContextProcessorParams</i> object 
    */
   public void process(HttpSession p_currentSession, ContextProcessorParams p_contextProcessorParams);

    Consultez la documentation Javadoc pour plus d'informations. The Javadoc files for Web Content Manager are in the PortalServer_root/doc/Javadoc/spi_docs/com/ibm/workplace/wcm directory.

  2. Implémentez la méthode de traitement. Cette méthode contient le code qui est exécuté lorsque le plug-in est démarré afin de vous permettre de modifier le contexte en cours à l'aide de l'objet ContextProcessorParams avant qu'il ne soit affiché.
  3. Un fichier plugin.xml est requis, que le déploiement soit effectué via un fichier WAR, EAR ou JAR. Si vous effectuez un déploiement via une application dans un fichier WAR ou EAR, ajoutez le fichier plugin.xml au dossier "WEB-INF" de l'application. Lorsque vous utilisez un fichier JAR, ajoutez le fichier plugin.xml à la racine du fichier JAR.
    <?xml version="1.0" encoding="UTF-8"?>
<plugin id="SampleContextProcessorPluginId" 
name="SampleContextProcessor" provider-name="IBM" version="1.0.0">
    <extension point="com.ibm.workplace.wcm.api.ContextProcessor" 
    id="SampleContextProcessorPlugin" >
        <processor class="com.acme.SampleContextProcessor"/>
    </extension>
</plugin>
  4. Editez les paramètres du portlet de l'afficheur de contenu Web que vous souhaitez associer à votre processeur de contexte :
    1. Allez à la vue "Configuration" ou "Editer les paramètres partagés" d'un portlet d'afficheur de contenu Web.
    2. Accédez à Options avancées > Plug-ins
    3. Sélectionnez un plug-in de processeur de contexte.

Que faire ensuite

  • Chaque plug-in est représenté par une balise <extension></extension> unique.
  • La valeur de l'attribut de point doit être "com.ibm.workplace.wcm.api.ContextProcessor".
  • Entrez l'ID de votre choix.
  • Indiquez la classe de fournisseur associée à votre plug-in.
Naming conventions :
Si vous créez une application de plug-in associée aux mêmes nom et ID qu'un plug-in existant, le nouveau plug-in risque de remplacer le premier. Lorsque vous créez des applications de plug-in, vérifiez que les éléments suivants sont uniques sur votre système :
  • L'ID de plug-in, le nom de plug-in et l'extension de plug du fichier plugin.xml.
  • Le nom de classe qualifié complet et le chemin de toutes les classes dans l'application.
  • le chemin d'accès aux fichiers de l'application.