JPA et Container JEE avec Glassfish. Author : Cedric Dumoulin Date : 21 oct Rev : 3 Nov. 2015

Transcription

1 JPA et Container JEE avec Glassfish Author : Cedric Dumoulin Date : 21 oct Rev : 3 Nov Sommaire JPA et Container JEE avec Glassfish Connecteurs et plugins pour Glassfish Préparer la base de données Dans Eclipse En ligne de commande Vérifier les DB Activer JPA et EJB dans un même projet Eclipse Configurer les librairies requises Pour le serveur Changer la librairie du serveur Pour le client Persistance, Datasource et Connexion à la DB Configurer la persistance dans l'application Avec valeurs par défaut Avec propriétés Datasource Définir une datasource dans la configuration du serveur Spécifier les datasources utilisées par une application Connection JDBC - "JDBC Connection Pool" Problèmes fréquents Glassfish n'arrive pas a lancer la DB Derby Problème de restriction d'accès Le client n'arrive pas a trouver les objets sur le serveur (lookup fails) L'application serveur n'a pas démarré Le client doit utiliser la bonne librairie Le client utilise t-il le bon nom? Le bean session est-il correctement paramétré? Problème de serialisation ('marshaling exception')... 12

2 1. Connecteurs et plugins pour Glassfish Pour faciliter l'intégration de Glassfish dans Eclipse, il faut installer des plugins fournissant des services adaptés à Glassfish. Pour installer ces plugins: o Ouvrir Eclipse Marketplace o Faire une recherche sur Glassfish o Installer la distribution correspondant à votre version d'eclipse 2. Préparer la base de données Il faut indiquer à Glassfish de démarrer les serveurs de BD en même temps que le serveur Glassfish. 2 solutions : Si le serveur est lancé par Eclipse, on peut l'indiquer dans Eclipse Si le serveur est lancé manuellement, on peut l'indiquer dans la ligne de commande Une fois démarré, on peut vérifier les DB dans la fenêtre "Data Source Explorer" Dans Eclipse Window->Preference->Glassfish o Vérifier que l'emplacement de la DB soit un répertoire valide et modifiable (droit d'écriture)! o Si la DB n'existe pas encore, le repertoire correspondant au dernier segment du path (ici javadb) ne doit pas exister sur le disque.

3 En ligne de commande Voir la doc Glassfish 2.2. Vérifier les DB Ouvrir la fenêtre "Data Source Explorer". Le serveur de DB par défaut de Glassfish doit être présent (A Sample JavaDB...). On peut se connecter au serveur de DB en la sélectionnant, puis "menu contextuel- >connect". Si votre serveur n'apparait pas, créez une nouvelle entrée en spécifiant les paramètres de connexion à votre serveur. 3. Activer JPA et EJB dans un même projet Eclipse Créer un projet EJB, puis ajouter la facette JPA: Sélectionner le projet dans le Project Explorer, Right Click->Préférences-> Project Facet Ajouter la facette JPA.

4 Ajouter la facette JPA à un projet EJB 4. Configurer les librairies requises Les librairies requises diffèrent selon que le projet soit du coté serveur ou du coté client Pour le serveur Librairies requises : Le runtime du serveur sur lequel le projet est déployé (ex: Glassfish System Libraires) JDK > 1.7 (L'affichage indique JRE, même si c'est un JDK) Les librairies de l'application serveur

5 Changer la librairie du serveur Pour changer la librairie du serveur : o sélectionner le projet, menu contextuel->preference->targeted Runtimes o Cocher la librairie voulue Sélectionner la librairie du serveur 4.2. Pour le client Librairies requises : Librairies client pour le serveur cible o pour glassfish : gf-client-module.jar (faire une user library) jdk > 1.7 (L'affichage indique JRE, même si c'est un JDK)

6 Les librairies requises de l'application client 5. Persistance, Datasource et Connexion à la DB Dans JEE, une application n'est pas directement reliée à une DB. Au lieu de cela, une application spécifie une datasource, c'est à dire une source de donnée, qu'elle veut utiliser. Toutes les datasources disponibles sont déclarées au niveau du serveur, dans la configuration du serveur. Une datasource spécifie la connexion JDBC qu'elle veut utiliser. La déclaration de ces connexions se fait aussi dans la configuration du serveur. Pour résumer, le lien entre une application et une DB se fait en plusieurs étapes : o L'application spécifie la (ou les) datasource qu'elle utilise o Cela se fait dans le fichier persistence.xml o Les datasources disponibles sont déclarées dans la configuration du serveurs o On spécifie le nom de la datasource, et la connexion utilisées o Pour Glassfish, cela se fait par la console d'administration du serveur o Les connexions aux DBs sont déclarés dans la configuration du serveurs o On spécifie l'url du serveur, son driver jdbc, le login/password,... o Pour Glassfish, cela se fait par la console d'administration du serveur o Ces étapes sont détaillées dans les paragraphes suivants Configurer la persistance dans l'application Une application utilisant des objets persistents (entity) doit configurer la persistance. Cela se fait dans le fichier META-INF/persistence.xml. Ce fichier peut être configuré de différente façons : en utilisant les valeurs par défaut en spécifiant certaine propriétés comme le nom de la datasource Avec valeurs par défaut Il faut au minimum spécifier: Une unité, avec un nom Les classes persistantes Les propriétés de génération pour l'orm (ici eclipselink)

7 o de création de table o d'affichage du schéma généré o pour les valeurs de ces propriétés, voir aussi : <?xml version="1.0" encoding="utf 8"?> <persistence version="2.1" xmlns=" xmlns:xsi=" instance" xsi:schemalocation=" <persistence unit name="ipint.ejb.entreprise" transaction type="jta"> <jta data source>jdbc/mydatasource1</jta data source> <class>ipint.ejb.entreprise.impl.person</class> <properties> <property name="javax.persistence.schema generation.create database schemas" value="true"/> <property name="javax.persistence.schema generation.database.action" value="drop and create"/> </properties> </persistence unit> </persistence> Fichier persistence.xml minimal Avec les valeurs par défaut, Glassfish utilise l'unité de persistance déclaré dans le fichier persistence.xml, quelque soit son nom, et la source de données (datasource) par défaut jdbc/ default. Celle-ci utilise la connexion 'DerbyPool' connecté a un serveur Derby. La source de donnée par défaut Valeurs par défaut : datasource o jndi name : jdbc/ default o Logical JNDI Name : java:comp/defaultdatasource o JDBCConnection Pool DerbyPool o Transaction type : JTA

8 Avec propriétés Il est possible de spécifier les propriétés suivantes : Le type de transaction o JTA - Java Transaction API; C'est le seul mode supporté dans un containeur JEE. o <persistence unit transaction type="jta"> Le nom de la DATASOURCE o Utiliser la balise <jta data source>jdbc/ default</jta data source> o Dans l'exemple, on utilise la datasource par défaut de Glassfish (jdbc/ default). <?xml version="1.0" encoding="utf 8"?> <persistence version="2.1" xmlns=" xmlns:xsi=" instance" xsi:schemalocation=" <persistence unit name="ipint.ejb.entreprise" transaction type="jta"> <jta data source>jdbc/ default</jta data source> <class>ipint.ejb.entreprise.impl.person</class> <properties> <property name="javax.persistence.schema generation.create database schemas" value="true"/> <property name="javax.persistence.schema generation.database.action" value="drop and create"/> </properties> </persistence unit> </persistence> Fichier persistence.xml 5.2. Datasource Une datasource définie une source de données qui peut être utilisée par une application. Toutes les datasources doivent être déclarées au niveau du serveur. De plus, une application doit spécifier les datasource qu'elle veut utiliser. Une datasource représente, par exemple, une DB. Il faut définir les datasources dans la configuration du serveur. Une datasource définie deux propriétés : Le nom de la datasource (jndi name) utilisable par les applications. Le nom de la connexion à la DB "JDBC Connection Pool". Une application doit spécifier les datasources qu'elle utilise. Cela ce fait dans la configuration de la persitance de l' application (fichier META- INF/persistence.xml) Définir une datasource dans la configuration du serveur Cela se fait dans la configuration du serveur.

9 Ouvrir la fenêtre d'administration du serveur glassfish (dans un browser) Sélectionner JDBC Resource Dans le fenêtre de droite, faire "new" Spécifier la datasource dans la fenêtre qui s'ouvre o Donner un nom o choisir une jdbc connection pool (par ex DerbyPool) Sélection des datasources sous Glassfish Propriété d'une datasource sous Glassfish Nota : Il est possible de "desactiver" une datasource sans la détruire. Décochez status : enabled Spécifier les datasources utilisées par une application Cela se fait dans META-INF/persistence.xml. Changez le nom de la datasource: <jta data source>jdbc/mynewresource</jta data source> Voir aussi "Configurer la persistance dans l'application".

10 5.3. Connection JDBC - "JDBC Connection Pool" La spécification des paramètres de connexion à une BD se fait dans un "JDBC Connection Pool", dans la configuration du serveur. La " JDBC Connection Pool" permet entre autre : de spécifier le type de DB de spécifier la classe du connecteur a employer pour ce connecter à la DB de spécifier les paramètres d'accès (login, password, adresse,...) Capture d'écran d'une partie des propriétés d'une connexion sous Glassfish Vous pouvez créer de nouvelles connexions JDBC vers d'autres DBs. Utilisez la fonction "ping" pour vérifier si votre connexion est ok. Une fois créé, vous pouvez utiliser la connexion dans vos datasources. 6. Problèmes fréquents Si quelque chose ne fonctionne pas lors de l'execution de votre application ou de votre client, vous devez rechercher l'erreur remonté par le serveur ou le client. Pour rechercher une erreur: regardez les messages dans la console du serveur. o Les erreurs sont aussi remontées dans cette console. Il faut toujours vérifier ces erreurs, et essayer de les corriger. regardez les messages dans la console de votre client regardez attentivement les messages pouvant survenir dans des fenetres 'popup' Glassfish n'arrive pas a lancer la DB Derby

11 Dans certain cas, Glassfish n'arrive pas a lancer la DB. Il indique un message d'erreur (Can't start Database). L'erreur complete est dans le log de Glassfish. Elle indique qu'il y a une restriction d'acces Problème de restriction d'accès Cela est du a une restriction sur les ports utilisable par les applications. Voir Solution Il faut autoriser les connexions sur le port. Modifierle fichier des permissions de la JVM, et ajouter la ligne autorisant l'acces au port 1527 $JAVA_HOME/jre/lib/security/java.policy grant {... permission java.net.socketpermission "localhost:1527", "listen,resolve"; }; 6.2. Le client n'arrive pas a trouver les objets sur le serveur (lookup fails) L'erreur indique que le lookup() n'arrive pas a trouver le nom demandé. Cela peut venir de différents problèmes: L'application serveur n'a pas démarré correctement Le client n'utilise pas la bonne librairie Le client n'utilise pas le bon nom Le bean n'a pas d'interface remote Le bean est local L'application serveur n'a pas démarré Il faut bien vérifier les points suivants : Le serveur Glassfish est t-il démarré? L'application est-elle déployé sur le serveur Glassfish? o Elle doitr apparaitre dans la liste des applications L'application a t'elle correctement démarré sur le serveur Glassfish o Son statut doit être "synchronized". o Si le status est différent, l'application ne fonctionne pas correctement (ou le code a été modifié). Les beans ne sont alors pas accessible Le client doit utiliser la bonne librairie Le client doit se connecter au serveur de nom associé à votre serveur JEE. Pour cela, il doit connaitre les paramètres de connexion (adresse ip, port, login, password,...). Ces paramètres peuvent être fournit explicitement lors de la création du LookupContext, ou dans un fichier de paramètres (jndi.properties). Dans le cas de Glassfish, on peut utiliser la librarie 'module/gf-client-module.jar' qui contient ces paramètre de connexion. Dans ce cas, il n'est pas nécessaire de les préciser. En cas de problèmes, il faut vérifier les points suivants: Utilise t-on la bonne librairie pour le client? o Le plus simple est d'utiliser 'module/'gf-client-module.jar' Le buildpath contient-il d'autres librairies similaires?

12 o Si oui, il faut les supprimer. En effet, si 2 librairies implementent les mêmes classes (ici le lookup), la JVM utilisera une des implémentation au hasard Le client utilise t-il le bon nom? Lors du lookup, il faut utiliser le bon nom JNDI. Dans Glassfish, le serveur affecte plusieurs noms JNDI à un même objet: des noms portables, et des noms 'non portable'. Vous pouvez utiliser indifféremment ces noms. Comment trouver le nom JNDI d'un bean? Les noms JNDI d'un bean suivent des regles précises. Glassfish indique les noms JNDI des beans qui ont été démarré correctement dans la console de lancement. Il faut rechercher les lignes contenant 'jndi' et indiquant les noms jndi de vos beans Le bean session est-il correctement paramétré? Vérifiez les paramètres suivant de votre bean session Il est Il a une interface 'distante' Sauf si vous en avez vraiment besoin, enlevez o Cette annotation indique que le bean est accessible localement dans le même container. Un bean peut être accessible à la fois localement et à distance, mais cela ajoute de la complexité. Dans notre cas, nous voulons qu'il soit accessible àa distance à travers l'interface Remote Problème de serialisation ('marshaling exception') Vous lancez votre client, et lors de l'appel d'une méthode sur le serveur, une erreur indique 'marshaling exception'. Le marshaling est l'action de serialiser un objet afin de le faire passer sur le réseau. Les objets transitant sur le réseau doivent implémenter l'interface 'Serializable'. Regardez vos méthodes accessible à distance, et pour chaque argument, vérifiez que son type/classe implémente 'Serializable'.