Vous pouvez implémenter des gestionnaires sur le serveur d'une application Java™ API for RESTful Web Services
(JAX-RS) pour améliorer le traitement des demandes et des réponses.
Pourquoi et quand exécuter cette tâche
Pour exécuter des opérations supplémentaires sur les messages, vous pouvez créer un gestionnaire appliqué au cours du traitement d'une demande ou d'une réponse. Les gestionnaires sont appelés à chaque demande et réponse.
Les gestionnaires de demande personnalisés côté serveur sont appliqués après avoir trouvé la méthode de ressource. Ces gestionnaires sont appliqués avant l'envoi de la réponse au client.
Il existe trois chaînes de gestionnaires distinctes : une chaîne de gestionnaires de demande, une chaîne de gestionnaires de réponse et une chaîne de gestionnaires d'erreur. Les demandes normales appellent la chaîne de gestionnaires de demande pour rechercher la ressource et appeler la méthode de ressource.
Ensuite, la chaîne de gestionnaires de demande remplit les en-têtes de réponse et le contenu. Si une erreur se produit, la chaîne de gestionnaires d'erreur est appelée.
Ce dernier appelle le mécanisme de gestion des erreurs JAX-RS et remplit les en-têtes de réponse et le contenu.
Il existe des gestionnaires système et des gestionnaires utilisateur. Les gestionnaires système implémentent l'environnement d'exécution principal de IBM® JAX-RS.
Vous pouvez écrire des gestionnaires utilisateur pour personnaliser le comportement de la chaîne de gestionnaires de l'application JAX-RS et ajouter une fonctionnalité unique au gestionnaire.
- Configurez l'environnement de développement.
- Avant de développer des applications JAX-RS, vous devez configurer l'environnement de déploiement en ajoutant les bibliothèques JAX-RS dans le chemin d'accès aux classes.
- Définissez les ressources dans les applications Web JAX-RS.
- Les ressources sont les principaux blocs fonctionnels d'un service RESTful. Les ressources peuvent contenir des données statiques ou mises à jour dynamiquement.
Un manuel, une commande et une collection d'utilisateurs sont des exemples de ressources d'une application de librairie en ligne. En identifiant les ressources dans l'application, vous améliorez l'utilité du service et facilitez son développement.
- Configurez l'application JAX-RS.
Vous pouvez configurer les applications JAX-RS de plusieurs façons, selon vos besoins.
Pour tirer parti de la fonctionnalité
Java EE (Java Platform, Enterprise Edition) 6, vous pouvez
utiliser les fonctions d'analyse des annotations.
L'analyse des annotations permet d'ignorer une sous-classe JAX-RS
javax.ws.rs.core.Application ou de disposer d'une sous-classe javax.ws.rs.core.Application à définition minimale. Sinon, vous pouvez aussi spécifier le servlet ou le filtre IBM JAX-RS si vous préférez utiliser la fonction qu'ils contiennent.
En employant l'une des méthodes de configuration JAX-RS version 1.1, vous pouvez ignorer une sous-classe javax.ws.rs.core.Application dans votre application ou disposer d'une sous-classe javax.ws.rs.core.Application qui renvoie un ensemble vide de classes pour informer
l'environnement d'exécution JAX-RS qu'il doit détecter et utiliser toutes les classes JAX-RS de l'application. Cette méthode vous évite de
devoir ajouter manuellement chaque classe JAX-RS appropriée à une sous-classe javax.ws.rs.core.Application lors du développement de
l'application.
En indiquant le servlet ou le filtre IBM JAX-RS spécifique, vous pouvez bénéficier d'un comportement IBM JAX-RS particulier et le garantir. Par exemple, l'utilisation du filtre IBM JAX-RS peut faciliter le développement d'une application Web faisant appel à un mélange de ressources JAX-RS et de fichiers JSP (JavaServer Pages) avec les mêmes modèles d'URL.
Bien qu'une méthode de configuration JAX-RS version 1.1 prenne en charge le fichier web.xml facultatif, ce dernier est
obligatoire pour indiquer des contraintes ou des rôles de sécurité ou pour tirer parti de fonctions activées avec un fichier web.xml.
Choisissez l'une des trois méthodes suivantes pour configurer votre application JAX-RS :
- Configuration
d'applications JAX-RS selon les méthodes JAX-RS 1.1
Utilisez cette méthode
pour employer les fonctions d'analyse des annotations ou les méthodes de configuration JAX-RS 1.1. Vous pouvez
utiliser les fonctions d'analyse des annotations pour promouvoir la portabilité de l'application, réduire la quantité de code de
configuration ou modifier l'application dynamiquement sans changer son code.
- Configurez le fichier web.xml pour les servlets JAX-RS
Utilisez cette
méthode pour indiquer des fonctions activées à l'aide des paramètres d'initialisation du servlet, afin d'obtenir un changement de
comportement et le servlet IBM JAX-RS. Lorsque vous utilisez des servlets, vous pouvez définir un chemin de servlet dans le fichier web.xml qui est ajouté à l'URL de base.
- Configuration du fichier web.xml pour les filtres JAX-RS
Utilisez cette méthode pour employer le filtre lorsque vous avez des fichiers JSP, d'autres servlets et filtres ainsi que des ressources
JAX-RS incluant plusieurs masques d'URL. Vous pouvez configurer le fichier web.xml pour définir les filtres qui indiquent les adresses
URL sur lesquelles ils peuvent être appelés.
- Implémentez les gestionnaires utilisateur de l'application JAX-RS.
- Vous pouvez développer des gestionnaires utilisateur pour personnaliser le comportement d'une chaîne de gestionnaires et ajouter une fonctionnalité unique au gestionnaire.
En implémentant des gestionnaires utilisateur sur les serveur des applications JAX-RS, vous améliorez le traitement des demandes et des réponses.
- Assemblez les applications Web JAX-RS.
- Après avoir développé les fichiers de classe Java de l'application Web JAX-RS et modifié le fichier web.xml pour activer le servlet JAX-RS, vous pouvez assembler l'application.
Assemblez-la dans un package WAR (archive WAR). Vous pouvez assembler le package WAR dans un package EAR (fichier d'archive d'entreprise), le cas échéant.
- Déployez les applications Web JAX-RS.
- Après avoir assemblé l'application Web JAX-RS, vous devez déployer le package WAR (fichier d'archive Web) ou EAR (fichier d'archive d'entreprise) sur le serveur d'applications.