Création d'un service Web JAX-RS

Avant de commencer

Pour déployer le service Web, vous devez disposer d'un serveur ayant la prise en charge de JVM Java™ 5.0 ou postérieur définie et démarrée. Cela comprend :
  • WebSphere Application Server version 7.0 ou version 8.0, en sélectionnant d'installer Feature Pack for Web 2.0 AND MOBILE et les outils de développement WebSphere Application Server
Par défaut, un serveur est créé lors de l'installation de WebSphere Application Server. Il est visible dans la vue Serveurs.

Si vous choisissez d'effectuer le déploiement sur un serveur autre que WebSphere Application Server, vous ne pouvez pas utiliser la bibliothèque IBM® JAX-RS et vous devez installer et configurer vos propres bibliothèque JAX-RS via la page de préférences Facettes de projet > JAX-RS.

Pour des informations détaillées sur l'utilisation de services Web JAX-RS dans WebSphere Application Server, voir le centre de documentation de WebSphere Application Server.

Créer un projet Web compatible JAX-RS

Pourquoi et quand exécuter cette tâche

Le service Web JAX-RS doit se trouver dans un projet dont la facette JAX-RS soit activée.

Procédure

  1. Dans la perspective Java EE, cliquez avec le bouton droit de la souris sur votre projet d'application d'entreprise, puis sélectionnez Nouveau > Projet Web pour l'assistant de projet Web.
  2. Dans la zone Nom, tapez un nom pour votre projet Web.
  3. Dans la section Modèles de projet, sélectionnez le type de modèle Web que vous voulez utiliser : sélectionnez Simple pour créer un projet Web simple.
  4. Dans la section Modèle de programmation, sélectionnez le modèle que vous souhaitez utiliser : sélectionnez Modèle de programmation Java EE. Cliquez sur Suivant pour configurer votre nouveau projet Web.
  5. Dans la page Déploiement, depuis la liste des options de configuration disponibles, cliquez sur Déploiement pour ouvrir la page Configuration du déploiement.
    • Vous pouvez changer l'environnement d'exécution cible en sélectionnant celui de votre choix dans la zone déroulante. Cliquez sur Changer les fonctions pour ouvrir la fenêtre Facettes de projet. Sur la page Facettes du projet, sélectionnez JAX-RS (services Web REST), puis cliquez sur OK.
    • Cliquez sur Ajouter une prise en charge pour les liaisons et extensions WebSphere ou effacez cette zone.
    • Dans la zone Version de module Web, sélectionnez la version que vous souhaitez utiliser.
    • Dans la zone Appartenance EAR, cliquez sur Ajouter le projet à un fichier EAR si vous voulez inclure l'appartenance EAR ; effacez cette zone si vous ne voulez pas ajouter le projet Web à un fichier EAR.
    • Dans la zone Nom du projet EAR, vous voyez apparaître le nom de votre fichier EAR existant. Vous pouvez cliquer sur Parcourir pour sélectionner un fichier EAR différent.
    Remarque : L'option de déploiement n'est pas disponible si vous avez sélectionné le modèle de programmation Côté client uniquement pour votre nouveau projet Web.
  6. Dans la liste des options de configuration disponibles, cliquez sur Services REST.
    1. Dans la zone Bibliothèque d'implémentation JAX-RS, sélectionnez la bibliothèque correspondant à votre version de serveur, par exemple IBM WebSphere Application Server v8.0 JAX-RS Library ou IBM WebSphere Application Server v8.5 JAX-RS Library.
      Complément sur les bibliothèques : Cette liste déroulante contient les bibliothèques JAX-RS de tous les environnements de test WebSphere installés. Si vous voulez utiliser une bibliothèque non-WebSphere, vous pouvez l'importer via la page de préférences Bibliothèques utilisateur. Si vous sélectionnez Bibliothèque utilisateur, vous pouvez ouvrir cette page de préférences et ajouter une bibliothèque. Après la création d'un projet, vous pouvez changer la bibliothèque associée en cliquant sur le projet avec le bouton droit et en sélectionnant Préférences > Facettes du projet > JAX-RS. Vous pouvez également demander que l'assistant ne définisse pas la bibliothèque pour vous, auquel cas vous devez définir manuellement le chemin d'accès aux classes.
    2. Si vous utilisez une version de WebSphere Application Server antérieure à la version 8, cochez la case Inclure la bibliothèque avec cette application et choisissez de l'inclure comme Bibliothèque partagée. Ainsi, les fichiers jar JAX-RS sont ajoutés au chemin d'accès aux classes, ainsi qu'une entrée Bibliothèque partagée dans le fichier EAR amélioré.
    3. L'option Mettre à jour le descripteur de déploiement est cochée par défaut car vous devrez utiliser un fichier web.xml pour configurer les contraintes de sécurité et autre comportement. Un fichier web.xml sera généré et mis à jour avec les informations de servlet JAX-RS même si vous avez choisi de ne pas générer de descripteur de déploiement précédemment dans l'assistant. Cette option n'est disponible que si la facette Modules Web sélectionnée est la version 3.0 ou supérieure.
    4. Si vous avez choisi de mettre à jour le descripteur de déploiement, vous pourrez changer le nom de servlet et le nom de classe de servlet, ainsi que les modèles de mappage d'URL.
  7. Vous pouvez changer l'environnement d'exécution cible en sélectionnant celui de votre choix dans la zone déroulante. Cliquez sur Changer les fonctions pour ouvrir la fenêtre Facettes du projet.
    • Dans la zone Dossiers source dans le chemin de génération, vous pouvez soit accepter le répertoire par défaut src, soit cliquer sur Ajouter un dossier, Editer... ou Supprimer pour indiquer un dossier pour vos fichiers source.
    • Dans la zone Dossier de sortie par défaut :, indiquez un dossier pour vos fichiers de sortie ou acceptez la valeur par défaut (WebContent\WEB-INF\classes).
  8. Dans la liste des options de configuration disponibles, cliquez sur Module Web. Dans la page Configuration de module Web :
    • Dans la zone Racine du contexte, tapez le nom de la racine de votre projet Web ou acceptez la valeur par défaut (c'est-à-dire le nom de votre projet Web).
    • Dans la zone Répertoire de contenu, entrez le nom de votre répertoire de contenu ou acceptez la valeur par défaut (WebContent).
    • Si vous voulez créer un descripteur de déploiement, sélectionnez Générer un descripteur de déploiement web.xml. Vous pouvez aussi ajouter un descripteur de déploiement à votre module Web ultérieurement.
  9. Cliquez sur Terminer.

Créer un service Web JAX-RS

Procédure

  1. Dans votre projet Web, créez un package (cliquez avec le bouton droit sur Ressources Java > src et sélectionnez Nouveau > Package). Importez les classes pour le service Web dans le package.
  2. Ouvrez WebContent/WEB-INF/web.xml. Dans la vue Conception, sélectionnez le servlet JAX-RS, cliquez sur Ajouter et ajoutez un paramètre d'initialisation au servlet, en laissant les zones de nom et de valeur vides. Enregistrez web.xml en ignorant les erreurs éventuelles affichées.
  3. Dans la vue Marqueurs, sélectionnez l'erreur de web.xml sur le nom de paramètre, cliquez avec le bouton droit et sélectionnez Correction rapide. Naviguez jusqu'à l'application et sélectionnez-la.
  4. Ajoutez le fichier EAR contenant le projet JAX-RS au serveur et démarrez celui-ci.

Résultats

Toute application Web doit avoir une racine de contexte pour pourvoir se déployer. Une racine de contexte est définie pour chaque module Web dans le descripteur de déploiement de l'application au cours de l'assemblage de l'application ou de son déploiement. La racine de contexte est combinée au mappage de servlet défini issu du fichier WAR pour composer l'URL complète que tapent les utilisateurs pour accéder au servlet. La racine de contexte de chaque application Web déployée doit être unique sur le serveur. Elle peut également être vide.

Par exemple, si une application Web utilise comme racine de contexte sample/application/, l'URL de demande de l'application commence par http://<nomhôte>:<port>/sample/application/. Le modèle d'URL d'un servlet est ajouté à la racine de contexte de l'application Web. Par exemple, si la racine de contexte est sample/application/ et que le mappage d'URL du servlet est rest/api/*, l'URI de base pour l'application Web JAX-RS est http://<nomhôte>:<port>/sample/application/rest/api.

Edition d'un projet JAX-RS

Après avoir créé un service Web JAX-RS, vous pouvez le modifier en cliquant sur le projet avec le bouton droit et en sélectionnant Propriétés > Facettes du projet > JAX-RS. Sur cette page, vous pouvez changer :
  • le type de bibliothèque
  • le nom du servlet JAX-RS
  • le nom de classe du servlet JAX-RS
  • les modèles de mappage d'URL
Par exemple, si vous migrez un projet sur un autre serveur, vous pouvez remplacer le fournisseur de bibliothèques par un qui soit supporté par le nouveau serveur.
Icône indiquant le type de rubrique Rubrique de tâche
Dispositions pour les centres de documentation | Commentaires en retour

Icône d'horodatage Dernière mise à jour: May 29, 2014 10:11

Nom de fichier : tjaxrswebservcreate.html