Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Info
titleImportant Note

The Atom Syndication Format data model can also be used to produce Atom Feeds and Atom Entries in HTML (text/html) and JSON (application/json) formats. For more details regarding HTML see section HTML (TBD). For JSON format see section (TBD)

Atom Feed Support

TBDThe following table shows the Atom Feed data models and the representations in which the Atom data models can be serialized and de-serialized.

 

Supported

Media Types

Data Model

Provider registration

Read

Yes

application/atom+xml

org.apache.wink
.common.model
.atom.AtomFeed

org.apache.wink
.common.model
.synd.SyndFeed

Not required. Registered by default

Write

Yes

application/atom+xml

org.apache.wink
.common.model
.atom.AtomFeed

org.apache.wink
.common.model
.synd.SyndFeed

Not required. Registered by default

Atom Entry Support

TBDThe following table shows the Atom Entry data models and the representations in which it can be serialized and de-serialized.

 

Supported

Media Types

Data Model

Provider registration

Read

Yes

application/atom+xml

org.apache.wink
.common.model
.atom.AtomEntry

org.apache.wink
.common.model
.synd.SyndEntry

Not required. Registered by default

Write

Yes

application/atom+xml

org.apache.wink
.common.model
.atom.AtomEntry

org.apache.wink
.common.model
.synd.SyndEntry

Not required. Registered by default

Examples

TBDThe following code example demonstrates reading and writing of Atom Feeds  and Atom Entries.

Producing Atom Feed

TBDThe following code example demonstrates the creation of an Atom Feed.

Code Block
    @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

TBDThe following code example demonstrates the consumption of an Atom Feed.

Code Block
        @POST
    @Consumes(MediaType.APPLICATION_ATOM_XML)
    public void setFeed(AtomFeed feed) {
        ...

        return;
    }

Producing Atom Entry

TBDThe following code example demonstrates the creation of an Atom Entry.

Code Block
    @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

TBDThe following code example demonstrates the consumption of an Atom Entry.

Code Block
    @POST
    @Consumes(MediaType.APPLICATION_ATOM_XML)
    public void setEntry(AtomEntry entry) {
        ...

        return;
   }