public abstract class

AbstractFeedView

extends AbstractView
java.lang.Object
   ↳ org.springframework.context.support.ApplicationObjectSupport
     ↳ org.springframework.web.context.support.WebApplicationObjectSupport
       ↳ org.springframework.web.servlet.view.AbstractView
         ↳ org.springframework.web.servlet.view.feed.AbstractFeedView<T extends WireFeed>
Known Direct Subclasses

Class Overview

Abstract base class for Atom and RSS Feed views, using java.net's ROME package.

Application-specific view classes will typically extend from either AbstractRssFeedView or AbstractAtomFeedView instead of from this class.

Thanks to Jettro Coenradie and Sergio Bossa for the original feed view prototype!

See Also

Summary

[Expand]
Inherited Constants
From class org.springframework.web.servlet.view.AbstractView
[Expand]
Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport
From interface org.springframework.web.servlet.View
Public Constructors
AbstractFeedView()
Protected Methods
abstract void buildFeedEntries(Map<String, Object> model, T feed, HttpServletRequest request, HttpServletResponse response)
Subclasses must implement this method to build feed entries, given the model.
void buildFeedMetadata(Map<String, Object> model, T feed, HttpServletRequest request)
Populate the feed metadata (title, link, description, etc.).
abstract T newFeed()
Create a new feed to hold the entries.
final void renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)
Subclasses must implement this method to actually render the view.
[Expand]
Inherited Methods
From class org.springframework.web.servlet.view.AbstractView
From class org.springframework.web.context.support.WebApplicationObjectSupport
From class org.springframework.context.support.ApplicationObjectSupport
From class java.lang.Object
From interface org.springframework.beans.factory.BeanNameAware
From interface org.springframework.context.ApplicationContextAware
From interface org.springframework.web.context.ServletContextAware
From interface org.springframework.web.servlet.View

Public Constructors

public AbstractFeedView ()

Protected Methods

protected abstract void buildFeedEntries (Map<String, Object> model, T feed, HttpServletRequest request, HttpServletResponse response)

Subclasses must implement this method to build feed entries, given the model.

Note that the passed-in HTTP response is just supposed to be used for setting cookies or other HTTP headers. The built feed itself will automatically get written to the response after this method returns.

Parameters
model the model Map
feed the feed to add entries to
request in case we need locale etc. Shouldn't look at attributes.
response in case we need to set cookies. Shouldn't write to it.
Throws
Exception any exception that occured during building

protected void buildFeedMetadata (Map<String, Object> model, T feed, HttpServletRequest request)

Populate the feed metadata (title, link, description, etc.).

Default is an empty implementation. Subclasses can override this method to add meta fields such as title, link description, etc.

Parameters
model the model, in case meta information must be populated from it
feed the feed being populated
request in case we need locale etc. Shouldn't look at attributes.

protected abstract T newFeed ()

Create a new feed to hold the entries.

Returns
  • the newly created Feed instance

protected final void renderMergedOutputModel (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Subclasses must implement this method to actually render the view.

The first step will be preparing the request: In the JSP case, this would mean setting model objects as request attributes. The second step will be the actual rendering of the view, for example including the JSP via a RequestDispatcher.

Parameters
model combined output Map (never null), with dynamic values taking precedence over static attributes
request current HTTP request
response current HTTP response
Throws
Exception