Production de JSON avec Java et REST

a. Choix de la méthode HTTP

Bien que le protocole HTTP soit large, comme vu dans le chapitre Introduction à REST, les méthodes prises en charge dans JAX-RS se limitent aux méthodes OPTIONS, HEAD, GET, POST, PUT et DELETE. Vous ne pourrez donc pas utiliser PATCH, LINK, UNLINK, TRACE et CONNECT.

Les annotations suivantes sont disponibles :

Ces annotations sont à positionner dans la classe, non pas à la déclaration de la classe, mais à la déclaration de la méthode qui sera exécutée.

@HEAD

Il est à noter qu’il n’est pas obligatoire d’implémenter la méthode HEAD. Pour répondre à une requête HEAD envoyée au service REST, JAX-RS regarde s’il y a une méthode avec l’annotation @HEAD, et si la méthode n’existe pas, c’est la méthode avec l’annotation @GET qui est automatiquement exécutée, mais son corps ne sera pas renvoyé. Cependant, les performances peuvent être moindres dans ce cas.

@OPTIONS

Comme pour l’annotation @HEAD, il est possible mais non obligatoire d’implémenter manuellement la méthode OPTIONS à l’aide de l’annotation @OPTIONS. Si la méthode n’existe pas, le résultat sera généré automatiquement à l’aide des méthodes définies dans la classe appelée.

b. Choix du chemin d’appel

Une fois votre méthode choisie, il reste à déterminer l’URL qui sera appelée. Elle sera relative à...

a. Création d’un projet fonctionnant avec Jersey

Jersey est un projet fonctionnant avec Maven. En partant du principe que Maven est installé sur votre poste, voici comment créer, sous l’IDE (Integrated Development Environment) Eclipse, un projet utilisant Jersey.

Dans votre console, déplacez-vous dans le répertoire qui contiendra votre projet. 

Tapez ensuite :

mvn archetype:generate -DarchetypeArtifactId=jersey-quickstart- 
webapp -DarchetypeGroupId=org.glassfish.jersey.archetypes 
-DinteractiveMode=false -DgroupId=com.book -DartifactId=jersey- 
service -Dpackage=com.book.chapter4 -DarchetypeVersion=2.7
 

Cela va créer un projet JEE, sous le modèle d’une application fonctionnant avec Jersey.

Par défaut, il se nommera jersey-service, et le groupe Maven sera nommé com.book. La commande Maven va aussi créer un premier package com.book.chapter4.

Vous pouvez modifier ses trois valeurs si vous le souhaitez.

Ensuite, il vous faut vous déplacer dans le répertoire nouvellement créé et lancer la commande suivante :

mvn eclipse:eclipse -Dwtpversion=2.0
 

Maven va donc transformer le projet en un projet directement utilisable sous Eclipse.

Il reste alors à ouvrir Eclipse et à sélectionner le projet dans le menu File - Import - Existing projects into workspace puis à vous laisser guider.

Dans les exemples de ce livre, le mapping a été modifié au bénéfice du suivant :

<servlet-mapping> 
    <servlet-name>Jersey Web Application</servlet-name> 
    <url-pattern>/rest/*</url-pattern> ...

a. Apache CXF et l’authentification basique

Une méthode d’authentification qu’il est possible de mettre en place est équivalente à celle qui serait présente sur un serveur tournant avec Apache qui aurait une configuration de type AuthType Basic avec un fichier listant les mots de passe.

La première étape consiste à créer une implémentation de RequestHandler. Cette implémentation vérifiera la validité du nom d’utilisateur et du mot de passe fournis. En cas d’erreur, le serveur demandera une nouvelle authentification. La méthode handleRequest est la méthode invoquée à la réception d’une requête.

public class AuthenticationHandler implements RequestHandler { 
 
    @Override 
    public Response handleRequest( 
        final Message message,  
        final ClassResourceInfo resourceClass 
    ) { 
        final AuthorizationPolicy police  
                = (AuthorizationPolicy) 
                       message.get(AuthorizationPolicy.class); 
 
        if (police == null) { 
            return echec(); 
        } 
        final String nomDUtilisateur = police.getUserName(); 
        final String motDePasse = police.getPassword(); 
 
        if (verifie(nomDUtilisateur, motDePasse)) { 
            return null; 
        } 
 
        return echec(); 
    } 
 

La méthode echec retourne un code d’erreur...