Commentaires, ajouts nécéssaires, etc. Bonjour,

Ressources:

Plan:

Installation
Architecture de base d'un servlet
Exemple: traitement de formulaires
Maintien de sessions
Cookies
Problèmes de threading
JDBC: Java DataBase Connectivity
Servlets et transformations XSLT avec Xalan-J
Un servlet évolué: Cocoon
Upload de fichiers

1 Installation

Les sections suivants supposent que le JDK de SUN, ainsi que Apache 1.2 et spérieur ont été préalablement installé.

1.1 Installation du Kit de Développement de Servlets : le JSDK

servletrunner permet de tester les servlets, c'est à dire qu'il va faire office de mini-serveur, écoutant sur un port spécifique (8080 par défaut). Il est possible de modifier les paramètres par défaut de servletrunner, notamment les flags -d suivi du répertoire contenant les servlets, et -s suivi du fichier de propriétés de la zone à considérer.
 

1.2 Installation du module côté serveur : ApacheJserv

olly%>./configure -with-jsdk=/usr/lib/JSDK2.0/lib/jsdk.jar  -disable-debugging -with-apache-install=/usr

(La directive -with-apache-install=/usr est nécéssaire sous SuSE (mon cas) car configure croit que apxs est sous apache_dir/sbin/, alos qu'il  est en réalité sous /usr/sbin.)
Lors d'une seconde intallation sous Mandrake 7.0, la commande est devenue :

olly%>./configure --with-apxs=/usr/sbin/apxs --prefix=/usr/lib/jserv --with-jdk-home=/usr/lib/jdk1.2.2 --with-JSDK=/usr/lib/JSDK2.0/lib/jsdk.jar --disable-debugging --with-java-platform=2

olly%>make
olly%>make install
 

1.3 Configuration pour l'éxécution de servlets

Exemple de ligne à inclure dans httpd.conf (après avoir copié le fichier jserv.conf à l'endroit indiqué):
Include /etc/httpd/jserv.conf

Le fichier jserv.conf contient à son tour une directive ApJServProperties /chemin/vers/jserv.properties pointant sur le fichier jserv.properties qui contient les propriétés des diférents servlets utilisés. jserv.properties permet entre autres choses de spécifier le nombre de zones souhaitées, le nom donné à chacune, ainsi que leur emplacement sur le disque.
Par exemple, si l'on souhaite deux zones nommées zone_a et zone_b, le fichier jserv.properties devra contenir les lignes suivantes :

Configuration : plusieurs zones. Chaque zone possède un fichier nom_zone.properties propre, dans lequel est entre autres indiqué le répertoire où trouver les servlets (repositories=/chemin/vers/classes).

Les zones disponibles doivent être indiquées dans le fichier jserv.properties. Les lignes zones=zone1, zone2, ... et le chemin des fichiers de propriété leur correspondant : zone1.properties=/chemin/vers/zone1.properties, zone2.properties=/chemin/vers/zone2.properties, etc..

Une fois JServ configuré, il est nécessaire de relancer Apache, avec une des commandes suivantes: rcapache restart, apachectl restart ou bien kill -NOHUP `cat var/httpd.pid`.
 

2 Architecture de base d'un servlet

2.1 Exemple : Hello World!

Ce servlet hérite donc de la classe HttpServlet, et surcharge la méthode doGet, cette dernière étant appelée lorsqu'un client envoie une requète GET au serveur.

Pour éxécuter ce servlet, il suffit de placer le code compilé (ExempleServlet.class) dans l'un des répertoires correspondant aux zones configurées, par exemple ~/example/ puis d'ouvrir avec un browser l'URL http://localhost/example/ExempleServlet.
 

2.2 Contenu du package javax.servlet

• classe HttpServletRequest

String useragent = request.getHeader("user-agent"); 
if (useragent.indexOf("Netscape")) {
   /** instructions éxécutées si le navigateur client est Netscape **/
}

• classe HttpServletResponse

2.2 Cycle de vie d'un servlet

• Initialisation

Exemple de surcharge de la méthode init() :

• Fonctionnement

• Destruction

3 Exemple : traitement de formulaires

3.1 Méthode GET

Pour traiter une requète GET, il est nécessaire de surcharger la méthode doGet. A l'intérieur de cette méthode, la méthode getParameter permet de récupérer la valeur d'un paramètre passé au servlet avec la requète GET. Par exemple:

String bookId = request.getParameter("bookId"); //permet de récuperer la valeur du paramètre "bookid". La méthode renvoie null si le paramètre n'existe pas. Il est possible d'utiliser cela pour compacter les pages dynamique en un seul servlet:
 

    //affiche le formulaire

} else {

    //traite le formulaire

}

3.2 Méthode PUT

4 Maintien de sessions

HttpSession session = request.getSession(true);

Rien de plus pour l'instant.

5 Cookies

Bien que les classes et méthodes utilsées pour le maintien de session utilisent les cookies sans que l'on ai besoin d'y toucher directement, l'API Servlet comprends la classe javax.servlet.http.Cookie qui permet de manipuler des objets Cookies
 

    5.1 Envoyer un cookie

    5.2 Récupérer un cookie

L'instruction suivante permet de récupèrer l'ensemble des cookies:

Cookie[] cookies = req.getCookies(); 

La classe Cookie possède alors les méthodes suivantes:
public String getName()  pour récupèrer le nom du cookie

public String getDomain() pour récupèrer le domaine

public String getValue() pour récupérer la valeur stockée dans le cookie

6 Problèmes de threading

Un exemple d'un tel servlet est le suivant :

    ...
}

Le serveur s'assure alors que la méthode service n'est pas appelée plus d'une seule fois simultanément.
Un moteur de base de données comporte bien souvent des systèmes de verrouillage d'accès et n'est donc pas un bon exemple. Prenons plutot l'exemple d'un fichier texte contenant un nombre plusieurs clients pourraient vouloir modifier simultanément

La deuxième possibilité est de synchroniser l'accès à la ressource.

7 Java DataBase Connectivity

Pour faire fonctionner l'example fourni, il est nécéssaire d'avoir une base de données (ici nommée test), et d'y insérer une table avec quelques données. Pour cela, il suffit de créer un fichier texte tout simple nommé par exemple jdbc.sql contenant les quelques commandes SQL suivantes :

Ensuite la commande  olly>psql test< jdbc.sql permet d'éxécuter ces commandes (et donc de créer la table et d'y insérer les trois enregistrements).

    7.1 Connection à une base de donnée

Dans le monde JDBC, une base de données est représentée par une URL, par exemple jdbc:postgresql://host:port/base. En ce qui concerne le driver JDBC pour PostgreSQL, host est par défaut égal à localhost et port à 5432

import java.sql.*;

public class jdbctest {

   public static void main(String args[])

   {

        String url = "jdbc:postgresql:test";

        Connection con;

        Statement stmt;
        try

        {

           Class.forName("postgresql.Driver");

        }

        catch(java.lang.ClassNotFoundException e)

        {

           System.err.print("ClassNotFoundException: "); System.err.println(e.getMessage());

        }
        try

        {

           con = DriverManager.getConnection(url, "olly", "");

           stmt = con.createStatement(); 
            ResultSet rs = stmt.executeQuery("select * from stories");

           while (rs.next())

           {

               String s = rs.getString("story_title");

               System.out.println(s);

           }

           stmt.close();

           con.close();
        }

       catch (SQLException ex)

       {

           System.err.println("SQLException: " + ex.getMessage());

       }

   }

}

Stockage d'objet Java dans une base PostgreSQL

Postgresql est une base de données d'un genre un peu particulier : elle possède par rapport à une base relationnelle traditionnelle des extensions objets, qui lui permettent par exemple de stocker une table dans un champs d'une autre table.

Il est donc tout à fait possible en Java de stocker un objet dans un stream, si la classe de l'objet implémente l'interface java.io.Serializable. Cette caractèristique rend alors possible le stockage d' objets Java dans une base Postgresql, au moyen des LargeObject. Cependant, Postgresql est un moteur de base de données d'un genre un peu particulier : il possède par rapport à une base relationnelle traditionnelle des extensions objets, qui lui permettent par exemple de stocker une table dans un champs d'une autre table. La classe postgresql.util.Serialize du driver JDBC se sert de cette caractèristique pour fournir un moyen de stocker un objet Java en tant que table.
 

8 Un servlet évolué: Cocoon

    Installation de Cocoon

Il faut ensuite choisir la zone servlet dans laquelle Cocoon doit résider, zone dans cette exemple. Il faut donc passer le fichier cocoon.properties en parametre au fichier zone.properties, en y ajoutant la ligne suivante:
servlet.org.apache.cocoon.Cocoon.initArgs=properties=[path-to-cocoon]/conf/cocoon.properties

Il faut également dire à Apache d'associer tous fichier xml avec Cocoon. Pour cela, il faut ajouter:

Cas 1: Le fichier XML existe deja
Le fichier XML est le suivant, et nous voulons afficher ses infos dans un document HTML, sous forme de table.

    <story>
        <story_title>Linuxcare Responds To Tim O&apos;Reilly&apos;s Article</story_title>
        <story_url>http://slashdot.org/article.pl?sid=00/05/15/0254252</story_url>
        <story_date>2000-05-15</story_date>
    </story>

    <story>
        <story_title>New Internet VCR Service</story_title>
        <story_url>http://slashdot.org/article.pl?sid=00/05/14/2048217</story_url>
        <story_date>2000-05-15</story_date>
    </story>
</stories>

La feuille de style que l'on doit appliquer pour obtenir le résultat souhaité est très simple:

<xsl:template match="stories">
<table>
<xsl:apply-templates select="story"/>
</table>
</xsl:template>

<xsl:template match="story">
 <tr><td><a href="{story_url}"><xsl:value-of select="story_title"/></a></td><td><xsl:value-of select="story_date"/></td></tr>
</xsl:template>

</xsl:stylesheet>

Cette feuille de style est stockée dans le fichier stories.xsl. Pour signifier à Cocoon qu'il doit appliquer cette feuille au document XML ci-dessus, il faut rajouter une ligne à ce dernier, dans son entête,  juste après le tag de version.

<stories>
.
.

<!-- This page was served in 748 milliseconds by Cocoon 1.7 -->

Cas 2 : l'information est stockée dans une base de données
 

Il faut passer par ce que l'on appelle un SQLProcessor. XSQL, fourni par Oracle, est un exemple de produit transformant un résultat d'une requète SQL en XML. Pour pouvoir utiliser SQLProcessor, il faut s'assurer qu'une ligne du type processor.type.sql = org.apache.cocoon.processor.sql.SQLProcessor est présente dans le fichier cocoon.properties.

Cet exemple éxécute une requète SQL sur une base PostGreSQL grâce à JDBC (il faut donc lui fournir les coordonnées du driver, ainsi que des infos utilisateurs, tq login et password) puis récupère les résultats et les formatte en XML. Il s'agit simplement de remplacer le bloc <query> ... </query> par le résultat, puis de lui appliquer la feuille de style normale.

<page>

 <connectiondefs>
  <connection name="test_connection">
   <driver>postgresql.Driver</driver>
   <dburl>jdbc:postgresql:test</dburl>
   <username>olly</username>
   <password></password>
  </connection>
 </connectiondefs>

 <query connection="test_connection" doc-element="stories" row-element="story">
  select story_title, story_url, story_date from stories
 </query>

</page>

Les attributs doc-element et row-element permettent de spécifier respectivement le nom que va prendre l'ensemble des résultats (ResultSet), et les lignes (rows). S'ils ne sont pas spécifié, ces noms seront ROWSET et ROW.
 

9 Upload de fichiers

<form  enctype="multipart/form-data" action="action" method="post"><br>
<textarea name="indata" cols="70" rows="10"></textarea><br>
<input type="file" name="infile"><br>
<input type="submit" name="submit" value="Continue"><br>
</form><br>

 import java.io.*;
 import javax.servlet.*;
 import javax.servlet.http.*;
 import java.util.Date;
 import com.oreilly.servlet.multipart.*;

 .
 .

 public void doPost (HttpServletRequest request, HttpServletResponse response)  throws ServletException, IOException {
 
        /** récupère la date courante **/ 
        Date d = new Date();
	
	/** forge une chaine de caractère contenant la date **/
        String timestamp = new String(d.getMinutes() + "-" + d.getSeconds());
        
	/** crée un nouveau multipart parser, la taille des objets parsés étant de 10 MB au maximum **/  
        MultipartParser mp = new MultipartParser(request, 10*1024*1024); // 10MB
        Part part;

	/** itére tous les parties **/
        while ((part = mp.readNextPart()) != null) {
	    /** s'il s'agit du fichier **/
            if (part.getName().equals("infile")) {
	    
	        /** recupere les données sous la forme d'un FilePart **/
                FilePart filePart = (FilePart) part;
                String fileName = filePart.getFileName();

		/** recopie dans un nouveau fichier **/
                if (fileName != null) {
                    long size = filePart.writeTo(new File("/tmp/data" + timestamp));
                    break;
                }
		
	    /** s'il s'agit de la zone de texte **/		
            } else if (part.getName().equals("indata")) {

	        /** recupere les données sous la forme d'un objet ParamPart **/
                ParamPart paramPart = (ParamPart) part;

		/** récupere la valeur du champ "indata" **/
                String indata = paramPart.getStringValue();

		/** pour écrire dans un fichier **/
                PrintWriter fos = new PrintWriter(new FileWriter("/tmp/data" + timestamp));
		fos.print(indata);
  
                fos.close();
            }
        }
}