com.xpn.xwiki.plugin.watchlist
Class WatchListPlugin

java.lang.Object
  com.xpn.xwiki.plugin.XWikiDefaultPlugin
      com.xpn.xwiki.plugin.watchlist.WatchListPlugin

All Implemented Interfaces:

com.xpn.xwiki.plugin.XWikiPluginInterface

public class WatchListPlugin
extends com.xpn.xwiki.plugin.XWikiDefaultPlugin
implements com.xpn.xwiki.plugin.XWikiPluginInterface

Plugin that offers WatchList features to XWiki. These feature allow users to build lists of pages and spaces they want to follow. At a frequency choosen by the user XWiki will send an email notification to him with a list of the elements that has been modified since the last notification.

Version:

$Id: WatchListPlugin.java 26983 2010-02-12 19:54:05Z vmassol $

Field Summary

static java.lang.String	APP_RES_PREFIX Prefix used in ApplicationResources for this plugin.
static java.lang.String	DEFAULT_CLASS_PARENT Default parent to use for class pages.
static java.lang.String	DEFAULT_DOC_AUTHOR Default XWiki Administrator.
static java.lang.String	ID Plugin name.

Constructor Summary

WatchListPlugin(java.lang.String name, java.lang.String className, com.xpn.xwiki.XWikiContext context)

Method Summary

WatchListEventFeedManager	getFeedManager()
WatchListJobManager	getJobManager()
java.lang.String	getName()
WatchListNotifier	getNotifier()
WatchListPluginApi	getPluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface plugin, com.xpn.xwiki.XWikiContext context)
WatchListStore	getStore()
void	init(com.xpn.xwiki.XWikiContext context)
void	virtualInit(com.xpn.xwiki.XWikiContext context)

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

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

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, flushCache, getClassName, insidePREHandler, outsidePREHandler, setClassName, setName, startRenderingHandler

Field Detail

ID

public static final java.lang.String ID

Plugin name.

See Also:

Constant Field Values

APP_RES_PREFIX

public static final java.lang.String APP_RES_PREFIX

Prefix used in ApplicationResources for this plugin.

See Also:

Constant Field Values

DEFAULT_DOC_AUTHOR

public static final java.lang.String DEFAULT_DOC_AUTHOR

Default XWiki Administrator.

See Also:

Constant Field Values

DEFAULT_CLASS_PARENT

public static final java.lang.String DEFAULT_CLASS_PARENT

Default parent to use for class pages.

See Also:

Constant Field Values

Constructor Detail

WatchListPlugin

public WatchListPlugin(java.lang.String name,
                       java.lang.String className,
                       com.xpn.xwiki.XWikiContext context)

Parameters:

name - the plugin name

className - the plugin classname (used in logs for example)

context - the XWiki Context

See Also:

XWikiDefaultPlugin.XWikiDefaultPlugin(String,String,com.xpn.xwiki.XWikiContext)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface com.xpn.xwiki.plugin.XWikiPluginInterface

Overrides:

getName in class com.xpn.xwiki.plugin.XWikiDefaultPlugin

See Also:

XWikiDefaultPlugin.getName()

init

public void init(com.xpn.xwiki.XWikiContext context)

Specified by:

init in interface com.xpn.xwiki.plugin.XWikiPluginInterface

Overrides:

init in class com.xpn.xwiki.plugin.XWikiDefaultPlugin

See Also:

XWikiDefaultPlugin.init(XWikiContext)

virtualInit

public void virtualInit(com.xpn.xwiki.XWikiContext context)

Specified by:

virtualInit in interface com.xpn.xwiki.plugin.XWikiPluginInterface

Overrides:

virtualInit in class com.xpn.xwiki.plugin.XWikiDefaultPlugin

See Also:

XWikiDefaultPlugin.virtualInit(XWikiContext)

getPluginApi

public WatchListPluginApi getPluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface plugin,
                                       com.xpn.xwiki.XWikiContext context)

Specified by:

getPluginApi in interface com.xpn.xwiki.plugin.XWikiPluginInterface

Overrides:

getPluginApi in class com.xpn.xwiki.plugin.XWikiDefaultPlugin

See Also:

XWikiDefaultPlugin.getPluginApi(XWikiPluginInterface, XWikiContext)

getJobManager

public WatchListJobManager getJobManager()

Returns:

the job manager instance.

getStore

public WatchListStore getStore()

Returns:

the store instance.

getNotifier

public WatchListNotifier getNotifier()

Returns:

the notifier instance.

getFeedManager

public WatchListEventFeedManager getFeedManager()

Returns:

the feed manager instance.