Utilisation d'un contenu XML dans les demandes et les réponses d'une application JAX-RS

XML est un format de support courant que consomment et produisent les services RESTful. Pour désérialiser et sérialiser XML, vous pouvez représenter les demandes et les réponses par des objets annotés Java™ Architecture for XML Binding (JAXB).

Pourquoi et quand exécuter cette tâche

JAXB est une technologie Java qui permet aisément de mapper des classes Java et un schéma XML pour simplifier le développement des services Web. JAXB utilise la souplesse des données XML indépendantes de la plateforme des applications Java pour lier un schéma XML à des applications Java sans qu'il soit nécessaire de maîtriser la programmation XML.

Cette tâche explique comment utiliser JAXB pour désérialiser et sérialiser du contenu XML.

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 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.

  4. Implémentez une méthode de ressource utilisant des objets JAXB pour le contenu XML.
    1. Vous pouvez utiliser des objets JAXB comme paramètres d'entité de demande et d'entités de réponse avec les applications JAX-RS. Au lieu de convertir le code XML en types Java natifs et vice versa, vous pouvez utiliser des objets JAXB.
  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 (fichier d'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 développé et déployé une application Web JAX-RS sur le serveur d'applications qui utilise du contenu XML pour les demandes et les réponses.


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_xmlcontent
Nom du fichier : twbs_jaxrs_xmlcontent.html