Groupe 3 (services applicatifs)
Date de création :	4 février 2005
Dernière modification :
Diffusion :	Esup-Portail

Connecteur Harpége

Connecteur Harpége

But

Principe de fonctionnement et pré-requis

• Ce service utilise un pool de connexion tomcat pointant vers la base Harpége..
• Connaissant une requête de mapping à exécuter dans la base de données Harpége et un paramètre issu des attributs de l'utilisateur ESup à passer à cette requête, celle-ci doit nous fournir le champs NO_INDIVIDU de la table INDIVIDU.
• Il fournit également un mécanisme permettant de personnaliser la récupération l'attribut de mapping à partir du login de la personne connectée. Ce mécanisme peut-être utile si on utilise une recherche de personne qui retourne comme résultat l'identifiant de la personne sélectionnée.
• Le résultat de la requête

Installation

Création d'un pool de connexion tomcat

• Dans la configuration de Tomcat, ajouter dans le fichier web.xml les lignes suivantes :

<resource-ref>
<res-ref-name>jdbc/Harpege</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
</resource-ref>

• Dans le fichier server.xml ajouter les lignes suivantes :
  • sous la ligne <Resource name="jdbc/PersonDb" auth="Container" type="javax.sql.DataSource"/>, ajouter :

  <Resource name="jdbc/Harpege" auth="Container" type="javax.sql.DataSource"/>

  • après la description de PersonDb, ajouter les lignes :

  <ResourceParams name="jdbc/Harpege">
  <parameter>
  <name>factory</name>
  <value>org.apache.commons.dbcp.BasicDataSourceFactory</value>
  </parameter>

  <!-- Maximum number of dB connections in pool. Set to 0 for no limit.-->
  <parameter>
  <name>maxActive</name>
  <value>100</value>
  </parameter>

  <!-- Maximum number of idle dB connections to retain in pool. Set to 0 for no limit.-->
  <parameter>
  <name>maxIdle</name>
  <value>30</value>
  </parameter>

  <!-- Maximum time to wait for a dB connection to become available
  in ms, in this example 10 seconds. An Exception is thrown if
  this timeout is exceeded. Set to -1 to wait indefinitely.
  -->
  <parameter>
  <name>maxWait</name>
  <value>10000</value>
  </parameter>

  <!-- Person dB username and password for dB connections -->
  <parameter>
  <name>username</name>
  <value>nom du login de consultation</value>
  </parameter>
  <parameter>
  <name>password</name>
  <value>mot de passe du login de consultation</value>
  </parameter>

  <!-- Class name for JDBC driver -->
  <parameter>
  <name>driverClassName</name>
  <value>oracle.jdbc.driver.OracleDriver</value>
  </parameter>

  <!-- The JDBC connection url for connecting to your Person dB.-->
  <parameter>
  <name>url</name>
  <value>jdbc:oracle:thin:@nom de la machine:port:nom de la base</value>
  </parameter>

  </ResourceParams>

Récupération de la distribution

• Aller sur la page de téléchargement ESup pour récupérer la dernière version du package.
• Préparation du fichier de configuration HarpegeConnector.xml (voir Configuration)
• Préparation du déploiement : modifier les chemins d'installation du fichier build.properties.
• Lancement de la commande "ant deploy", pour déployer le service dans les bons répertoires.
• Il ne s'agit pas d'un canal donc aucune action de publication n'est à entreprendre.

Configuration

Modifier le fichier HarpegeConnector.xml sachant que :

• pool : fait référence au pool tomcat de connexion vers Harpége. Attention le nom de ce pool ne doit pas comporter la partie jdbc/ (par exemple, on fera référence au pool tomcat jdbc/Harpege par le nom Harpege)
• sqlmapping : c'est la requête à exécuter sur la base Harpége pour retourner la valeur de NO_INDIVIDU. Elle comporte un et un seul paramètre.
• personattribute : attribut de l'utilisateur ESup à passer comme paramètre de la requête (doit donc être présent dans l'objet IPerson)
• classmapping : classe permettant de récupérer l'attribut de mapping à partir du login d'une personne. Elle doit implémenter l'interface IClassMapping. Lors de sa déclaration dans le fichier de configuration du connecteur, spécifier le chemin complet, c'est à dire par exemple : org.esupportail.portal.channels.gestion.HarpegeMapping
  Le connecteur instancie alors dynamiquement la classe spécifiée et exécute la méthode déclarée dans l'interface.
  Si l'on ne veut pas utiliser de classe de mapping, ne pas déclarer cette balise.

Cas particulier des sites qui possèdent la valeur de NO_INDIVIDU dans leur LDAP

• Dans ce cas, laisser vide la valeur de sqlmapping
• Indiquer dans personattribute le nom de l'attribut LDAP qui contient la valeur de NO_INDIVIDU

Utilisation

voici un exemple type d'utilisation de ce service :

import org.esupportail.portal.utils.connectors_harpege.HarpegeConnector;

...

	try {
		no_individu = HarpegeConnector.getNO_INDIVIDU(getStaticData().getPerson());
	} 
	catch (ConnectorException e1) {
		// enregistrement plugin fatalError
		FatalError.fatalError(getConfigActions().getActions(), "Vous n'êtes pas un personnel de l'Université !");
		return null;
	}

Cas particulier de l'utilisation de la classe classmapping :

Il suffit d'utiliser la méthode getNO_INDIVIDUFromLogin()

no_individu = HarpegeConnector.getNO_INDIVIDUFromLogin(pers_id);

Création : 4 février 2005 - Jean-Marc Gullung (Université Henri Poincaré - Nancy 1)