public abstract class

AbstractAtomFeedView

extends AbstractFeedView<T extends WireFeed>

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>
				↳	org.springframework.web.servlet.view.feed.AbstractAtomFeedView

Class Overview

Abstract superclass for Atom Feed views, using java.net's ROME package.

Application-specific view classes will extend this class. The view will be held in the subclass itself, not in a template.

Main entry points are the buildFeedMetadata(Map, WireFeed, HttpServletRequest) and buildFeedEntries(Map, HttpServletRequest, HttpServletResponse).

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

Summary

Constants
String	DEFAULT_FEED_TYPE

[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
	AbstractAtomFeedView()

Public Methods
void	setFeedType(String feedType) Sets the Rome feed type to use.

Protected Methods
abstract List<Entry>	buildFeedEntries(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to build feed entries, given the model.
final void	buildFeedEntries(Map<String, Object> model, Feed feed, HttpServletRequest request, HttpServletResponse response) Invokes `buildFeedEntries(Map, HttpServletRequest, HttpServletResponse)` to get a list of feed entries.
Feed	newFeed() Create a new Feed instance to hold the entries.

[Expand]

Inherited Methods

From class org.springframework.web.servlet.view.feed.AbstractFeedView

From class org.springframework.web.servlet.view.AbstractView

void	addStaticAttribute(String name, Object value) Add static data to this view, exposed in each view.
RequestContext	createRequestContext(HttpServletRequest request, HttpServletResponse response, Map<String, Object> model) Create a RequestContext to expose under the specified attribute name.
ByteArrayOutputStream	createTemporaryOutputStream() Create a temporary OutputStream for this view.
void	exposeModelAsRequestAttributes(Map<String, Object> model, HttpServletRequest request) Expose the model objects in the given map as request attributes.
boolean	generatesDownloadContent() Return whether this view generates download content (typically binary content like PDF or Excel files).
Map<String, Object>	getAttributesMap() Allow Map access to the static attributes of this view, with the option to add or override specific entries.
String	getBeanName() Return the view's name.
String	getContentType() Return the content type for this view.
String	getRequestContextAttribute() Return the name of the RequestContext attribute, if any.
Map	getStaticAttributes() Return the static attributes for this view.
void	prepareResponse(HttpServletRequest request, HttpServletResponse response) Prepare the given response for rendering.
void	render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response) Prepares the view given the specified model, merging it with static attributes and a RequestContext attribute, if necessary.
abstract void	renderMergedOutputModel(Map<String, Object> model, HttpServletRequest request, HttpServletResponse response) Subclasses must implement this method to actually render the view.
void	setAttributes(Properties attributes) Set static attributes for this view from a `java.util.Properties` object.
void	setAttributesCSV(String propString) Set static attributes as a CSV string.
void	setAttributesMap(Map<String, ?> attributes) Set static attributes for this view from a Map.
void	setBeanName(String beanName) Set the view's name.
void	setContentType(String contentType) Set the content type for this view.
void	setRequestContextAttribute(String requestContextAttribute) Set the name of the RequestContext attribute for this view.
String	toString()
void	writeToResponse(HttpServletResponse response, ByteArrayOutputStream baos) Write the given temporary OutputStream to the HTTP response.

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

Constants

public static final String DEFAULT_FEED_TYPE

Constant Value: "atom_1.0"

Public Constructors

public AbstractAtomFeedView ()

Public Methods

public void setFeedType (String feedType)

Sets the Rome feed type to use.

Defaults to Atom 1.0.

Protected Methods

protected abstract List<Entry> buildFeedEntries (Map<String, Object> model, 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
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.

Returns

the feed entries to be added to the feed

Throws

Exception	any exception that occured during document building

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

Invokes buildFeedEntries(Map, HttpServletRequest, HttpServletResponse) to get a list of feed entries.

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

protected Feed newFeed ()

Create a new Feed instance to hold the entries.

By default returns an Atom 1.0 feed, but the subclass can specify any Feed.

Returns

the newly created Feed instance

Classes

AbstractAtomFeedView

Class Overview

See Also

Summary

Constants

public static final String DEFAULT_FEED_TYPE

Public Constructors

public AbstractAtomFeedView ()

Public Methods

public void setFeedType (String feedType)

See Also

Protected Methods

protected abstract List<Entry> buildFeedEntries (Map<String, Object> model, HttpServletRequest request, HttpServletResponse response)

Parameters

Returns

Throws

See Also

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

Parameters

Throws

protected Feed newFeed ()

Returns

See Also