org.dspace.app.util

Class SyndicationFeed

java.lang.Object

org.dspace.app.util.SyndicationFeed

public class SyndicationFeed
extends Object

Invoke ROME library to assemble a generic model of a syndication for the given list of Items and scope. Consults configuration for the metadata bindings to feed elements. Uses ROME's output drivers to return any of the implemented formats, e.g. RSS 1.0, RSS 2.0, ATOM 1.0. The feed generator and OpenSearch call on this class so feed contents are uniform for both.

Author:

Larry Stone

Field Summary

Fields

Modifier and Type	Field and Description
protected String	authorField
protected String	baseURL
protected CollectionService	collectionService
protected CommunityService	communityService
protected String	dateField
protected String	dcCreatorField
protected String	dcDateField
protected String	dcDescriptionField
protected String	defaultAuthorField
protected String	defaultDateField
protected String	defaultExternalMedia
protected String	defaultTitleField
protected String	externalSourceField
protected com.sun.syndication.feed.synd.SyndFeed	feed
protected ItemService	itemService
protected org.apache.log4j.Logger	log
static String	MSG_FEED_DESCRIPTION
static String	MSG_FEED_TITLE
static String	MSG_LOGO_TITLE
static String	MSG_METADATA
static String	MSG_UITYPE
static String	MSG_UNTITLED i18n key values
protected String[]	podcastableMIMETypes
protected javax.servlet.http.HttpServletRequest	request
protected String	titleField
protected String	uiType
static String	UITYPE_JSPUI
static String	UITYPE_XMLUI

Constructor Summary

Constructors

Constructor and Description
SyndicationFeed(String ui) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addModule(com.sun.syndication.feed.module.Module m) Add a ROME plugin module (e.g.
protected static String	getDefaultedConfiguration(String key, String dfl)
static String[]	getDescriptionSelectors() Returns list of metadata selectors used to compose the description element
protected String	getOneDC(Item item, String field)
protected String	localize(Map<String,String> labels, String s)
void	output(Writer writer) send the output to designated Writer
String	outputString()
Document	outputW3CDom()
void	populate(javax.servlet.http.HttpServletRequest request, Context context, DSpaceObject dso, List<? extends DSpaceObject> items, Map<String,String> labels) Fills in the feed and entry-level metadata from DSpace objects.
protected String	resolveURL(javax.servlet.http.HttpServletRequest request, DSpaceObject dso) Return a url to the DSpace object, either use the official handle for the item or build a url based upon the current server.
void	setType(String feedType) Sets the feed type for XML delivery, e.g.
protected String	urlOfBitstream(javax.servlet.http.HttpServletRequest request, Bitstream logo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected final org.apache.log4j.Logger log

MSG_UNTITLED

public static final String MSG_UNTITLED

i18n key values

See Also:

Constant Field Values

MSG_LOGO_TITLE

public static final String MSG_LOGO_TITLE

See Also:

Constant Field Values

MSG_FEED_TITLE

public static final String MSG_FEED_TITLE

See Also:

Constant Field Values

MSG_FEED_DESCRIPTION

public static final String MSG_FEED_DESCRIPTION

See Also:

Constant Field Values

MSG_METADATA

public static final String MSG_METADATA

See Also:

Constant Field Values

MSG_UITYPE

public static final String MSG_UITYPE

See Also:

Constant Field Values

UITYPE_XMLUI

public static final String UITYPE_XMLUI

See Also:

Constant Field Values

UITYPE_JSPUI

public static final String UITYPE_JSPUI

See Also:

Constant Field Values

defaultTitleField

protected String defaultTitleField

defaultAuthorField

protected String defaultAuthorField

defaultDateField

protected String defaultDateField

defaultExternalMedia

protected String defaultExternalMedia

titleField

protected String titleField

dateField

protected String dateField

authorField

protected String authorField

externalSourceField

protected String externalSourceField

dcCreatorField

protected String dcCreatorField

dcDateField

protected String dcDateField

dcDescriptionField

protected String dcDescriptionField

podcastableMIMETypes

protected String[] podcastableMIMETypes

feed

protected com.sun.syndication.feed.synd.SyndFeed feed

uiType

protected String uiType

request

protected javax.servlet.http.HttpServletRequest request

collectionService

protected CollectionService collectionService

communityService

protected CommunityService communityService

itemService

protected ItemService itemService

baseURL

protected String baseURL

Constructor Detail

SyndicationFeed

public SyndicationFeed(String ui)

Constructor.

Parameters:

ui - either "xmlui" or "jspui"

Method Detail

getDescriptionSelectors

public static String[] getDescriptionSelectors()

Returns list of metadata selectors used to compose the description element

Returns:

selector list - format 'schema.element[.qualifier]'

populate

public void populate(javax.servlet.http.HttpServletRequest request,
                     Context context,
                     DSpaceObject dso,
                     List<? extends DSpaceObject> items,
                     Map<String,String> labels)

Fills in the feed and entry-level metadata from DSpace objects.

Parameters:

request - request

context - context

dso - DSpaceObject

items - array of objects

labels - label map

setType

public void setType(String feedType)

Sets the feed type for XML delivery, e.g. "rss_1.0", "atom_1.0" Must match one of ROME's configured generators, see rome.properties (currently rss_1.0, rss_2.0, atom_1.0, atom_0.3)

Parameters:

feedType - feed type

outputW3CDom

public Document outputW3CDom()
                      throws com.sun.syndication.io.FeedException

Returns:

the feed we built as DOM Document

Throws:

com.sun.syndication.io.FeedException - if feed error

outputString

public String outputString()
                    throws com.sun.syndication.io.FeedException

Returns:

the feed we built as serialized XML string

Throws:

com.sun.syndication.io.FeedException - if feed error

output

public void output(Writer writer)
            throws com.sun.syndication.io.FeedException,
                   IOException

send the output to designated Writer

Parameters:

writer - Writer

Throws:

com.sun.syndication.io.FeedException - if feed error

IOException - if IO error

addModule

public void addModule(com.sun.syndication.feed.module.Module m)

Add a ROME plugin module (e.g. for OpenSearch) at the feed level.

Parameters:

m - module

getDefaultedConfiguration

protected static String getDefaultedConfiguration(String key,
                                                  String dfl)

urlOfBitstream

protected String urlOfBitstream(javax.servlet.http.HttpServletRequest request,
                                Bitstream logo)

resolveURL

protected String resolveURL(javax.servlet.http.HttpServletRequest request,
                            DSpaceObject dso)

Return a url to the DSpace object, either use the official handle for the item or build a url based upon the current server. If the dspaceobject is null then a local url to the repository is generated.

Parameters:

request - current servlet request

dso - The object to reference, null if to the repository.

Returns:

URL

localize

protected String localize(Map<String,String> labels,
                          String s)

getOneDC

protected String getOneDC(Item item,
                          String field)