com.xpn.xwiki.plugin.activitystream.impl
Class ActivityStreamCleaner

java.lang.Object
  com.xpn.xwiki.plugin.activitystream.impl.ActivityStreamCleaner

public final class ActivityStreamCleaner
extends Object

Manager for the activitystream cleaning feature. The cleaning consist in deleting old events to prevent infinite growth of the activitystream table in the database.

Version:

$Id: 692d36298d580ce6d42f47c16ddb5c5e3308769a $

Method Summary

static ActivityStreamCleaner	getInstance()
static int	getNumberOfDaysToKeep(com.xpn.xwiki.XWikiContext context)
void	init(com.xpn.xwiki.XWikiContext context) Method that must be called on plugin init.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ActivityStreamCleaner getInstance()

Returns:

a unique instance of ActivityStreamCleaner. Thread safe.

getNumberOfDaysToKeep

public static int getNumberOfDaysToKeep(com.xpn.xwiki.XWikiContext context)

Parameters:

context - the XWiki context

Returns:

the number of days activitystream events should be kept (default: infinite duration).

init

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

Method that must be called on plugin init. Create the scheduler job.

Parameters:

context - the XWiki context

Throws:

com.xpn.xwiki.XWikiException - if the job creation failed