com.xpn.xwiki.plugin.feed

Class FeedPlugin

java.lang.Object

com.xpn.xwiki.plugin.XWikiDefaultPlugin

com.xpn.xwiki.plugin.feed.FeedPlugin

All Implemented Interfaces:

XWikiPluginInterface

public class FeedPlugin
extends XWikiDefaultPlugin
implements XWikiPluginInterface

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeedPlugin.EntriesComparator
static class	FeedPlugin.SyndEntryComparator

Constructor Summary

Constructors

Constructor and Description
FeedPlugin(String name, String className, XWikiContext context)

Method Summary

Modifier and Type	Method and Description
void	flushCache()
Collection<String>	getActiveUpdateThreads()
BaseClass	getAggregatorURLClass(XWikiContext context) Deprecated. since 11.10RC1
com.sun.syndication.feed.synd.SyndFeed	getFeed(List<Object> list, SyndEntrySource source, Map<String,Object> sourceParams, Map<String,Object> metadata, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(List<Object> list, SyndEntrySource source, Map<String,Object> sourceParams, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(String sfeed, boolean ignoreInvalidFeeds, boolean force, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(String sfeed, boolean force, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(String query, int count, int start, SyndEntrySource source, Map<String,Object> sourceParams, Map<String,Object> metadata, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(String query, int count, int start, SyndEntrySource source, Map<String,Object> sourceParams, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(String sfeed, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(XWikiContext context)
com.sun.syndication.feed.synd.SyndEntry	getFeedEntry(XWikiContext context)
BaseClass	getFeedEntryClass(XWikiContext context) Deprecated. since 11.10RC1
com.sun.syndication.feed.synd.SyndFeed	getFeedForce(String sfeed, boolean ignoreInvalidFeeds, XWikiContext context)
com.sun.syndication.feed.synd.SyndImage	getFeedImage(XWikiContext context)
Object	getFeedInfosbyGuid(String feedDoc, String guid, XWikiContext context)
Object	getFeedInfosbyGuid(String guid, XWikiContext context)
String	getFeedOutput(List<Object> list, SyndEntrySource source, Map<String,Object> sourceParams, Map<String,Object> metadata, String type, XWikiContext context)
String	getFeedOutput(String query, int count, int start, SyndEntrySource source, Map<String,Object> sourceParams, Map<String,Object> metadata, String type, XWikiContext context)
String	getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed, String type, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeeds(String sfeeds, boolean ignoreInvalidFeeds, boolean force, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeeds(String sfeeds, boolean force, XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeeds(String sfeeds, XWikiContext context)
String	getName()
Api	getPluginApi(XWikiPluginInterface plugin, XWikiContext context)
SyndEntrySource	getSyndEntrySource(String className, Map<String,Object> params, XWikiContext context)
UpdateThread	getUpdateThread(String space, XWikiContext context)
void	init(XWikiContext context)
void	initCache(int iCapacity, XWikiContext context)
void	initCache(XWikiContext context)
protected void	prepareCache(XWikiContext context)
void	removeUpdateThread(String space, UpdateThread thread, XWikiContext context)
List<Object>	search(String query, XWikiContext context)
boolean	startUpdateFeedsInSpace(String space, boolean fullContent, int scheduleTimer, XWikiContext context)
void	stopUpdateFeedsInSpace(String space, XWikiContext context)
int	updateFeed(String feedname, String feedurl, boolean fullContent, boolean oneDocPerEntry, boolean force, String space, XWikiContext context)
int	updateFeed(String feedname, String feedurl, boolean fullContent, boolean oneDocPerEntry, boolean force, XWikiContext context)
int	updateFeed(String feedname, String feedurl, boolean fullContent, boolean oneDocPerEntry, XWikiContext context)
int	updateFeed(String feedname, String feedurl, boolean oneDocPerEntry, XWikiContext context)
int	updateFeed(String feedDocumentName, String feedname, String feedurl, boolean fullContent, boolean oneDocPerEntry, boolean force, String space, XWikiContext context)
int	updateFeeds(String feedDoc, boolean fullContent, boolean oneDocPerEntry, boolean force, String space, XWikiContext context)
int	updateFeeds(String feedDoc, boolean fullContent, boolean oneDocPerEntry, boolean force, XWikiContext context)
int	updateFeeds(String feedDoc, boolean fullContent, boolean oneDocPerEntry, XWikiContext context)
int	updateFeeds(String feedDoc, boolean fullContent, XWikiContext context)
int	updateFeeds(String feedDoc, XWikiContext context)
int	updateFeeds(XWikiContext context)
int	updateFeedsInSpace(String spaceReference, boolean fullContent, boolean oneDocPerEntry, boolean force, XWikiContext context)

Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin

beginParsing, beginRendering, commonTagsHandler, downloadAttachment, endParsing, endRendering, endRenderingHandler, flushCache, getClassName, getLocalization, insidePREHandler, localizePlainOrKey, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xpn.xwiki.plugin.XWikiPluginInterface

beginParsing, beginRendering, commonTagsHandler, downloadAttachment, endParsing, endRendering, endRenderingHandler, flushCache, insidePREHandler, outsidePREHandler, startRenderingHandler, virtualInit

Constructor Detail

FeedPlugin

public FeedPlugin(String name,
                  String className,
                  XWikiContext context)

Method Detail

getName

public String getName()

Specified by:

getName in interface XWikiPluginInterface

Overrides:

getName in class XWikiDefaultPlugin

getPluginApi

public Api getPluginApi(XWikiPluginInterface plugin,
                        XWikiContext context)

Specified by:

getPluginApi in interface XWikiPluginInterface

Overrides:

getPluginApi in class XWikiDefaultPlugin

flushCache

public void flushCache()

Overrides:

flushCache in class XWikiDefaultPlugin

init

public void init(XWikiContext context)

Specified by:

init in interface XWikiPluginInterface

Overrides:

init in class XWikiDefaultPlugin

initCache

public void initCache(XWikiContext context)
               throws XWikiException

Throws:

XWikiException

initCache

public void initCache(int iCapacity,
                      XWikiContext context)
               throws XWikiException

Throws:

XWikiException

prepareCache

protected void prepareCache(XWikiContext context)

getFeeds

public com.sun.syndication.feed.synd.SyndFeed getFeeds(String sfeeds,
                                                       XWikiContext context)
                                                throws IOException

Throws:

IOException

getFeeds

public com.sun.syndication.feed.synd.SyndFeed getFeeds(String sfeeds,
                                                       boolean force,
                                                       XWikiContext context)
                                                throws IOException

Throws:

IOException

getFeeds

public com.sun.syndication.feed.synd.SyndFeed getFeeds(String sfeeds,
                                                       boolean ignoreInvalidFeeds,
                                                       boolean force,
                                                       XWikiContext context)
                                                throws IOException

Throws:

IOException

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(String sfeed,
                                                      XWikiContext context)
                                               throws IOException

Throws:

IOException

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(String sfeed,
                                                      boolean force,
                                                      XWikiContext context)
                                               throws IOException

Throws:

IOException

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(String sfeed,
                                                      boolean ignoreInvalidFeeds,
                                                      boolean force,
                                                      XWikiContext context)
                                               throws IOException

Throws:

IOException

getFeedForce

public com.sun.syndication.feed.synd.SyndFeed getFeedForce(String sfeed,
                                                           boolean ignoreInvalidFeeds,
                                                           XWikiContext context)
                                                    throws IOException

Throws:

IOException

updateFeeds

public int updateFeeds(XWikiContext context)
                throws XWikiException

Throws:

XWikiException

updateFeeds

public int updateFeeds(String feedDoc,
                       XWikiContext context)
                throws XWikiException

Throws:

XWikiException

updateFeeds

public int updateFeeds(String feedDoc,
                       boolean fullContent,
                       XWikiContext context)
                throws XWikiException

Throws:

XWikiException

updateFeeds

public int updateFeeds(String feedDoc,
                       boolean fullContent,
                       boolean oneDocPerEntry,
                       XWikiContext context)
                throws XWikiException

Throws:

XWikiException

updateFeeds

public int updateFeeds(String feedDoc,
                       boolean fullContent,
                       boolean oneDocPerEntry,
                       boolean force,
                       XWikiContext context)
                throws XWikiException

Throws:

XWikiException

updateFeeds

public int updateFeeds(String feedDoc,
                       boolean fullContent,
                       boolean oneDocPerEntry,
                       boolean force,
                       String space,
                       XWikiContext context)
                throws XWikiException

Throws:

XWikiException

updateFeedsInSpace

public int updateFeedsInSpace(String spaceReference,
                              boolean fullContent,
                              boolean oneDocPerEntry,
                              boolean force,
                              XWikiContext context)
                       throws XWikiException

Throws:

XWikiException

startUpdateFeedsInSpace

public boolean startUpdateFeedsInSpace(String space,
                                       boolean fullContent,
                                       int scheduleTimer,
                                       XWikiContext context)
                                throws XWikiException

Throws:

XWikiException

stopUpdateFeedsInSpace

public void stopUpdateFeedsInSpace(String space,
                                   XWikiContext context)
                            throws XWikiException

Throws:

XWikiException

removeUpdateThread

public void removeUpdateThread(String space,
                               UpdateThread thread,
                               XWikiContext context)

getUpdateThread

public UpdateThread getUpdateThread(String space,
                                    XWikiContext context)

getActiveUpdateThreads

public Collection<String> getActiveUpdateThreads()

updateFeed

public int updateFeed(String feedname,
                      String feedurl,
                      boolean oneDocPerEntry,
                      XWikiContext context)

updateFeed

public int updateFeed(String feedname,
                      String feedurl,
                      boolean fullContent,
                      boolean oneDocPerEntry,
                      XWikiContext context)

updateFeed

public int updateFeed(String feedname,
                      String feedurl,
                      boolean fullContent,
                      boolean oneDocPerEntry,
                      boolean force,
                      XWikiContext context)

updateFeed

public int updateFeed(String feedname,
                      String feedurl,
                      boolean fullContent,
                      boolean oneDocPerEntry,
                      boolean force,
                      String space,
                      XWikiContext context)

updateFeed

public int updateFeed(String feedDocumentName,
                      String feedname,
                      String feedurl,
                      boolean fullContent,
                      boolean oneDocPerEntry,
                      boolean force,
                      String space,
                      XWikiContext context)

getAggregatorURLClass

@Deprecated
public BaseClass getAggregatorURLClass(XWikiContext context)
                                            throws XWikiException

Deprecated. since 11.10RC1

This method was originally used to create the AggregatorURLClass but the code has been moved to AggregatorURLClassDocumentInitializer.

Parameters:

context - the XWiki context

Returns:

the definition of the AggregatorURLClass

Throws:

XWikiException - if loading the class definition fails

getFeedEntryClass

@Deprecated
public BaseClass getFeedEntryClass(XWikiContext context)
                                        throws XWikiException

Deprecated. since 11.10RC1

This method was originally used to create the FeedEntryClass but the code has been moved to FeedEntryClassDocumentInitializer.

Parameters:

context - the XWiki context

Returns:

the definition of the FeedEntryClass

Throws:

XWikiException - if loading the class definition fails

search

public List<Object> search(String query,
                           XWikiContext context)
                    throws XWikiException

Throws:

XWikiException

getFeedInfosbyGuid

public Object getFeedInfosbyGuid(String guid,
                                 XWikiContext context)
                          throws XWikiException

Throws:

XWikiException

getFeedInfosbyGuid

public Object getFeedInfosbyGuid(String feedDoc,
                                 String guid,
                                 XWikiContext context)
                          throws XWikiException

Throws:

XWikiException

getSyndEntrySource

public SyndEntrySource getSyndEntrySource(String className,
                                          Map<String,Object> params,
                                          XWikiContext context)
                                   throws XWikiException

Throws:

XWikiException

See Also:

FeedPluginApi.getSyndEntrySource(String, Map)

getFeedEntry

public com.sun.syndication.feed.synd.SyndEntry getFeedEntry(XWikiContext context)

See Also:

FeedPluginApi.getFeedEntry()

getFeedImage

public com.sun.syndication.feed.synd.SyndImage getFeedImage(XWikiContext context)

See Also:

FeedPluginApi.getFeedImage()

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(XWikiContext context)

See Also:

FeedPluginApi.getFeed()

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(List<Object> list,
                                                      SyndEntrySource source,
                                                      Map<String,Object> sourceParams,
                                                      XWikiContext context)
                                               throws XWikiException

Throws:

XWikiException

See Also:

FeedPluginApi.getFeed(List, SyndEntrySourceApi, Map)

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(String query,
                                                      int count,
                                                      int start,
                                                      SyndEntrySource source,
                                                      Map<String,Object> sourceParams,
                                                      XWikiContext context)
                                               throws XWikiException

Throws:

XWikiException

See Also:

FeedPluginApi.getFeed(String, int, int, SyndEntrySourceApi, Map)

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(List<Object> list,
                                                      SyndEntrySource source,
                                                      Map<String,Object> sourceParams,
                                                      Map<String,Object> metadata,
                                                      XWikiContext context)
                                               throws XWikiException

Throws:

XWikiException

See Also:

FeedPluginApi.getFeed(List, SyndEntrySourceApi, Map, Map)

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(String query,
                                                      int count,
                                                      int start,
                                                      SyndEntrySource source,
                                                      Map<String,Object> sourceParams,
                                                      Map<String,Object> metadata,
                                                      XWikiContext context)
                                               throws XWikiException

Throws:

XWikiException

See Also:

FeedPluginApi.getFeed(String, int, int, SyndEntrySourceApi, Map, Map)

getFeedOutput

public String getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed,
                            String type,
                            XWikiContext context)

See Also:

FeedPluginApi.getFeedOutput(SyndFeed, String)

getFeedOutput

public String getFeedOutput(List<Object> list,
                            SyndEntrySource source,
                            Map<String,Object> sourceParams,
                            Map<String,Object> metadata,
                            String type,
                            XWikiContext context)
                     throws XWikiException

Throws:

XWikiException

See Also:

FeedPluginApi.getFeedOutput(List, SyndEntrySourceApi, Map, Map, String)

getFeedOutput

public String getFeedOutput(String query,
                            int count,
                            int start,
                            SyndEntrySource source,
                            Map<String,Object> sourceParams,
                            Map<String,Object> metadata,
                            String type,
                            XWikiContext context)
                     throws XWikiException

Throws:

XWikiException

See Also:

FeedPluginApi.getFeedOutput(String, int, int, SyndEntrySourceApi, Map, Map, String)