Utilisation de la négociation de contenu pour gérer plusieurs types de contenu dans les applications JAX-RS

L'un des avantages des applications RESTful résident dans le fait qu'elles donnent la possibilité de retourner des représentations différentes des ressources. Avec REST (Representational State Transfer), les clients et les serveurs peuvent échanger des ressource d'un même type de support ou utiliser des types de supports différents. La négociation de contenu permet aux clients et aux serveurs de s'accorder sur le format du contenu utilisé dans l'échange des données.

Pourquoi et quand exécuter cette tâche

Les ressources sont représentées par un grand nombre de formats différents XML, JavaScript Object Notation (JSON), Atom, plain text, PNG, JPEG, GIF et des formats personnalisés ou propriétaires sont utilisés pour représenter les ressources. REST (Representational State Transfer) offre la possibilité de représenter une même ressource dans plusieurs formats.

Selon les besoins de votre application, les ressources peuvent retourner les représentations dans un seul format ou dans différents formats, en fonction de la demande. Par exemple, les ressources faisant l'objet d'un accès en utilisant des clients JavaScript peuvent préférer les représentations JSON, car JSON est simple à consommer. Toutefois, d'autres clients préfèrent XML.

Utilisez la négociation de contenu si vous voulez fournir plusieurs formats aux clients. La négociation de contenu est la méthode dans laquelle le client et le serveur s'accordent sur le type de contenu de réponse à utiliser. Il existe trois types de négociations de contenu qui affectent la réponse. Vous pouvez utiliser la négociation de contenu dans l'URL, en fonction d'un paramètres de demande ou en fonction des en-têtes HTTP.

Procédure

  1. Configurez l'environnement de développement.
    1. 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.
  2. Définissez les ressources dans les applications Web JAX-RS.
    1. 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.
  3. 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 peut être utile pour ne pas avoir à ajouter manuellement chaque classe JAX-RS pertinente à une sous-classe javax.ws.rs.core.Application au cours 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.

    • Configuration du 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.

  4. Implémentez la négociation de contenu pour gérer plusieurs types de contenus. Utilisez la négociation de contenu pour déterminer la meilleure représentation de ressource que le serveur doit retourner au client. Vous pouvez implémenter la négociation de contenu en fonction de modèles d'URL, de paramètres de demande ou d'en-têtes HTTP.
  5. Assemblez les applications Web JAX-RS.
    1. 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 (archive d'entreprise), le cas échéant.
  6. Déployez les applications Web JAX-RS.
    1. 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.

Résultats

Vous avez implémenté la négociation de contenu pour déterminer les formats des ressources pour représenter les données.


Icône indiquant le type de rubrique Rubrique de tâche



Icône d'horodatage Dernière mise à jour: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_jaxrs_contentnegotiation
Nom du fichier : twbs_jaxrs_contentnegotiation.html