Création d'une classe d'abonné

Un plug-in d'abonné permet d'exécuter des fonctions supplémentaires sur l'abonné afin de déterminer si l'abonné est prêt pour la syndication lorsqu'un événement de syndication est démarré.

Pourquoi et quand exécuter cette tâche

Pour créer un plug-in d'abonné, vous devez créer une classe d'abonné, puis l'enregistrer en la déployant sur le serveur.

Procédure

  1. Créez une classe java qui implémente l'interface com.ibm.workplace.wcm.api.extensions.syndication.SubscriberReady. Cette classe peut implémenter les méthodes suivantes :
    public ResultDirective onSubscriberReady(SubscriberEvent eventInfo)
    • Cette méthode contient le code qui est exécuté lorsque l'exécution de la syndication commence.
    • Cette méthode est exécutée sur l'abonné.
    • Les extensions sont exécutées uniquement s'il existe des modifications sur le syndicateur.
    • L'extension n'est pas exécutée à chaque fois que la syndication automatique place le syndicateur en file d'attente.

    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 onSubscriberReady. Cette méthode doit renvoyer un objet com.ibm.workplace.wcm.api.extensions.syndication.ResultDirective pour indiquer si le moteur de syndication doit continuer ou arrêter le processus de syndication.
  3. Un fichier plugin.xml est requis, que le déploiement soit effectué via un fichier WAR, EAR ou JAR. Si vous effectuez le déploiement à l'aide d'une application dans un fichier WAR ou EAR, vous devez inclure le fichier plugin.xml dans le dossier WEB-INF de l'application. Lorsque vous utilisez un fichier JAR, vous devez inclure le fichier plugin.xml à la racine de ce fichier JAR.
    <?xml version="1.0" encoding="UTF-8"?>
<plugin id="com.ibm.workplace.wcm.sample.subscriberready"
        name="Sample Subscriber Ready Extension"
        version="1.0.0"
        provider-name="IBM">        
  <extension
     point="com.ibm.workplace.wcm.api.SubscriberReady"
     id="SubscriberReadyExtension" >
     <provider class="com.ibm.workplace.wcm.sample.subscriberready.SubscriberReadyExtension"/>
  </extension> 
</plugin>

Que faire ensuite

  • L'ID de chaque plug-in doit être unique.
  • Vous devez remplacer l'ID plug-in spécifié dans cet exemple, com.ibm.workplace.wcm.sample.subscriberready, par un ID différent pour chaque extension SubscriberReady que vous créez.
  • Chaque extension SubscriberReady est représentée par une balise <extension></extension> unique.
  • La valeur de l'attribut de point doit être com.ibm.workplace.wcm.api.SubscriberReady.
  • Entrez l'ID de votre choix.
  • Spécifiez la classe de fournisseur pour votre extension SubscriberReady.
Naming conventions :
Si vous créez une application de plug-in dont le nom et l'ID est identique à un plug-in existant, le nouveau plug-in peut 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 plug-in, le nom de plug-in et l'ID extension 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.