Création d'une classe de fabrique de fournisseur de texte

Une fabrique de fournisseur de texte permet de fournir plusieurs fournisseurs de texte pouvant être utilisés dans des formulaires d'objet de contenu Web. Un fournisseur de texte permet par exemple de localiser les libellés de zone ou le texte d'aide d'un modèle de création afin que les utilisateurs puissent visualiser ces libellés ou ce texte d'aide dans leur langue. Une fabrique de fournisseur de texte peut permettre de rendre disponibles plusieurs fournisseurs de texte de ce type.

Pourquoi et quand exécuter cette tâche

Pour utiliser une fabrique de fournisseur de texte, vous devez créer une classe de fabrique de fournisseur de texte, puis enregistrer la fabrique de fournisseur de texte 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.plugin.textprovider.TextProviderFactory. Cette classe peut implémenter les méthodes suivantes :
    public String getProviderName()
    Cette méthode renvoie le nom unique de la fabrique de fournisseur de texte.
    public List<TextProvider> getTextProviders()
    Cette méthode renvoie la liste des fournisseurs de texte fournis par cette fabrique.
    public Collection<String> getTextProvider(String p_providerName)
    Cette méthode renvoie les fournisseurs de texte dans la fabrique avec le nom indiqué.
    public boolean isShownInAuthoringUI()
    Cette méthode vous permet de faire en sorte que le fournisseur de texte de votre fabrique de fournisseur de texte n'apparaisse pas dans l'interface utilisateur de création.

    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. 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 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, vous devez inclure le fichier plugin.xml à la racine de ce fichier JAR.
    <?xml version="1.0" encoding="UTF-8"?>
<plugin id="com.acme"
       name="Sample text provider factory"
       version="1.0.0"
       provider-name="IBM">
       
 <extension
    point="com.ibm.workplace.wcm.api.TextProviderFactory"
    id="SampleTextProviderFactory">
    <provider class="com.acme.SampleTextproviderFactory"/>
 </extension>

</plugin>

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.TextProvider.
  • Spécifiez 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 dont le nom et l'ID sont identiques à ceux d'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.
Sorting conventions :

Lorsqu'un tri est appliqué à un ensemble d'objets, le titre de l'objet est utilisé pour trier les objets et non le titre spécifié dans la fabrique de fournisseur de texte.