Génération d'exemple de code client pour une ressource JAX-RS 2.0

Vous pouvez générer un exemple de code client pour une ressource JAX-RS (Java™ API for RESTful Web Services) depuis une adresse de projet REST.

Avant de commencer

Important : Applicable à Liberty
Effectuez la procédure suivante pour WebSphere Application Server Developer Tools for Eclipse :
  • Ajoutez le contexte d'exécution Liberty aux préférences.
  • Créez un serveur Liberty dans la vue Serveurs.
  • Créez un projet Web avec un ou plusieurs services REST définis dans le projet. Si vous ne définissez pas de services, le noeud REST est dépourvu d'enfants.

Procédure

  1. Développez votre_projet_REST > Services > REST.
  2. Cliquez avec le bouton droit de la souris sur l'adresse ou sur l'un de ses enfants et sélectionnez Générer > Client JAX-RS. La boîte de dialogue Client JAX-RS 2.0 s'affiche.
    1. Dans la zone Dossier source, acceptez la valeur par défaut ou spécifiez le dossier de destination du client généré.
    2. Dans la zone Nom, acceptez la valeur par défaut ou spécifiez le nom de classe Java du client.
    3. Dans la zone Package, acceptez la valeur par défaut ou spécifiez le nom de package Java du client.
    4. Sélectionnez les ressources que vous désirez utiliser pour générer le code client.
    5. Générez une nouvelle classe de filtre.
      1. Sélectionnez Generate JAX-RS Client Filter.
      2. Acceptez la valeur par défaut ou spécifiez le nom de la classe de filtre.

      Cette option crée une classe élémentaire qui implémente les interfaces ClientRequestFilter et ClientResponseFilter du package JAX-RS 2.0 javax.ws.rs.client. Vous pouvez compléter les détails de l'implémentation pour les méthodes d'interface après avoir généré la nouvelle classe de filtre.

  3. Facultatif : Pour générer des classes JAXB et le client dans le même projet, sélectionnez Use XML Schema for JAXB Generation.

    La méthode de ressource du service JAX-RS peut avoir des classes JAXB comme arguments de méthode ou des types de retour. Si vous ne disposez pas de la source JAXB, mais disposez du schéma XML, vous pouvez générer les classes JAXB afin que votre code client puisse y accéder.

    1. Cliquez sur Suivant.

      La boîte de dialogue JAX-RS Client with JAXB s'affiche.

    2. Facultatif : Dans la zone JAXB Target Java Package, indiquez le package Java à utiliser pour les classes JAXB générées.

      Cette valeur est transmise au compilateur de liaisons, ou à l'outil XJC (Java Architecture for XML Binding Compiler), avec l'option -p.

    3. Cliquez sur Parcourir... pour rechercher le fichier XSD depuis lequel vous désirez générer la classe JAXB.

      Vous pouvez également indiquer le fichier XSD dans la zone Schéma XML. Cette valeur est transmise au compilateur de liaisons, ou à l'outil XJC, avec l'option -b.

    4. Facultatif : Pour soumettre des fichiers de liaison JAXB définis par l'utilisateur, sélectionnez Specify JAXB binding files.

      Si vous sélectionnez cette option, vous pouvez cliquer sur Ajouter pour ajouter des fichiers de déclaration de liaison personnalisés. Vous pouvez également retirer des fichiers en les mettant en évidence, puis en sélectionnant Retirer.

    5. Facultatif : Pour autoriser les extensions fournisseur, sélectionnez Autoriser les extensions de fournisseurs tiers.

      Cette sélection peut s'avérer nécessaire pour le traitement de certains documents de schéma XML. Cette valeur est transmise au compilateur de liaisons, ou à l'outil XJC, avec l'option -extension.

  4. Cliquez sur Terminer.

Résultats

Vous avez généré un exemple de code client pour une ressource JAX-RS.

Si vous avez complété l'étape facultative de génération de classes JAXB, vous avez également généré des classes JAXB dans le même projet que votre client JAX-RS.

Vous avez aussi généré un nouveau fichier de classe Java à l'aide de l'API Client JAX-RS 2.0 qui peut être utilisé pour accéder au service JAX-RS. Chaque méthode annotée du service JAX-RS dispose d'une méthode client JAX-RS correspondante, laquelle est générée depuis les annotations sur les méthodes du service JAX-RS. Les méthodes du service JAX-RS incluent @PathParam; @QueryParam; @Consumes; @Produces; @Path; ainsi que des méthodes de ressource telles que @GET, @PUT ou @POST.

Restriction : Toutes les classes affectées par l'algorithme de génération de client JAX-RS doivent respecter les restrictions suivantes :
  • Ces classes doivent être de type chaîne, primitive, classe d'API JAX-RS, ou une classe utilisateur annotée par JAXB (Java Architecture for XML Binding). Ces classes ne peuvent pas être de type binaire.
  • Toutes les classes doivent être au format source pour que l'algorithme puisse les localiser. Si les classes ne font pas partie du même projet que le service JAX-RS, le client JAX-RS ne peut pas être généré.

Que faire ensuite

Ajoutez du code à l'exemple afin que le code client fonctionne et réponde aux besoins de votre code client JAX-RS 2.0. Pour tester l'exemple, ajoutez le code client à une page JSP ou à un servlet. Votre client doit résider dans un conteneur de servlet en raison de l'absence de prise en charge d'applications Java autonomes. Une fois que vous disposez d'un code client JAX-RS 2.0 fonctionnel, utilisez-le pour lancer le service JAX-RS 2.0.
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: t_jaxrs_scc_jaxrs.html