Développer sous Jahia n’est pas simple : création de templates JSP, utilisation massive de scriptlets, API mal documentée, et peu devenir très vite laborieux sans mise en place d’un environnement de développement qui permet d’aider au maximum le développeur.

Ce tutorial va vous permettre de créer un environnement Jahia tout intégré : eclipse, wtp et tomcat 5.5. Il permet d’obtenir la complétion de JSP, l’accès à l’API Jahia, et même de débugage de JSP, bref, de quoi améliorer les conditions de travail :)

La mise en œuvre de l’environnement de développement consiste en une intégration de Jahia au sein d’Eclipse, à une configuration du serveur Tomcat local à utiliser dans Eclpise, et à une configuration d’Eclipse pour utiliser le référentiel CVS.

1 - Pré requis

 Pour réaliser cette mise en œuvre, les pré-requis suivants sont nécessaires :

  • Java SDK EE 1.5,
  • Eclipse IDE 3.2,
  • Plug-in d’Eclipse Web Tools Project (WTP) 1.5,
  • Apache Tomcat 5.5.12.
  • Jahia 5.0.3 r18957 :
    •   installé sur le disque à partir du package téléchargé sur le site de Jahia
    •   configuré via le Configuration Wizard (administrateur root, accès aux données…) et un site virtuel doit avoir été créé. On s’en assure en accédant à localhost :8080/jahia/Jahia : la page doit être une demande de connexion, et une fois connecté, la page d’accueil « corporate » doit s’afficher.

2 - Configuration de l’environnement de développement

 On utilise par la suite les variables suivantes :

TOMCAT_HOME_JAHIA : désigne le chemin d’accès au répertoire du serveur Tomcat fourni avec Jahia lors de l’installation de celui-ci
TOMCAT_HOME : désigne le chemin d’accès au répertoire du serveur Tomcat pré-installé (cf pré-requis) et utilisé par Eclipse

 2.1 - Intégration de jahia au sein d’eclipse

  • Dans Eclipse, créer un projet Web dynamique. Le nommer « jahia », et sélectionner comme environnement d’exécution cible « Tomcat 5.5 (stable). Dans répertoire du contenu, mettre « content », et en source, « src ». Terminer la création du projet,
  • Copier l’intégralité du contenu du répertoire TOMCAT_HOME_JAHIA/webapps/jahia dans le projet « jahia » que l’on vient de créer, à l’exception du dossier WEB-INF/classes. Il faut accepter lorsqu’Eclipse demande si l’on souhaite écraser les fichiers existants.
  • Créer manuellement le dossier « classes » dans le dossier « content/WEB-INF/ » du projet.
  • Dans les propriétés du projet, partie « Chemin de génération Java », mettre dans le dossier de génération par défaut le répertoire de classes créé : « jahia/content/WEB-INF/classes »
  • Copier l’intégralité du contenu du répertoire TOMCAT_HOME_JAHIA/webapps/jahia/WEB-INF/classes dans le répertoire « src » du projet jahia.

Deux remarques sur cette configuration particulière :1/ Il n’est pas possible de copier directement les classes dans le jahia/WEB-INF/classes sans les copier dans le répertoire « src ». En effet, le répertoire « classes » est issu de la génération à partir de sources placées dans le répertoire « src ». Si on copie les fichiers uniquement dans « classes », eclipse s’aperçoit que ces fichiers ne sont pas issus de fichiers sources dans « src », et les supprime alors. Le répertoire « src » contiendra donc les fichiers issus de Jahia, et les éventuels développements spécifiques.2/ Il est nécessaire d’installer Jahia et de créer un site virtuel avant d’importer le contenu de la webapp car :Lors de la phase de configuration avec l’assistant, Jahia modifie ses fichiers de configuration.Les fichiers du projet Eclipse « Jahia » ne sont pas utilisés directement par Tomcat, ils sont copiés automatiquement (c’est la phase de « publication ») vers un autre répertoire référencé par WTP.
Donc, si l’on importait dans le projet le contenu de la webapp jahia avant la configuration, et que l’on effectuait ensuite la configuration via l’assistant à partir du tomcat d’Eclipse, les fichiers de configuration qui seraient modifiés seraient ceux du répertoire référencé par WTP (invisible pour l’usager d’Eclipse) et non ceux du répertoire projet « jahia » d’Eclipse. Il en résulterait une perte de l’adéquation entre ces deux répertoires : les fichiers les plus à jour devant être toujours ceux du projet « jahia ».

 2.2 - Configuration du serveur tomcat local

  • Dans la vue « serveur », ajouter un serveur tomcat version 5.5. Lui donner le nom « localhost »
  • Dans la vue « serveur » ajouter le projet « jahia » créé précédemment comme module web.
  • Copier les librairies TOMCAT_HOME_JAHIA/shared/lib vers TOMCAT_HOME /shared/lib
  • Copier les classes TOMCAT_HOME_JAHIA/shared/classes vers TOMCAT_HOME /shared/classes
  • Dans le dossier du serveur tomcat qui a été crée au sein projet “Serveurs” de Eclipse, importer le fichier « catalina.properties » qui se trouve dans TOMCAT_HOME /conf
  • Modifier le fichier catalina.properties : changer la valeur de l’attribut « shared.loader » en remplaçant « catalina.base » par « catalina.home »

Il faut ensuite modifier les fichiers de configuration du serveur tomcat utilisé par Eclipse. En effet, certains fichiers du tomcat fourni avec Jahia ont été modifiés pour faire fonctionner jahia, il faut donc répercuter ces modifications. Cela se fait directement dans le dossier du serveur tomcat qui a été crée au sein projet “Serveurs” de Eclipse. Cette méthode permet de ne pas écraser les fichiers de configuration du serveur tomcat pré-installé : wtp utilisera uniquement les fichiers figurant dans eclipse :

  • Modifier le fichier « web.xml » :
    • Modifier l’élément “servlet” de nom « default » : mettre le paramètre listings à  « false »
    •  Modifier l’élément “servlet” de nom « cgi» : mettre le paramètre debug à  « 0 »
  • Modifier le fichier « server.xml » :
    • Modifier l’élément “ Connector ”, ajouter l’attribut suivant : emptySessionPath=”true”
    • Modifier l’élément “ Sender  ”, ajouter l’attribut suivant : waitForAck=”true”
  • Ouvrir le fichier de contexte du jahia installé : TOMCAT_HOME_JAHIA/conf/Catalina/jahia.xml. Copier l’intégralité de son contenu. Dans le fichier « server.xml »  remplacer la balise « Context » présente dans la balise « Host » par l’intégralité du contenu copié. Enfin, ajouter l’attribut source=”org.eclipse.jst.j2ee.server:jahia” dans l’élément « Context » que l’on vient de remplacer.

J’espère que ce billet vous a été utile ! Pour toute question/remarque/amélioration, merci de commenter l’article !