org.apache.wiki.rss
Class RSSGenerator

java.lang.Object
  org.apache.wiki.rss.RSSGenerator

public class RSSGenerator
extends Object

The master class for generating different kinds of Feeds (including RSS1.0, 2.0 and Atom).

This class can produce quite a few different styles of feeds. The following modes are available:

• wiki - All the changes to the given page are enumerated and announced as diffs.
• full - Each page is only considered once. This produces a very RecentChanges-style feed, where each page is only listed once, even if it has changed multiple times.
• blog - Each page change is assumed to be a blog entry, so no diffs are produced, but the page content is always completely in the entry in rendered HTML.

Since:

1.7.5.

Field Summary

static String	ATOM Parameter value to represent Atom feeds.
static String	MODE_BLOG Parameter value to represent a 'blog' style feed.
static String	MODE_FULL Parameter value to represent a 'full' style feed.
static String	MODE_WIKI Parameter value to represent a 'wiki' style feed.
static String	PROP_CHANNEL_DESCRIPTION Defines the property name for the RSS channel description.
static String	PROP_CHANNEL_LANGUAGE Defines the property name for the RSS channel language.
static String	PROP_CHANNEL_TITLE Defins the property name for the RSS channel title.
static String	PROP_GENERATE_RSS Defines the property name for the RSS generator main switch.
static String	PROP_INTERVAL Defines the property name for the RSS generation interval in seconds.
static String	PROP_RSS_AUTHOR Defines the property name for the RSS author.
static String	PROP_RSS_AUTHOREMAIL Defines the property name for the RSS author email.
static String	PROP_RSS_COPYRIGHT Property name for the RSS copyright info.
static String	PROP_RSSAUTHOR Just for compatibilty.
static String	PROP_RSSAUTHOREMAIL Just for compatibilty.
static String	PROP_RSSFILE Defines the property name for the RSS file that the wiki should generate.
static String	RSS10 Parameter value to represent RSS 1.0 feeds.
static String	RSS20 Parameter value to represent RSS 2.0 feeds.

Constructor Summary

RSSGenerator(WikiEngine engine, Properties properties)
Initialize the RSS generator for a given WikiEngine.

Method Summary

static String	format(String s) Does the required formatting and entity replacement for XML.
String	generate() Generates the RSS resource.
protected String	generateBlogRSS(WikiContext wikiContext, List changed, Feed feed) Creates RSS from modifications as if this page was a blog (using the WeblogPlugin).
String	generateFeed(WikiContext wikiContext, List changed, String mode, String type) Generates a feed based on a context and list of changes.
protected String	generateFullWikiRSS(WikiContext wikiContext, Feed feed) Generates an RSS feed for the entire wiki.
protected String	generateWikiPageRSS(WikiContext wikiContext, List changed, Feed feed) Create RSS/Atom as if this page was a wikipage (in contrast to Blog mode).
static String	getContentType(String mode) Returns the content type of this RSS feed.
boolean	isEnabled() Returns true if RSS generation is enabled.
void	setEnabled(boolean enabled) Turns RSS generation on or off.

Methods inherited from class java.lang.Object

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

Field Detail

RSS10

public static final String RSS10

Parameter value to represent RSS 1.0 feeds. Value is "rss10".

See Also:

Constant Field Values

RSS20

public static final String RSS20

Parameter value to represent RSS 2.0 feeds. Value is "rss20".

See Also:

Constant Field Values

ATOM

public static final String ATOM

Parameter value to represent Atom feeds. Value is "atom".

See Also:

Constant Field Values

MODE_BLOG

public static final String MODE_BLOG

Parameter value to represent a 'blog' style feed. Value is "blog".

See Also:

Constant Field Values

MODE_WIKI

public static final String MODE_WIKI

Parameter value to represent a 'wiki' style feed. Value is "wiki".

See Also:

Constant Field Values

MODE_FULL

public static final String MODE_FULL

Parameter value to represent a 'full' style feed. Value is "full".

See Also:

Constant Field Values

PROP_CHANNEL_DESCRIPTION

public static final String PROP_CHANNEL_DESCRIPTION

Defines the property name for the RSS channel description. Default value for the channel description is an empty string.

Since:

1.7.6.

See Also:

Constant Field Values

PROP_CHANNEL_LANGUAGE

public static final String PROP_CHANNEL_LANGUAGE

Defines the property name for the RSS channel language. Default value for the language is "en-us".

Since:

1.7.6.

See Also:

Constant Field Values

PROP_CHANNEL_TITLE

public static final String PROP_CHANNEL_TITLE

Defins the property name for the RSS channel title. Value is "jspwiki.rss.channelTitle".

See Also:

Constant Field Values

PROP_GENERATE_RSS

public static final String PROP_GENERATE_RSS

Defines the property name for the RSS generator main switch.

Since:

1.7.6.

See Also:

Constant Field Values

PROP_RSSFILE

public static final String PROP_RSSFILE

Defines the property name for the RSS file that the wiki should generate.

Since:

1.7.6.

See Also:

Constant Field Values

PROP_INTERVAL

public static final String PROP_INTERVAL

Defines the property name for the RSS generation interval in seconds.

Since:

1.7.6.

See Also:

Constant Field Values

PROP_RSS_AUTHOR

public static final String PROP_RSS_AUTHOR

Defines the property name for the RSS author. Value is "jspwiki.rss.author".

See Also:

Constant Field Values

PROP_RSS_AUTHOREMAIL

public static final String PROP_RSS_AUTHOREMAIL

Defines the property name for the RSS author email. Value is "jspwiki.rss.author.email".

See Also:

Constant Field Values

PROP_RSS_COPYRIGHT

public static final String PROP_RSS_COPYRIGHT

Property name for the RSS copyright info. Value is "jspwiki.rss.copyright".

See Also:

Constant Field Values

PROP_RSSAUTHOR

public static final String PROP_RSSAUTHOR

Just for compatibilty. @deprecated

See Also:

Constant Field Values

PROP_RSSAUTHOREMAIL

public static final String PROP_RSSAUTHOREMAIL

Just for compatibilty. @deprecated

See Also:

Constant Field Values

Constructor Detail

RSSGenerator

public RSSGenerator(WikiEngine engine,
                    Properties properties)
             throws NoRequiredPropertyException

Initialize the RSS generator for a given WikiEngine. Currently the only required property is "jspwiki.baseURL".

Parameters:

engine - The WikiEngine.

properties - The properties.

Throws:

NoRequiredPropertyException - If something is missing from the given property set.

Method Detail

format

public static String format(String s)

Does the required formatting and entity replacement for XML.

Parameters:

s - String to format.

Returns:

A formatted string.

generate

public String generate()

Generates the RSS resource. You probably want to output this result into a file or something, or serve as output from a servlet.

Returns:

A RSS 1.0 feed in the "full" mode.

getContentType

public static String getContentType(String mode)

Returns the content type of this RSS feed.

Parameters:

mode - the RSS mode: RSS10, RSS20 or ATOM.

Returns:

the content type

Since:

2.3.15

generateFeed

public String generateFeed(WikiContext wikiContext,
                           List changed,
                           String mode,
                           String type)
                    throws ProviderException,
                           IllegalArgumentException

Generates a feed based on a context and list of changes.

Parameters:

wikiContext - The WikiContext

changed - A list of Entry objects

mode - The mode (wiki/blog)

type - The type (RSS10, RSS20, ATOM). Default is RSS 1.0

Returns:

Fully formed XML.

Throws:

ProviderException - If the underlying provider failed.

IllegalArgumentException - If an illegal mode is given.

isEnabled

public boolean isEnabled()

Returns true if RSS generation is enabled.

Returns:

whether RSS generation is currently enabled

setEnabled

public void setEnabled(boolean enabled)

Turns RSS generation on or off. This setting is used to set the "enabled" flag only for use by callers, and does not actually affect whether the generate() or generateFeed(WikiContext, List, String, String) methods output anything.

Parameters:

enabled - whether RSS generation is considered enabled.

generateFullWikiRSS

protected String generateFullWikiRSS(WikiContext wikiContext,
                                     Feed feed)

Generates an RSS feed for the entire wiki. Each item should be an instance of the RSSItem class.

Parameters:

wikiContext - A WikiContext

feed - A Feed to generate the feed to.

Returns:

feed.getString().

generateWikiPageRSS

protected String generateWikiPageRSS(WikiContext wikiContext,
                                     List changed,
                                     Feed feed)

Create RSS/Atom as if this page was a wikipage (in contrast to Blog mode).

Parameters:

wikiContext - The WikiContext

changed - A List of changed WikiPages.

feed - A Feed object to fill.

Returns:

the RSS representation of the wiki context

generateBlogRSS

protected String generateBlogRSS(WikiContext wikiContext,
                                 List changed,
                                 Feed feed)
                          throws ProviderException

Creates RSS from modifications as if this page was a blog (using the WeblogPlugin).

Parameters:

wikiContext - The WikiContext, as usual.

changed - A list of the changed pages.

feed - A valid Feed object. The feed will be used to create the RSS/Atom, depending on which kind of an object you want to put in it.

Returns:

A String of valid RSS or Atom.

Throws:

ProviderException - If reading of pages was not possible.