com.xpn.xwiki.plugin.feed
Class FeedPlugin

java.lang.Object
  extended by com.xpn.xwiki.plugin.XWikiDefaultPlugin
      extended by com.xpn.xwiki.plugin.feed.FeedPlugin
All Implemented Interfaces:
XWikiPluginInterface

public class FeedPlugin
extends XWikiDefaultPlugin
implements XWikiPluginInterface


Nested Class Summary
static class FeedPlugin.EntriesComparator
           
static class FeedPlugin.SyndEntryComparator
           
 
Field Summary
private  XWikiCache feedCache
           
private static org.apache.commons.logging.Log mLogger
           
private  int refreshPeriod
           
 
Constructor Summary
FeedPlugin(java.lang.String name, java.lang.String className, XWikiContext context)
           
 
Method Summary
 void flushCache()
           
 com.sun.syndication.feed.synd.SyndFeed getFeed(java.lang.String sfeed, boolean ignoreInvalidFeeds, boolean force, XWikiContext context)
           
 com.sun.syndication.feed.synd.SyndFeed getFeed(java.lang.String sfeed, boolean force, XWikiContext context)
           
 com.sun.syndication.feed.synd.SyndFeed getFeed(java.lang.String sfeed, XWikiContext context)
           
 com.sun.syndication.feed.synd.SyndFeed getFeedForce(java.lang.String sfeed, boolean ignoreInvalidFeeds, XWikiContext context)
           
 Object getFeedInfosbyGuid(java.lang.String feedDoc, java.lang.String guid, XWikiContext context)
           
 Object getFeedInfosbyGuid(java.lang.String guid, XWikiContext context)
           
 com.sun.syndication.feed.synd.SyndFeed getFeeds(java.lang.String sfeeds, boolean ignoreInvalidFeeds, XWikiContext context)
           
 com.sun.syndication.feed.synd.SyndFeed getFeeds(java.lang.String sfeeds, XWikiContext context)
           
 java.lang.String getName()
           
 Api getPluginApi(XWikiPluginInterface plugin, XWikiContext context)
           
 void init(XWikiContext context)
           
private  boolean postExist(java.util.Vector objs, com.sun.syndication.feed.synd.SyndEntry entry)
           
private  void saveEntry(java.lang.String guid, com.sun.syndication.feed.synd.SyndEntry entry, XWikiDocument doc, XWikiContext context)
           
private  void saveFeed(java.lang.String guid, com.sun.syndication.feed.synd.SyndFeed feed, XWikiContext context)
           
 java.util.List search(java.lang.String query, XWikiContext context)
           
 void updateFeeds(java.lang.String feedDoc, XWikiContext context)
           
 void updateFeeds(XWikiContext context)
           
 
Methods inherited from class com.xpn.xwiki.plugin.XWikiDefaultPlugin
beginRendering, commonTagsHandler, downloadAttachment, endRendering, endRenderingHandler, getClassName, insidePREHandler, 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
beginRendering, commonTagsHandler, downloadAttachment, endRendering, endRenderingHandler, getClassName, insidePREHandler, outsidePREHandler, setClassName, setName, startRenderingHandler, virtualInit
 

Field Detail

mLogger

private static org.apache.commons.logging.Log mLogger

feedCache

private XWikiCache feedCache

refreshPeriod

private int refreshPeriod
Constructor Detail

FeedPlugin

public FeedPlugin(java.lang.String name,
                  java.lang.String className,
                  XWikiContext context)
Method Detail

getName

public java.lang.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()
Specified by:
flushCache in interface XWikiPluginInterface
Overrides:
flushCache in class XWikiDefaultPlugin

init

public void init(XWikiContext context)
Specified by:
init in interface XWikiPluginInterface
Overrides:
init in class XWikiDefaultPlugin

getFeeds

public com.sun.syndication.feed.synd.SyndFeed getFeeds(java.lang.String sfeeds,
                                                       XWikiContext context)
                                                throws java.io.IOException
Throws:
java.io.IOException

getFeeds

public com.sun.syndication.feed.synd.SyndFeed getFeeds(java.lang.String sfeeds,
                                                       boolean ignoreInvalidFeeds,
                                                       XWikiContext context)
                                                throws java.io.IOException
Throws:
java.io.IOException

getFeed

public com.sun.syndication.feed.synd.SyndFeed getFeed(java.lang.String sfeed,
                                                      XWikiContext context)
                                               throws java.io.IOException
Throws:
java.io.IOException

getFeed

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

getFeed

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

getFeedForce

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

updateFeeds

public void updateFeeds(XWikiContext context)
                 throws XWikiException
Throws:
XWikiException

updateFeeds

public void updateFeeds(java.lang.String feedDoc,
                        XWikiContext context)
                 throws XWikiException
Throws:
XWikiException

saveFeed

private void saveFeed(java.lang.String guid,
                      com.sun.syndication.feed.synd.SyndFeed feed,
                      XWikiContext context)
               throws XWikiException
Throws:
XWikiException

saveEntry

private void saveEntry(java.lang.String guid,
                       com.sun.syndication.feed.synd.SyndEntry entry,
                       XWikiDocument doc,
                       XWikiContext context)
                throws XWikiException
Throws:
XWikiException

postExist

private boolean postExist(java.util.Vector objs,
                          com.sun.syndication.feed.synd.SyndEntry entry)

search

public java.util.List search(java.lang.String query,
                             XWikiContext context)
                      throws XWikiException
Throws:
XWikiException

getFeedInfosbyGuid

public Object getFeedInfosbyGuid(java.lang.String guid,
                                 XWikiContext context)
                          throws XWikiException
Throws:
XWikiException

getFeedInfosbyGuid

public Object getFeedInfosbyGuid(java.lang.String feedDoc,
                                 java.lang.String guid,
                                 XWikiContext context)
                          throws XWikiException
Throws:
XWikiException


Copyright 2003 Ludovic Dubost