Jahia CMS ET Portal Version 5.0

Transcription

1 Jahia CMS ET Portal Version 5.0 Développer un portlet JSR168 Avec Jahia CMS et Portal Version 5.0 V.1 Français Jahia Ltd Suisse 9, route des jeunes 1227 Carouge

2 p. 2/47 TERMES ET CONDITIONS D UTILISATION Copyright 2003/2004 Jahia Ltd. ( Tous droits réservés. CETTE DOCUMENTATION EST UN ÉLÉMENT DU LOGICIEL JAHIA. EN INSTALLANT JAHIA, VOUS RECONNAISSEZ ACCEPTER SANS RÉSERVE LES CONDITIONS D UTILISATION DE LA LICENCE DU LOGICIEL JAHIA (JAHIA COLLABORALITVE SOURCE LICENSE ou JCSL) POUR CONSULTER LA LICENCE : SI VOUS N ACCEPTEZ PAS LES CONDITIONS D UTILISATION, N INSTALLEZ PAS LE LOGIGIEL JAHIA SUR VOTRE ORDINATEUR. Copyright 2007 Jahia Ltd. ( Tous droits réservés.

3 p. 3/47 PREFACE JAHIA joue le rôle de portail Internet et de système de gestion de contenu destiné aux entreprises (CMS and Enterprise Portal). Entièrement écrit en Java J2EE, JAHIA tourne d'origine sur un serveur Tomcat, mais peut être utilisé avec d autres serveurs d applications comme WebSphere d'ibm. L une des caractéristiques principales de JAHIA est de permettre l intégration d applications Web appelées «portlets». Ce manuel décrit comment développer un portlet JSR168 pour JAHIA. Chapitre 1 : Introduction au développement de portlets. Ce chapitre présente les définitions et les notions importantes relatives au développement de portlets JAHIA. Chapitre 2 : Développer un portlet de base. Ce chapitre présente un exemple de portlet simple, appelé HelloWorld! Chapitre 3 : Développer un portlet avancé. Ce chapitre présente un exemple de portlet avancé. Chapitre 4 : Portlets, frameworks et ponts. Chapitre 5 : Migrer des JahiaWebApp vers des portlets. Ce chapitre présente des techniques permettant de convertir une JahiaWebApp (portlet Jahia 4) en portlet JSR168 (portlet Jahia 5). Chapitre 6 : Liens utiles. Ce chapitre présente des liens utiles pour la communauté JSR168. CONVENTIONS UTILISEES DANS CE DOCUMENT Ce document utilise les conventions suivantes : L italique est utilisé pour les : commentaires La chasse fixe est utilisée pour les : exemples de codes JAVA, HTML, JSP. Astuces et suggestions Notes Mises en garde Ce document a été rédigé pour être le plus précis possible. Cependant, de nouvelles fonctionnalités peuvent être disponibles pour les versions de JAHIA les plus récentes.

4 p. 4/47 TABLE DES MATIERES Préface...3 Table des matières...4 Chapitre 1 : Introduction au développement de portlets Définitions Norme et API JSR Jahia et portlet JSR Chapitre 2 : Développer un portlet de base Introduction Classe HelloWorldPortlet Fichier portlet.xml Fichier web.xml Déploiement Visualisation Chapitre 3 : Développer un portlet avancé Introduction Classe HelloPortlet Fichier portlet.xml Et ensuite? Chapitre 4 : Portlets, frameworks et ponts Introduction Framework Struts Framework JSF Autres ponts : PHP, PERL, etc Chapitre 5 : Migrer des JahiaWebApp vers des portlets Introduction Pont JahiaWebAppPortlet Utiliser les frameworks standard Convertir le code java et jsp Ajouter le fichier jahia.xml Chapitre 6 : Liens utiles Portlets Open Source Listes de diffusion Bibliothèques utiles... 45

5 p. 5/47 Chapitre 6 : Conclusion...46

6 p. 6/47 CHAPITRE 1 : INTRODUCTION AU DEVELOPPEMENT DE PORTLETS Ce chapitre présente différentes définitions et notions importantes relatives au développement de portlets JAHIA. 1 DEFINITIONS 1.1 CMS ET PORTAIL Les systèmes de gestion de contenu (Content Management System ou CMS) sont des outils informatiques dédiés à l édition et l organisation de textes, d'informations, de rapports et d éléments multimédia dans un système d information. Les CMS assurent les services suivants : édition commune de contenus par diverses personnes décentralisées (collaboration) mise en place de processus de gestion du contenu (workflow) impossibilité de manipulation par des personnes n en ayant pas l autorisation (sécurité) gestion des révisions (statistiques, gestion des versions) possibilité de décider quand l'information doit être publiée (planification) présentation dans le bon format (gabarits) publication sur différents sites (syndication) affichage différencié en fonction du visiteur (personnalisation) diffusion du contenu sur différents médias (omnimedia) Un portail est un CMS exclusivement orienté Internet avec des capacités d'intégration de contenus provenant de sources extérieures, dans un environnement informatique distribué (bases de données, intégration XML, XLS, etc.). En outre, les portails offrent en général aux utilisateurs finaux des fonctions simples de recherche et de publication sur le Web. Les portails peuvent être utilisés par des sociétés entières (par exemple, Jahia Solutions), ou par des départements tels que le Marketing, les Ressources humaines ou les Ventes. Les portails, sous forme de tableaux de bord interactifs personnalisés, peuvent aussi être utilisés par des utilisateurs individuels. JAHIA joue le rôle de portail Internet et de système de gestion de contenu destiné aux entreprises (CMS et Enterprise Portal).

7 p. 7/ PORTLET Les portlets sont des composants réutilisables intégrés à un portail d'entreprise. Ils permettent à un utilisateur de disposer, depuis la même fenêtre, d'un accès centralisé et convivial à différentes ressources (données, applications, sites Web, etc.), de modifier l'interface du portail selon ses besoins et de personnaliser ainsi son environnement de travail. Les portlets facilitent ainsi l accès aux informations intéressant un groupe d utilisateurs. D un point de vue technique, les portlets sont des applications qui génèrent des portions actives et dynamiques de HTML aggrégées par le portail. Illustration 1 : Exemple de pages JAHIA avec des portlets Afin de permettre l interopérabilité des différents portails, la communauté internationale Java (JCP, Java Community Process) a spécifié le comportement d un portlet pour tous les aspects qui le définissent : agrégation, personnalisation, présentation et sécurité. Le résultat de ce travail a abouti en août 2003, en donnant lieu à la spécification JSR 168 (Java Specification Request) qui définit l API de portlet, et que doivent à termes respecter tous les portails Java au monde, qu ils soient à vocation libre ou commerciale. Cette spécification est brièvement présentée au chapitre suivant. Vous retrouverez l intégralité du texte définissant la norme JSR168 à l adresse :

8 p. 8/47 JAHIA 5 intègre le portail Open Source Jetspeed 2 et est compatible avec la norme JSR168. Pour obtenir plus d informations sur Jetspeed 2, connectez-vous sur : JAHIA 5 supporte également un autre type de portlets : les JahiaWebApp. Celles-ci sont spécifiques à JAHIA et compatibles avec JAHIA 4. Pour obtenir plus d informations sur les JahiaWebApp, consultez le PDF disponible à l adresse : Dans un objectif de compatibilité totale avec la norme portlet, les versions futures de JAHIA ne supporteront pas les JahiaWebApp. Pour cette raison, nous vous conseillons de développer des portlets JSR168 et non des JahiaWebApp pour JAHIA 5, et de convertir vos JahiaWebApps en portlets JSR168 lors de la migration de JAHIA 4 vers JAHIA PREREQUIS Ce manuel suppose que vous êtes familier avec : le language Java la norme Servlet, spécialement les servlets http Apache Tomcat HTML, XML Javascript, JSP et taglib le modèle de contenu Jahia 2 NORME ET API JSR PORTAIL Un portail (JAHIA) est une application Web qui assure généralement les fonctions de personnalisation, d administration centralisée (single sign-on), d agrégation de contenu à partir de différentes sources et de prise en charge de la couche de présentation des systèmes d information. L agrégation se définit comme l action d intégrer du contenu provenant de différentes sources au sein d une même page Web. Un portail peut comporter un ensemble de portlets pour la création de contenu pour différents utilisateurs.

9 p. 9/ PORTLET Les portlets sont des composants Web réutilisables, contrôlés par un conteneur de portlet, et qui traitent des requêtes et produisent du contenu dynamique. Utilisés par les portails en tant que composants de l'interface utilisateur, les portlets fournissent une couche de présentation aux systèmes d'information. Le contenu produit par un portlet s'appelle un «fragment». Un fragment est un morceau de balisage (par exemple HTML, XHTML, WML) régi par certaines règles et qui peut être agrégé avec les fragments d autres portlets pour former un document complet. Le contenu produit par un portlet peut changer d'un utilisateur à l'autre, en fonction de ses préférences (reportez-vous à la section Concepts). Techniquement, les portlets sont des fichiers war, qui sont déployés comme des servlets. À l'instar des servlets, un portlet est défini pour le serveur d'applications à l'aide du descripteur de déploiement de servlet web.xml. Outre le descripteur de servlet, les portlets doivent aussi fournir un descripteur de déploiement de portlet (portlet.xml) afin de définir les fonctionnalités du portlet pour le serveur de portail. Le schéma ci-dessous illustre la structure d un fichier war représentant un portlet : Illustration 2 : Contenu standard d'un fichier war représentant un portlet Les informations définies dans le fichier portlet.xml comprennent des paramètres de configuration spécifiques, comme le type de balisage pris en charge par le portlet, les valeurs des paramètres d initilialisation, etc. Ces informations permettent au serveur de portail d'offrir des services au portlet. Par exemple, si un portlet enregistre une prise en charge des modes Aide et Édition (reportez-vous à la section «Concepts») dans le descripteur de déploiement de portlet, le serveur de portail affiche des icônes qui permettent à l'utilisateur d'appeler les pages d'aide et de modification du portlet.

10 p. 10/47 Voici un exemple de fichier portlet.xml : <?xml version="1.0" encoding="utf-8"?> <portlet-app> <portlet> <description>query_portlet</description> <portlet-name>query_portlet</portlet-name> <display-name>query_portlet</display-name> <portlet-class> sql.portlet.queryportlet</portlet-class> <init-param> <name>view_url</name> </value> </init-param> <init-param> <name>help_url</name> <value>/templates/help.jsp</value> </init-param> <expiration-cache>-1</expiration-cache> <supports> <mime-type>text/html</mime-type> <portlet-mode>view</portlet-mode> </supports> <supported-locale>en</supported-locale> <portlet-info> <title>query Portlet</title> <short-title>query Portlet</short-title> </portlet-info> <portlet-preferences> <preferences-validator> sql.portlet.querypreferencesvalidator </preferences-validator> </portlet-preferences> </portlet> </portlet-app> Côté utilisateur, un portlet est une fenêtre contenue dans un site de portail, qui fournit un service ou des informations spécifiques, par exemple un agenda ou des actualités.

11 p. 11/47 Illustration 3 : Page d un portail avec des portlets Dans une optique de développement d'une application, les portlets sont des modules d'extension conçus pour s'exécuter dans un conteneur de portlet appartenant à un serveur de portail. JAHIA 5 utilise Jetspeed comme conteneur de portlet. 2.3 CONTENEUR DE PORTLET Le conteneur de portlet (Jetspeed) fournit un environnement d'exécution dans lequel les portlets sont instanciés, utilisés puis finalement détruits. Les portlets dépendent de l'infrastructure du portail pour accéder aux caractéristiques des profils utilisateur, participer aux événements d'action et de fenêtre, communiquer avec d'autres portlets, accéder à du contenu distant, consulter les accréditations et stocker les données rémanentes. L'API de portlet fournit des interfaces standard pour ces fonctions. Cependant, le conteneur n est pas responsable de l agrégation du contenu généré par les portlets. Ceci est géré par le portail. Le portail et le conteneur peuvent être mis en œuvre en même temps, comme un simple module ou bien comme deux modules distincts.

12 p. 12/ GENERATION DE LA PAGE DU PORTAIL Les portlets s exécutent dans un conteneur. Celui-ci reçoit les contenus générés par les portlets et les envoie au serveur de portail. Enfin, le serveur de portail construit la page du portail et l envoie au client (par exemple, au navigateur). Illustration 4 : Architecture de base d'un portail Site in 5 Minutes 2.5 CONCEPTS CYCLE DE VIE Le cycle de vie d un portlet est très proche de celui d un servlet. Il se décompose en trois phases : initialisation traitement des requêtes destruction Le portlet reçoit les requêtes basées sur l'interaction de l utilisateur avec le portlet ou la page du portail. Le traitement de la requête se divise en deux phases : Traitement de l action (processaction( )) : si un utilisateur clique sur un lien généré par le portlet, une action est lancée. Le traitement de l action est terminé avant que le portlet ne commence à générer le contenu. Génération du contenu (renderaction( )) : dans cette phase, le portlet génère le contenu envoyé à la page du portail. Tous les portlets contenus dans la page du portail peuvent exécuter cette phase en parallèle.

13 p. 13/47 Illustration 5 : Traitement de requêtes par les portlets Un portlet est une classe qui doit mettre en œuvre l interface javax.portlet.portlet et qui fournit quatre méthodes (init( ), processaction( ), render( ) et destroy( )) pour pouvoir être géré correctement par le conteneur. Pour obtenir plus d informations sur l interface javax.portlet.portlet, consultez la page : La classe javax.portlet.generic est une classe qui met en œuvre l interface Portlet. La méthode render( ) est décomposée en 3 méthodes : doview( ), doedit( ) et dohelp( ). Il est conseillé de dériver cette classe pour développer un portlet. Pour obtenir plus d informations, consultez la page :

14 p. 14/ GESTION DE LA SESSION Comme les objets HttpSession utilisés par les servlets, les portlets définisssent l objet PortletSession qui permet d enregistrer des objets au cours de la session du client. Deux portées sont définies lors de l enregistrement d un objet en session : PORTLET_SESSION : l objet est accessible uniquement par le portlet et l utilisateur en cours APPLICATION_SESSION : l objet est accessible par tous les portlets, servlet et jps de l application, mais uniquement par l utilisateur en cours PORTLETURL Contrairement aux servlets, un portlet n est pas directement lié à une URL. La norme JSR168 a défini la notion de PortletURL. Ceux-ci permettent de générer des URL qui pointent vers le portlet (à travers le point d entrée/sortie du portail). Il existe deux types d URL : actionsurl : les méthodes processaction( ) et renderaction( ) sont exécutées dans cet ordre. renderurl : seule la méthode render est executée SECURITE AUTHENTIFICATION L authentification est gérée par le portail (JAHIA) AUTORISATION Les portlets se basent sur le modèle de rôles défini par la norme J2EE/Servlet. Il est possible de vérifier le rôle de l utilisateur connecté via les méthodes isuserinrole(). Les méthodes getuserprincipal() et getremoteuser() permettent d obtenir le nom d utilisateur d un utilisateur MODE DE PORTLET Grâce à différents modes, un portlet peut afficher différentes interfaces utilisateur, en fonction de la tâche qu'il doit effectuer. Un portlet dispose de trois modes d'affichage qui sont définis dans le descripteur de déploiement de portlet. Le conteneur de portlet conserve le mode du portlet dans l'objet PortletMode.

15 p. 15/47 Les modes suivants sont fournis par l'api de portlet : Affichage : lorsqu'un portlet est initialement construit sur une page de portail, pour un utilisateur, il apparaît en mode Affichage. Il s'agit du mode de fonctionnement normal du portlet. Édition : si ce mode est pris en charge par le portlet, ce dernier fournit une page permettant aux utilisateurs de personnaliser le portlet en fonction de leurs besoins. Par exemple, un portlet peut fournir une page permettant aux utilisateurs d'indiquer le lieu où ils se trouvent afin d'obtenir des informations sur la météo ou les événements locaux. Les utilisateurs doivent être connectés au portail pour accéder au mode Édition. Aide : si ce mode est pris en charge par le portlet, ce dernier fournit une page d'aide offrant aux utilisateurs de plus amples informations sur le portlet. L'API de portlet offre plusieurs méthodes au portlet pour déterminer le mode en cours. Tous les portlets doivent prendre en charge le mode Affichage. Le portail inclut des commandes qui permettent aux utilisateurs de modifier le mode en cours. Voici un exemple de la barre d'un portlet en mode Affichage. Illustration 6 : Mode du portlet Cette barre affiche les modes Affichage, Édition et Aide. Le portlet passe en mode Édition lorsque l utilisateur clique sur l onglet. L API offre une la classe javax.portlet.portletmode pour gérer le mode d un portlet. Pour obtenir plus d informations sur la classe javax.portlet.portletmode, consultez la page : Il n est possible d enregistrer des préférences que pendant la phase processaction( ).

16 p. 16/ ÉTATS DU PORTLET Les différents états d'un portlet permettent aux utilisateurs de modifier l'affichage de la fenêtre du portlet sur le portail. Dans un navigateur, les utilisateurs accèdent à ces différents états grâce aux onglets de la barre de titre, comme dans les applications Windows. Les états d un portlet sont conservés dans l'objet PortletWindowState, sous la forme d'une valeur booléenne. Les états suivants sont fournis par l'api de portlet : Normal : lors de sa construction initiale sur la page de portail, le portlet apparaît en mode Normal et est organisé sur la page, avec les autres portlets. Réduit : lorsque le portlet est réduit, seule la barre de titre s'affiche sur la page du portail. Illustration 7 : État du portlet L'API de portlet offre plusieurs méthodes au portlet pour déterminer l état en cours. Pour obtenir plus d informations sur la classe javax.portlet.windowstate, consultez la page : PREFERENCES DU PORTLET Le portlet peut stocker des données permanentes pour un utilisateur spécifique en utilisant l objet PortletPreferences. Les préférences peuvent utiliser des valeurs par défaut, définies dans le descripteur de déploiement (fichier portlet.xml). Le mode conseillé pour la définition des préférences est le mode Édition. Ce mode fournit à l'utilisateur un écran de personnalisation.

17 p. 17/47 Il est possible de définir des validateurs utilisés par le conteneur pour s assurer que les valeurs des préférences sauvegardées sont conformes à certains critères LIMITATIONS IMPOSEES Les portlets génèrent des fragments HTML agrégés dans une page de portail. Par conséquence, la norme JSR168 interdit qu un portlet génère des balises de type Base, body, frame, frameset, head, html et title. 3 JAHIA ET PORTLET JSR ATTRIBUTS DE LA REQUETE Jahia ajoute des attributs dans la requête qui peuvent être très utils pour les développeurs. Il est à noter que si ces attributs sont utilisés alors la portlet n est plus compatible avec d autres portails. La table ci-dessous présente ces attributs. Ceux-ci sont accessibles à partir de la portlet grâce à la méthode renderrequest.getattribute(string attributename) de l API Portlet. Attribute name Type Value Description "org.portletapi.portal" String true Toujours à true. Permet de déterminer si l application est lancée en "standalone" ou dans le context de Jahia "org.portletapi.userlist" Vecteur d objets String Liste des noms de tous les utilisateurs Contient la liste de tous les utilisateurs. Par exemple, permet de gérer l assignation des droits à partir de la portlet. Cependant, il est préférable d utiliser les rôles si c est possible. "org.portletapi.contextid" String == fieldid Le contextid est un String qui permet d obtenir un identifiant unique pour différencier les instances de portlet. Jahia permet à une portlet d être instanciée plusieurs fois dans une même page. Dans la version actuelle de Jahia, le contextid correspond au fieldid qui contient l application. Il est aussi possible (et préférable) d obtenir un identifiant unique grâce à la méthode getnamespace() de l objet renderresponse (JSR168) "org.portletapi.fullscreen" String true / false Pas complètement implémenté. Cet attribut permet de savoir si l application est dans le mode full screen ou non. "org.jahia.sitekey" String jparams.getsitekey () L identifiant unique du site dans lequel la portlet est instanciée "org.jahia.siteurl" String jparams.getsiteurl () Un objet de type String qui contient l url du site qui correspond généralement au domaine du site comme par exemple : etc "org.jahia.siteid" String Integer.toString (jparams.getsiteid ()) Un objet de type String qui contient un entier qui correspond à l identifiant du site stocké dans la base de donnée.

18 p. 18/47 "org.jahia.pageid" String Integer.toString (jparams.getpageid ()) Un objet de type String contenant un entier qui correspond à l identifiant de la page dans laquel la portlet est affichée. "org.jahia.operationmode" String jparams.getoperation- Mode () Permet de determiner le mode actuelle de la page. Les valeurs possibles pour Jahia 4/5 sont : "normal" (appelé aussi Live dans les templates), "edit" (mode d édition), "debug" (pas utilisé mais encore accepté dans l urls des pages), "preview" (prévisualistion de la page avant d être publiée), et "compare" (un mode spécial qui permet de comparer deux versions de la page) 3.2 ATTRIBUTS DE SESSION DEFINIS DANS UN TEMPLATE Par défaut, Jahia ne partage pas les attributs mis en session avec la portlet. Ceci implique que si vous ajoutez un attribut dans la session Jahia (à traver un scriplet ou un template) en utilisant cette instruction : request.getsession().setattribute( name, value ); vous ne pourrez pas y accéder à partir de la portlet avec cette instruction : renderrequest.getportletsession().getattribute( name ); Cette limitation existe pour des questions de sécurité. L application doit être au maximum indépendante pour éviter les conflits de nom des attributs qui peuvent engendrer des comportements inattendus. Cependant, il est possible de désactiver cette limitation grâce à une propriété qu se trouve dans le fichier de configuration, jahia.properties : webapps.dispatcher.inheritjahiasessionattributes = true Par défaut, cette propriété est à false. La valeur true permet aux portlets d accéder aux attributs de session de Jahia.

19 p. 19/47 CHAPITRE 2 : DEVELOPPER UN PORTLET DE BASE Ce chapitre présente un exemple de développement et de déploiement d un portlet sous JAHIA 5, à l aide d un modèle de base. 1 INTRODUCTION Le but de ce portlet est d afficher le message Hello World!. Les différentes étapes sont les suivantes : écriture de la classe HelloWorldPortlet qui implémente l interface javax.portlet.portlet écriture des fichiers portlet.xml et web.xml archivage du portlet dans un fichier war déploiement du portlet affichage dans une page Jahia Le développement d un portlet requiert la présence de la bibliothèque portlet.api. Celle-ci est disponible sur à cette adresse : 2 CLASSE HELLOWORLDPORTLET Comme pour tout portlet, la classe doit implémenter l interface javax.portlet.portlet. L API du portlet propose une classe, appelée GenericPortlet, qui implémente cette interface. Cette classe décompose la méthode render( ) en trois méthodes : doview( ) : portlet en mode Affichage dohelp( ) : portlet en mode Aide doedit( ) : portlet en mode Édition Notre portlet n est utilisable qu en mode Affichage. Nous allons surchager la méthode doview( ). public void doview(renderrequest req, RenderResponse resp) { try { response.setcontenttype("text/html"); PrintWriter out = resp.getwriter(); out.print("hello world");

20 p. 20/47 } catch (Exception ex) { ex.printstacktrace(); } } La méthode doview( ) est similaire aux méthodes doget( ) et dopost( ) des servlets. L objet PrintWriter permet d écrire dans le flux renvoyé par le portail. Celui-ci est ensuite agrégé avec celui des autres portlets et le modèle Jahia, afin de former une page Jahia complète. Voici le code complet du portlet : package org.jahia.portlet; import javax.portlet.*; import java.io.printwriter; import java.io.*; import java.lang.stringbuffer; /** * HelloWorldPortlet * *@author Khaled TLILI */ public class HelloWorldPortlet extends GenericPortlet { /** * Init portlet method * *@param config Description of Parameter *@exception PortletException Description of Exception */ public void init(portletconfig config) throws PortletException { super.init(config); } /** * processaction method */

21 p. 21/47 public void processaction(actionrequest request, ActionResponse response) { System.out.println("====== Begin process method ======"); } /** * render method */ public void doview(renderrequest request, RenderResponse response) { try { response.setcontenttype("text/html"); PrintWriter out = response.getwriter(); PortletURL url = response.createrenderurl(); PortletURL actionurl = response.createactionurl(); out.print("hello world!"); } catch (Exception ex) { ex.printstacktrace(); } } /** * destroy method */ public void destroy() { super.destroy(); } } Pour compiler ce portlet, il est nécessaire d ajouter la bibliothèque portlet.jar au classpath. Pour ajouter les modes Édition et Aide, il est nécessaire de mettre en œuvre respectivement les méthodes doedit( ) et dohelp( ) et de mettre à jour les fichiers portlet.xml.

22 p. 22/47 3 FICHIER PORTLET.XML Ce fichier sert à décrire les portlets qui vont être déployés dans JAHIA, sous la forme d une application Web. <?xml version="1.0" encoding="utf-8"?> <portlet-app version="1.0"> <portlet> <description>hello World portlet</description> <portlet-name>helloworldportlet</portlet-name> <portlet-class>org.jahia.portlet.helloworld</portlet-class> <supports> <mime-type>text/html</mime-type> <portlet-mode>view</portlet-mode> </supports> <portlet-info> <title>simpleportlet</title> </portlet-info> </portlet> </portlet-app> Ce descripteur contient diverses informations sur le portlet, comme son nom, la classe qui contient sa mise en œuvre, les modes qu il supporte (dans notre exemple : uniquement le mode Affichage), ainsi que des informations le décrivant. Le fichier portlet.xml est placé au même niveau que le ficher web.xml, c est-à-dire dans le répertoire WEB-INF. Une application peut déclarer plusieurs portlets. Ceci permet de n avoir qu un seul fichier *.war ou de regrouper des portlets similaires (fonctionnalités, back end, etc.). 4 FICHIER WEB.XML Dans notre exemple, le ficher web.xml est vide. JAHIA (via Jetspeed) y ajoute certaines informations après le déploiement.

23 p. 23/47 Après le déploiement, le contenu du fichier web.xml est : <?xml version="1.0" encoding="utf-8"?> <web-app> <display-name>helloworldportlet</display-name> <description>hello World Portlet </description> <servlet> <servlet-name>jetspeedcontainer</servlet-name> <display-name>jetspeed Container</display-name> <description>mvc Servlet for Jetspeed Portlet Applications</description> <servlet-class>org.apache.jetspeed.container.jetspeedcontainerservlet</servlet-class> <init-param> <param-name>contextname</param-name> <param-value> HelloWorldPortlet</param-value> </init-param> <load-on-startup>0</load-on-startup> </servlet> <servlet-mapping> <servlet-name>jetspeedcontainer</servlet-name> <url-pattern>/container/*</url-pattern> </servlet-mapping> <taglib> <taglib-uri> <taglib-location>/web-inf/tld/portlet.tld</taglib-location> </taglib> </web-app> Si le fichier web.xml avait déjà contenu des informations, celles-ci auraient étés agrégées avec le contenu ci-dessus. 5 DEPLOIEMENT Les portlets ont la même structure que les applications Web classiques. L arborescence suivante doit être respectée :

24 p. 24/47 + HelloWorldPortlet + META-INF + WEB-INF + classes + + lib porlet.xml web.xml Après sa création, le fichier HelloWorld.war doit être placé dans le répertoire suivant : ${TOMCAT_HOME}\webapps\jahia\WEB-INF\var\new_webapps. JAHIA déploie automatiquement le portlet. Ce déploiement automatique effectue les actions suivantes : déplacement du fichier HelloWorld.war dans : ${TOMCAT_HOME}\webapps\jahia\WEB-INF \etc\jetspeed\deploy ajout d une entrée dans la base de données réécriture du fichier web.xml déploiement de l application dans tomcat La génération du fichier peut se faire à l aide de la commande jar de java, ou des outils ant ou maven. La procédure de redéploiement est identique. Cependant, il est nécessaire de s assurer qu aucun fichier n est verrouillé (jar, fichier de propriétés, fichier de la base de données Hsql, etc.) NE PLACEZ JAMAIS LE FICHER *.WAR DIRECTEMENT DANS ${TOMCAT_HOME}\webapps. JAHIA DOIT AU MINIMUM RÉÉCRIRE LE FICHIER WEB.XML 6 VISUALISATION Pour visualiser le portlet, il faut ajouter le portlet à une page JAHIA (reportez-vous au document JahiaEndUserGuide.pdf).

25 p. 25/47 CHAPITRE 3 : DEVELOPPER UN PORTLET AVANCE Ce chapitre présente le développement d un portlet avancé. Nous allons étudier comment utiliser les JSP, les attributs, les préférences et les modes. 1 INTRODUCTION Le but de ce portlet est d afficher le message : Hello <nom de l utilisateur>! Votre film préféré est <nom du film>. Le portlet doit permettre à l utilisateur connecté de spécifier le nom de son film préféré. Cette portlet utilisera 3 modes : Affichage : pour afficher le message ci-dessus. Édition : pour éditer les préférences Aide : pour afficher un message d aide Nous vous conseillons de n autoriser la mise à jour des valeurs des préférences par l utilisateur que dans le mode Édition. Les différentes étapes sont les suivantes : écriture de la classe HelloPortlet qui met en œuvre l interface javax.portlet.portlet écriture des fichiers portlet.xml et web.xml archivage du portlet dans un fichier *.war déploiement du portlet affichage dans une page Jahia