7.3 Atom

Atom Syndication Format Overview

Atom is an XML-based document format that describes lists of related information known as "feeds". Feeds are composed of a number of items, known as "entries", each with an extensible set of attached metadata. For example, each entry has a title. The primary use case that Atom addresses is the syndication of Web content such as weblogs and news headlines to Web sites as well as directly to user agents.

Data Model

Apache Wink provides an Atom Syndication Format data model for consuming and producing Atom Feeds and Atom Entries (application/atom+xml). All of the model classes are located under the org.apache.wink.common.model.atom and org.apache.wink.common.model.synd packages.

Atom Feed Support

TBD

Atom Entry Support

TBD

Examples

TBD

Producing Atom Feed

TBD

    @GET
    @Produces(MediaType.APPLICATION_ATOM_XML)
    public AtomFeed getFeed() {
        AtomFeed feed = new AtomFeed();
        feed.setId("http://example.com/atomfeed");
        feed.setTitle(new AtomText("Example"));
        feed.setUpdated(new Date());
        AtomLink link1 = new AtomLink();
        ...
            
        return feed;
    }
}

Consuming Atom Feed

TBD

        @POST
    @Consumes(MediaType.APPLICATION_ATOM_XML)
    public void setFeed(AtomFeed feed) {
        ...
                
        return;
    }

Producing Atom Entry

TBD

    @GET
    @Produces(MediaType.APPLICATION_ATOM_XML)
    public AtomEntry getEntry() {
        AtomEntry entry = new AtomEntry();
        entry.setId("http://example.com/entry");
        entry.setTitle(new AtomText("Web Demo"));
        entry.getLinks().add(link2);
        entry.setUpdated(new Date());
        entry.setPublished(new Date());
        ...
        return entry;
    }

Consuming Atom Entry

TBD

    @POST
    @Consumes(MediaType.APPLICATION_ATOM_XML)
    public void setEntry(AtomEntry entry) {
        ...
                
        return;
   }

Atom Providers

Apache Wink provides a set of entity providers that are capable of mapping Atom Feed and Atom Entry XML documents to and from an Atom data model.

AtomFeedProvider

Handles reading and writing of the AtomFeedProvider class for the application/atom+xml media type.

AtomFeedSyndFeedProvider

Handles reading and writing of the AtomFeedSyndFeedProvider class for the application/atom+xml media type.

AtomFeedJAXBElementProvider

Handles reading and writing of the AtomFeedJAXBElementProvider class for the application/atom+xml media type.

AtomEntryProvider

Handles reading and writing of the AtomEntryProvider class for the application/atom+xml media type.

AtomEntrySyndEntryProvider

Handles reading and writing of the AtomEntrySyndEntryProvider class for the application/atom+xml media type.

AtomEntryJAXBElementProvider

Handles reading and writing of the AtomEntryJAXBElementProvider class for the application/atom+xml media type.

Atom Data Models

Apache Wink provides an Atom data model for consuming and producing Atom feeds and entries (application/atom+xml). All of the model classes are located under the com.hp.symphony.common.model.atom package.