com.xpn.xwiki.plugin.watchlist
Class WatchListJob

java.lang.Object
  com.xpn.xwiki.plugin.scheduler.AbstractJob
      com.xpn.xwiki.plugin.watchlist.WatchListJob

All Implemented Interfaces:

org.quartz.Job

public class WatchListJob
extends com.xpn.xwiki.plugin.scheduler.AbstractJob
implements org.quartz.Job

WatchList abstract implementation of Quartz's Job.

Version:

$Id: WatchListJob.java 22905 2009-08-25 14:17:34Z jvdrean $

Field Summary

static java.lang.String

DEFAULT_EMAIL_TEMPLATE Wiki page which contains the default watchlist email template.

Constructor Summary

WatchListJob()

Method Summary

protected void	cleanupComponents() Clean the container context.
void	executeJob(org.quartz.JobExecutionContext jobContext) Method called from the scheduler.
java.lang.String	getId()
void	init(org.quartz.JobExecutionContext jobContext) Sets objects required by the Job : XWiki, XWikiContext, WatchListPlugin, etc.
protected void	initializeComponents(com.xpn.xwiki.XWikiContext context) Initialize container context.

Methods inherited from class com.xpn.xwiki.plugin.scheduler.AbstractJob

execute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.quartz.Job

execute

Field Detail

DEFAULT_EMAIL_TEMPLATE

public static final java.lang.String DEFAULT_EMAIL_TEMPLATE

Wiki page which contains the default watchlist email template.

See Also:

Constant Field Values

Constructor Detail

WatchListJob

public WatchListJob()

Method Detail

init

public void init(org.quartz.JobExecutionContext jobContext)
          throws java.lang.Exception

Sets objects required by the Job : XWiki, XWikiContext, WatchListPlugin, etc.

Parameters:

jobContext - Context of the request

Throws:

java.lang.Exception - when the init of components fails

initializeComponents

protected void initializeComponents(com.xpn.xwiki.XWikiContext context)
                             throws javax.servlet.ServletException

Initialize container context.

Parameters:

context - The XWiki context.

Throws:

javax.servlet.ServletException - If the container initialization fails.

cleanupComponents

protected void cleanupComponents()

Clean the container context.

getId

public java.lang.String getId()

Returns:

ID of the job

executeJob

public void executeJob(org.quartz.JobExecutionContext jobContext)
                throws org.quartz.JobExecutionException

Method called from the scheduler.

Specified by:

executeJob in class com.xpn.xwiki.plugin.scheduler.AbstractJob

Parameters:

jobContext - Context of the request

Throws:

org.quartz.JobExecutionException - if the job execution fails.