org.jahia.services.scheduler

Class BackgroundJob

java.lang.Object

org.jahia.services.scheduler.BackgroundJob

All Implemented Interfaces:

org.quartz.Job, org.quartz.StatefulJob

Direct Known Subclasses:

ActionJob, AssignAndCompleteTaskJob, ClearModuleNodesJob, DataStoreGarbageCollectorJob, HtmlCacheEventJob, ImportJob, JahiaSearchIndex.ReindexJob, JobHistoryPurgeJob, JSR223ScriptJob, MountPointJob, NodeVersionHistoryJob, NotifyNewTaskJob, OrphanedActionPurgeJob, PublicationJob, RuleJob, SiteImportJob, StartProcessJob, TextExtractorJob, UnusedVersionHistoryJob

public abstract class BackgroundJob
extends Object
implements org.quartz.StatefulJob

Base class for Jahia background tasks.

Author:

toto

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.id.IdentifierGenerator	idGen
static String	JOB_BEGIN
static String	JOB_CREATED
static String	JOB_CURRENT_LOCALE
static String	JOB_DURATION
static String	JOB_END
static String	JOB_MESSAGE
static String	JOB_SITEKEY
static String	JOB_STATUS
static String	JOB_USERKEY
static String	STATUS_ADDED
static String	STATUS_CANCELED
static String	STATUS_EXECUTING
static String	STATUS_FAILED
static String	STATUS_SCHEDULED
static String	STATUS_SUCCESSFUL

Constructor Summary

Constructors

Constructor and Description
BackgroundJob()

Method Summary

Modifier and Type	Method and Description
static org.quartz.JobDetail	createJahiaJob(String desc, Class<? extends BackgroundJob> jobClass)
void	execute(org.quartz.JobExecutionContext ctx)
abstract void	executeJahiaJob(org.quartz.JobExecutionContext jobExecutionContext)
static String	getGroupName(Class<? extends BackgroundJob> c)
protected void	postExecution(org.quartz.JobExecutionContext jobExecutionContext) Sub class can perform specific post execution task

Methods inherited from class java.lang.Object

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

Field Detail

idGen

public static org.apache.commons.id.IdentifierGenerator idGen

JOB_CREATED

public static final String JOB_CREATED

See Also:

Constant Field Values

JOB_BEGIN

public static final String JOB_BEGIN

See Also:

Constant Field Values

JOB_END

public static final String JOB_END

See Also:

Constant Field Values

JOB_STATUS

public static final String JOB_STATUS

See Also:

Constant Field Values

JOB_DURATION

public static final String JOB_DURATION

See Also:

Constant Field Values

JOB_CURRENT_LOCALE

public static final String JOB_CURRENT_LOCALE

See Also:

Constant Field Values

JOB_SITEKEY

public static final String JOB_SITEKEY

See Also:

Constant Field Values

JOB_USERKEY

public static final String JOB_USERKEY

See Also:

Constant Field Values

JOB_MESSAGE

public static final String JOB_MESSAGE

See Also:

Constant Field Values

STATUS_ADDED

public static final String STATUS_ADDED

See Also:

Constant Field Values

STATUS_SCHEDULED

public static final String STATUS_SCHEDULED

See Also:

Constant Field Values

STATUS_EXECUTING

public static final String STATUS_EXECUTING

See Also:

Constant Field Values

STATUS_SUCCESSFUL

public static final String STATUS_SUCCESSFUL

See Also:

Constant Field Values

STATUS_FAILED

public static final String STATUS_FAILED

See Also:

Constant Field Values

STATUS_CANCELED

public static final String STATUS_CANCELED

See Also:

Constant Field Values

Constructor Detail

BackgroundJob

public BackgroundJob()

Method Detail

createJahiaJob

public static org.quartz.JobDetail createJahiaJob(String desc,
                                                  Class<? extends BackgroundJob> jobClass)

getGroupName

public static String getGroupName(Class<? extends BackgroundJob> c)

execute

public void execute(org.quartz.JobExecutionContext ctx)
             throws org.quartz.JobExecutionException

Specified by:

execute in interface org.quartz.Job

Throws:

org.quartz.JobExecutionException

executeJahiaJob

public abstract void executeJahiaJob(org.quartz.JobExecutionContext jobExecutionContext)
                              throws Exception

Throws:

Exception

postExecution

protected void postExecution(org.quartz.JobExecutionContext jobExecutionContext)

Sub class can perform specific post execution task

Parameters:

jobExecutionContext -