Lutece : guide développeur
Développer le squelette du plugin avec PluginWizard
PluginWizard est un plugin Lutece permettant de générer les principaux fichiers d'un plugin Lutece :
- Les classes Java de la couche métier
- Les classes Java de la couche présentation
- Les classes Java des XPage
- Les JSP de l'interface d'administration
- Les templates HTML
- Les fichiers ressources d'internationalisation (i18n)
- Le fichier properties de configuration du plugin
- Le fichier de context de Spring
- Le fichier XML de définition du plugin
- Les scripts SQL de création et d'initialisation de la base de données
- Le fichier pom.xml pour construire le projet avec Maven
- Les fichiers de documentation au format xDoc
Cet assistant de génération débute par la saisie du nom du plugin. Si une génération a déjà été réalisée pour un plugin du même nom, l'application propose de récupérer ou de réinitialiser complètement les anciennes données de génération.
L'utilisateur est ensuite guidé dans l'avancée des étapes de définition des paramètres de génération. Il peut à tout moment revenir à l'étape précédente.
La dernière étape affiche le récapitulatif et propose de télécharger un fichier archive (zip) contenant l'ensemble des fichiers générés.
Voici la liste des étapes :
- Description : saisie des paramètres généraux du plugin (description, auteur, version, ...)
- Métier : permet de définir un ou plusieurs objets métiers
- Administration : permet de créer une ou plusieurs AdminFeature. Si ces AdminFeatures sont associées à des objets métiers, la fonctionnalité générée correspondra à la gestion de base de l'objet métier (liste, création, modification et suppression).
- XPage : permet de créer une ou plusieurs XPages. Si ces XPages sont associées à des objets métiers, la fonctionnalité générée correspondra à la gestion de base de l'objet métier (liste, création, modification et suppression).
- Portlet : saisie des paramètres généraux du plugin (description, auteur, version, ...)
- REST : propose la création de Web Services REST exposant les fonctions de création, modification et suppression d'un objet métier
- Génération : propose la génération des fichiers, selon éventuellement plusieurs modèles de génération, ainsi que le téléchargement du résultat dans un fichier zip.
Ce plugin peut être testé sur le site de démonstration de Lutece à l'adresse suivante :
http://dev.lutece.paris.fr/site-demo/jsp/site/Portal.jsp?page=pluginwizard
Il est néanmoins préférable de travailler sur une instance dédiée ou locale de manière à garder les informations de génération.
NB : PluginWizard offre la possibilité d'ajouter ou de personnaliser des générateurs. Il permet également de définir plusieurs modèles de génération, donc il ne faut pas hésiter à l'adapter pour qu'il réponde à des objectifs précis.
Dans la suite du livre, les composants pouvant être générés par PluginWizard seront indiqués par le macaron suivant :
