Atom-Inhalt in JAX-RS-Anwendungsanforderungen und -antworten verwenden

Sie können Atom Syndication Format (Atom) für die Formatierung von Web-Feeds verwenden, mit denen Neuheiten und Aktualisierungen von episodischen Informationen über Websites kommuniziert werden. Mit Atom-Inhalt in JAX-RS-Anwendungen können Sie die Syndikation von Webinhalten nutzen. Diese bietet zwar dieselben dezentral organisierten, dynamischen Verfahren für das Hinzufügen neuer Metadaten und unterstützter Inhalte (mit RSS-Unterstützung), hilft jedoch, die grundlegende Interoperabilität zwischen Implementierungen zu schützen.

Informationen zu diesem Vorgang

Atom ist ein XML-basiertes Dokumentformat, das Listen mit zusammengehörigen Informationen, so genannten Feeds, beschreibt. Feeds bestehen aus einer Reihe von Einträgen, jeder davon mit einem erweiterbaren Satz angehängter Metadaten. Beispielsweise hat jeder Eintrag einen Titel. Das Atom-Format wird hauptsächlich für die Syndikation von Webinhalten, wie z. B. Webprotokolle und Schlagzeilen auf Websites, und die direkte Veröffentlichung von Inhalten in Benutzeragenten eingesetzt.

Die IBM® JAX-RS-Bibliothek stellt ein JAXB-Atom-Modell bereit, das den JAXB-Standardentitätsprovider für den Konsum und die Generierung von Atom-Feeds und Atom-Einträgen in einer JAX-RS-Anwendung verwendet.

Das JAXB-Atom-Modell ist in den Java™-Paketen " org.apache.wink.common.model.atom" und "org.apache.wink.common.model.synd" in der JAR-Datei der Apache-Wink-basierten IBM JAX-RS-Bibliothek enthalten sind. Eine Anwendung kann Klassen wie z. B. eine JAXB-annotierte Klasse "org.apache.wink.common.model.atom.AtomFeed" für Lese- und Schreibzugriffe auf ATOM-Feeds verwenden.

Vorgehensweise

  1. Konfigurieren Sie die Entwicklungsumgebung.
    1. Bevor Sie beginnen, JAX-RS-Anwendungen zu entwickeln, müssen Sie Ihre Entwicklungsumgebung einrichten, indem Sie die JAX-RS-Bibliotheken im Klassenpfad hinzufügen.
  2. Definieren Sie die Ressourcen in den JAX-RS-Webanwendungen.
    1. Ressourcen sind die Grundbausteine eines RESTful-Service. Ressourcen können statische oder dynamisch aktualisierte Daten enthalten. Im Falle einer Onlinebuchhandlung sind Ressourcen beispielsweise ein Buch, eine Bestellung von einem Geschäft, ein Benutzerverbund. Wenn Sie die Ressourcen in Ihrer Anwendung definieren, können Sie den Service effizienter machen und so gestalten, dass er einfacher entwickelt werden kann.
  3. Konfigurieren Sie die JAX-RS-Anwendung.

    Sie können JAX-RS-Anwendungen je nach Anforderungen auf unterschiedliche Weise konfigurieren. Um die Funktionen von Java Platform, Enterprise Edition (Java EE) 6 zu nutzen, können Sie die Scanfunktionen für Annotationen verwenden. Wenn Sie die Scanfunktionen für Annotationen verwenden, können Sie eine JAX-RS-Unterklasse vom Typ "javax.ws.rs.core.Application" ausschließen oder eine minimal definierte Unterklasse "javax.ws.rs.core.Application" verwenden. Alternativ können Sie das IBM JAX-RS-Servlet bzw. den IBM JAX-RS-Filter angeben, wenn Sie die im IBM JAX-RS-Servlet bzw. -Filter enthaltenen Funktionen verwenden möchten.

    Wenn Sie eine der Konfigurationsmethoden der JAX-RS Version 1.1 verwenden, können Sie eine Unterklasse "javax.ws.rs.core.Application" in Ihrer Anwendung ausschließen oder eine Unterklasse "javax.ws.rs.core.Application" verwenden, die einen leeren Satz von Klassen zurückgibt, um die JAX-RS-Laufzeitumgebung anzuweisen, alle JAX-RS-Klassen in der Anwendung zu suchen und zu verwenden. Sie können diese Methode verwenden, wenn Sie beim Entwickeln der Anwendung nicht jede relevante JAX-RS-Klasse manuell einer Unterklasse "javax.ws.rs.core.Application" hinzufügen möchten.

    Durch die Angabe des speziellen IBM JAX-RS-Servlets und -Filters können Sie bestimmte IBM JAX-RS-Verhalten nutzen und sicherstellen. Die Verwendung des IBM JAX-RS-Filters kann beispielsweise bei der Entwicklung einer Webanwendung mit einer Mischung von JAX-RS-Ressourcen und JSP-Dateien (JavaServer Pages) mit denselben URL-Mustern hilfreich sein.

    Obwohl es eine Konfigurationsmethode der JAX-RS Version V1.1 gibt, die die Verwendung einer optionalen Datei "web.xml" unterstützt, müssen Sie Integritätsbedingungen für die Sicherheit oder Rollen und andere Features, die Sie verwenden möchten und die über eine Datei "web.xml" aktiviert werden, in einer Datei "web.xml" angeben.

    Wählen Sie eine der folgenden drei Methoden aus, um Ihre JAX-RS-Anwendung zu konfigurieren:

    • JAX-RS-Anwendungen mithilfe von Methoden der JAX-RS Version 1.1 konfigurieren

      Verwenden Sie diese Methode, wenn Sie die Scanfunktionen für Annotationen oder die Konfigurationsmethoden der JAX-RS Version 1.1 verwenden möchten. Sie können die Scanfunktionen für Annotationen verwenden, um die Portierbarkeit von Anwendungen zu fördern, das Konfigurationscodevolumen zu minimieren oder die Anwendung dynamisch zu ändern, ohne Änderungen am Anwendungscode vorzunehmen.

    • Datei "web.xml" für JAX-RS-Servlets konfigurieren

      Verwenden Sie diese Methode, wenn Sie Features, die über Initialisierungsparameter für Servlets aktiviert werden, angeben möchten, um das Verhalten zu ändern und um sicherzustellen, dass Sie das IBM JAX-RS-Servlet erhalten. Wenn Sie Servlets verwenden möchten, können Sie einen Servletpfad in der Datei "web.xml" definieren, der an den Basis-URL angefügt wird.

    • Datei "web.xml" für JAX-RS-Filter konfigurieren

      Verwenden Sie diese Methode, um den Filter zu verwenden, wenn Sie JSPs, andere Servlets und Filter sowie JAX-RS-Ressourcen mit verschiedenen URL-Mustern haben. Sie können die Datei "web.xml" konfigurieren, um Filter zu definieren, die die möglichen URLs angeben, unter denen der Filter aufgerufen werden kann.

  4. JAXB-basierten ATOM-Inhalt für Anforderungen und Antworten implementieren
    1. Sie können Atom-Dokumente mit JAXB-Annotationen darstellen, weil das Atom-Format auf XML basiert. Daher kann man eine Ressourcenmethode, die Atom-Feeds und Atom-Einträge konsumiert und erstellt, dadurch implementieren, indem man ein Objekt mit JAXB-Annotationen, das das Atom-Modell verwendet, zurückgeben. Die JAX-RS-Bibliothek stellt ein auf JAXB-basiertes Atom-Modell bereit.
  5. Assemblieren Sie JAX-RS-Webanwendungen.
    1. Nachdem Sie die Java-Klassendateien für Ihre JAX-RS-Webanwendung entwickelt und die Datei "web.xml" bearbeitet haben, um das JAX-RS-Servlet zu aktivieren, können Sie die Anwendung assemblieren. Assemblieren Sie die Webanwendung in einem WAR-Paket (Webarchiv). Sie können das WAR-Paket in einem EAR-Paket (Unternehmensarchiv) assemblieren, falls dies erforderlich ist.
  6. Implementieren Sie JAX-RS-Webanwendungen.
    1. Wenn Sie die JAX-RS-Webanwendung assembliert haben, müssen Sie das WAR-Paket oder das EAR-Paket auf dem Anwendungsserver implementieren.

Ergebnisse

Sie haben eine JAX-RS-Webanwendung auf dem Anwendungsserver entwickelt und implementiert, die Atom-Inhalt für Anforderungen und Antworten verwendet.


Symbol, das den Typ des Artikels anzeigt. Taskartikel



Symbol für Zeitmarke Letzte Aktualisierung: 25.05.2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_jaxrs_atomcontent
Dateiname:twbs_jaxrs_atomcontent.html