root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Add REST feed view docs, included edits from Thomas R.

This commit is contained in:
Mark Pollack 2009-04-13 22:11:15 +00:00
parent 2f5ba83416
commit 7f06639be2
2 changed files with 95 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
spring-framework-reference/src/rest.xml
View File

@ -309,7 +309,94 @@ public class ContentController {
<section id="rest-views">
<title>Views</title>
<para>blah</para>
<para>Several views were added to Spring 3 to help support creating
RESTful services. They are:</para>
<itemizedlist>
<listitem>
<para><classname>AbstractAtomFeedView</classname> - return an Atom
feed</para>
</listitem>
<listitem>
<para><classname>AbstractRssFeedView</classname> - returns a RSS
feed</para>
</listitem>
<listitem>
<para><classname>MarshallingView</classname> - returns an XML
representation using Spring's Objecct/XML mapping (OXM)
functionality</para>
</listitem>
</itemizedlist>
<para>Available separately is the <classname>JacksonJsonView</classname>
included as part of the Spring JavaScript project.</para>
<section id="rest-feedview">
<title>Feed Views</title>
<para>Both <classname>AbstractAtomFeedView</classname> and
<classname>AbstractRssFeedView</classname> inherit from the base class
<classname>AbstractFeedView&lt;T&gt;</classname> and are used to
provide Atom and RSS Feed views respectfully. They are based on
java.net's <ulink url="https://rome.dev.java.net">ROME</ulink> project
and located in the package org.springframework.web.servlet.view.feed.
The <classname>AbstractAtomFeedView</classname> requires you to
implement the <methodname>buildFeedEntries</methodname> method and
optionally override the <methodname>buildFeedMetadata</methodname>
method (the default implementation is empty), as shown below</para>
<programlisting>public class SampleContentAtomView extends AbstractAtomFeedView {
@Override
protected void buildFeedMetadata(Map&lt;String, Object&gt; model, Feed feed, HttpServletRequest request) {
// implementation omitted
}
@Override
protected List&lt;Entry&gt; buildFeedEntries(Map&lt;String, Object&gt; model,
HttpServletRequest request, HttpServletResponse response) throws Exception {
// implementation omitted
}
}</programlisting>
<para>Similar requirements apply for implementing
<classname>AbstractRssFeedView</classname>, as shown below</para>
<programlisting>public class SampleContentAtomView extends AbstractRssFeedView {
@Override
protected void buildFeedMetadata(Map&lt;String, Object&gt; model, Channel feed, HttpServletRequest request) {
// implementation omitted
}
@Override
protected List&lt;Item&gt; buildFeedItems(Map&lt;String, Object&gt; model,
HttpServletRequest request, HttpServletResponse response) throws Exception {
// implementation omitted
}
}</programlisting>
<para>The <methodname>buildFeedItems</methodname> and
<methodname>buildFeedEntires</methodname> pass in the HTTP request in
case you need to access the Locale. The HTTP response in passed in
only for the setting of cookies or other HTTP headers. The feed will
automatically be written to the response object after the method
returns. </para>
<para>For an example implementation of creating a Atom view please
refer to Alef Arendsen's SpringSource TeamBlog <ulink
url="http://blog.springsource.com/2009/03/16/adding-an-atom-view-to-an-application-using-springs-rest-support/">entry</ulink>.</para>
</section>
<section>
<title>XML Marshalling View</title>
<para>The MarhsallingView</para>
</section>
</section>
<section id="rest-method-conversion">
@ -443,7 +530,7 @@ public String deletePet(@PathVariable int ownerId, @PathVariable int petId) {
<para></para>
</section>
<section label="rest-marhsalling-converter">
<section id="rest-marhsalling-converter">
<title>MarshallingHttpMessageConverter</title>
<para></para>

6
spring-framework-reference/src/spring-framework-reference.xml
View File

@ -19,8 +19,8 @@
<!ENTITY oxm SYSTEM "oxm.xml">
<!ENTITY mvc SYSTEM "mvc.xml">
<!ENTITY view SYSTEM "view.xml">
<!ENTITY web-integration SYSTEM "web-integration.xml">
<!ENTITY rest SYSTEM "rest.xml">
<!ENTITY web-integration SYSTEM "web-integration.xml">
<!ENTITY portlet SYSTEM "portlet.xml">
<!ENTITY remoting SYSTEM "remoting.xml">
<!ENTITY ejb SYSTEM "ejb.xml">
@ -289,6 +289,9 @@
<listitem>
<para><xref linkend="view"/></para>
</listitem>
<listitem>
<para><xref linkend="rest"/></para>
</listitem>
<listitem>
<para><xref linkend="web-integration"/></para>
</listitem>
@ -299,6 +302,7 @@
</partintro>
&mvc;
&view;
&rest;
&web-integration;
&rest;
&portlet;