com.xpn.xwiki.plugin.activitystream.plugin
Class ActivityStreamPlugin

java.lang.Object
  com.xpn.xwiki.plugin.XWikiDefaultPlugin
      com.xpn.xwiki.plugin.activitystream.plugin.ActivityStreamPlugin

All Implemented Interfaces:

com.xpn.xwiki.plugin.XWikiPluginInterface

public class ActivityStreamPlugin
extends com.xpn.xwiki.plugin.XWikiDefaultPlugin

Plug-in for for managing streams of activity events.

Version:

$Id: ActivityStreamPlugin.java 32218 2010-10-27 15:04:48Z sdumitriu $

See Also:

ActivityStream

Field Summary

static java.lang.String

PLUGIN_NAME Name of the plugin.

Constructor Summary

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

Method Summary

ActivityStream	getActivityStream()
java.lang.String	getActivityStreamPreference(java.lang.String preference, java.lang.String defaultValue, com.xpn.xwiki.XWikiContext context) Get a preference for the activitystream from the XWiki configuration.
java.lang.String	getName()
com.xpn.xwiki.api.Api	getPluginApi(com.xpn.xwiki.plugin.XWikiPluginInterface plugin, com.xpn.xwiki.XWikiContext context)
void	init(com.xpn.xwiki.XWikiContext context)
void	setActivityStream(ActivityStream activityStream)
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

Field Detail

PLUGIN_NAME

public static final java.lang.String PLUGIN_NAME

Name of the plugin.

See Also:

Constant Field Values

Constructor Detail

ActivityStreamPlugin

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

Constructor.

Parameters:

name - name of the plugin

className - class name of the plugin

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()

getPluginApi

public com.xpn.xwiki.api.Api 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(com.xpn.xwiki.plugin.XWikiPluginInterface, com.xpn.xwiki.XWikiContext)

getActivityStream

public ActivityStream getActivityStream()

Returns:

The ActivityStream component used in behind by this plug-in instance

setActivityStream

public void setActivityStream(ActivityStream activityStream)

Parameters:

activityStream - The ActivityStream component to be used

getActivityStreamPreference

public java.lang.String getActivityStreamPreference(java.lang.String preference,
                                                    java.lang.String defaultValue,
                                                    com.xpn.xwiki.XWikiContext context)

Get a preference for the activitystream from the XWiki configuration.

Parameters:

preference - Name of the preference to get the value from

defaultValue - Default value if the preference is not found in the configuration

context - the XWiki context

Returns:

value for the given preference

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)