org.jahia.services.scheduler

Class SchedulerService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.scheduler.SchedulerService

All Implemented Interfaces:

ReadOnlyModeCapable

public class SchedulerService
extends JahiaService
implements ReadOnlyModeCapable

Jahia background task scheduling and management service.

Author:

Sergiy Shyrkov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SchedulerService.JahiaSchedulerFactoryBean Jahia Spring factory bean that creates, but does not start Quartz scheduler instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INSTANT_TRIGGER_GROUP
static String	SYSTEM_JOB_GROUP

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
SchedulerService()

Method Summary

Modifier and Type	Method and Description
void	addJobListener(org.quartz.JobListener jobListener, boolean useRamScheduler) Add a global job listener
Integer	deleteAllCompletedJobs()
Integer	deleteAllCompletedJobs(Map<Pattern,Long> purgeStrategy, boolean purgeWithNoEndDate)
Integer	deleteAllCompletedJobs(Map<Pattern,Long> purgeStrategy, boolean purgeWithNoEndDate, boolean isRAMScheduler)
Integer	deleteAllCompletedRAMJobs()
protected Long	getAge(String jobName, String jobGroup, Map<Pattern,Long> purgeStrategy)
List<org.quartz.JobDetail>	getAllActiveJobs()
List<org.quartz.JobDetail>	getAllActiveJobs(String triggerGroup)
List<org.quartz.JobDetail>	getAllJobs()
List<org.quartz.JobDetail>	getAllJobs(String groupname)
List<org.quartz.JobDetail>	getAllJobs(String groupname, boolean useRamScheduler)
List<org.quartz.JobDetail>	getAllRAMJobs()
org.quartz.Scheduler	getRAMScheduler()
int	getReadOnlyModePriority() Get the priority of the service.
org.quartz.Scheduler	getScheduler()
protected org.quartz.Scheduler	getScheduler(boolean isRamScheduler)
void	removeJobListener(String name, boolean useRamScheduler) Remove a global job listener
void	scheduleJobAtEndOfRequest(org.quartz.JobDetail jobDetail)
void	scheduleJobAtEndOfRequest(org.quartz.JobDetail jobDetail, boolean useRamScheduler)
void	scheduleJobNow(org.quartz.JobDetail jobDetail)
void	scheduleJobNow(org.quartz.JobDetail jobDetail, boolean useRamScheduler)
void	setRamScheduler(org.quartz.Scheduler ramscheduler)
void	setScheduler(org.quartz.Scheduler scheduler)
void	setTimeoutSwitchingToReadOnlyMode(long timeoutSwitchingToReadOnlyMode)
void	start()
void	startSchedulers()
void	stop()
void	switchReadOnlyMode(boolean enable) Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.
void	triggerEndOfRequest()

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

INSTANT_TRIGGER_GROUP

public static final String INSTANT_TRIGGER_GROUP

See Also:

Constant Field Values

SYSTEM_JOB_GROUP

public static final String SYSTEM_JOB_GROUP

See Also:

Constant Field Values

Constructor Detail

SchedulerService

public SchedulerService()

Method Detail

deleteAllCompletedJobs

public Integer deleteAllCompletedJobs()
                               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

deleteAllCompletedRAMJobs

public Integer deleteAllCompletedRAMJobs()
                                  throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

deleteAllCompletedJobs

public Integer deleteAllCompletedJobs(Map<Pattern,Long> purgeStrategy,
                                      boolean purgeWithNoEndDate)
                               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

deleteAllCompletedJobs

public Integer deleteAllCompletedJobs(Map<Pattern,Long> purgeStrategy,
                                      boolean purgeWithNoEndDate,
                                      boolean isRAMScheduler)
                               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getAge

protected Long getAge(String jobName,
                      String jobGroup,
                      Map<Pattern,Long> purgeStrategy)

getAllActiveJobs

public List<org.quartz.JobDetail> getAllActiveJobs()
                                            throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getAllActiveJobs

public List<org.quartz.JobDetail> getAllActiveJobs(String triggerGroup)
                                            throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getAllJobs

public List<org.quartz.JobDetail> getAllJobs()
                                      throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getAllRAMJobs

public List<org.quartz.JobDetail> getAllRAMJobs()
                                         throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getAllJobs

public List<org.quartz.JobDetail> getAllJobs(String groupname)
                                      throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getAllJobs

public List<org.quartz.JobDetail> getAllJobs(String groupname,
                                             boolean useRamScheduler)
                                      throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

getRAMScheduler

public org.quartz.Scheduler getRAMScheduler()

getScheduler

public org.quartz.Scheduler getScheduler()

getScheduler

protected org.quartz.Scheduler getScheduler(boolean isRamScheduler)

startSchedulers

public void startSchedulers()
                     throws JahiaInitializationException

Throws:

JahiaInitializationException

scheduleJobNow

public void scheduleJobNow(org.quartz.JobDetail jobDetail)
                    throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

scheduleJobNow

public void scheduleJobNow(org.quartz.JobDetail jobDetail,
                           boolean useRamScheduler)
                    throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

scheduleJobAtEndOfRequest

public void scheduleJobAtEndOfRequest(org.quartz.JobDetail jobDetail)
                               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

scheduleJobAtEndOfRequest

public void scheduleJobAtEndOfRequest(org.quartz.JobDetail jobDetail,
                                      boolean useRamScheduler)
                               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

triggerEndOfRequest

public void triggerEndOfRequest()

setRamScheduler

public void setRamScheduler(org.quartz.Scheduler ramscheduler)

setScheduler

public void setScheduler(org.quartz.Scheduler scheduler)

setTimeoutSwitchingToReadOnlyMode

public void setTimeoutSwitchingToReadOnlyMode(long timeoutSwitchingToReadOnlyMode)

addJobListener

public void addJobListener(org.quartz.JobListener jobListener,
                           boolean useRamScheduler)

Add a global job listener

Parameters:

jobListener - the listener

useRamScheduler - add listener on ramScheduler or scheduler

removeJobListener

public void removeJobListener(String name,
                              boolean useRamScheduler)

Remove a global job listener

Parameters:

name - the listener name

useRamScheduler - remove listener from ramScheduler or scheduler

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()

Specified by:

stop in class JahiaService

getReadOnlyModePriority

public int getReadOnlyModePriority()

Description copied from interface: ReadOnlyModeCapable

Get the priority of the service.

Specified by:

getReadOnlyModePriority in interface ReadOnlyModeCapable

Returns:

the priority of the service; higher priority means earlier invocation of switchReadOnlyMode when switching read only mode on, and later invocation when switching it off

switchReadOnlyMode

public void switchReadOnlyMode(boolean enable)

Description copied from interface: ReadOnlyModeCapable

Enable/disable read-only mode for a specific functional area this ReadOnlyModeCapable is responsible for.

Specified by:

switchReadOnlyMode in interface ReadOnlyModeCapable

Parameters:

enable - true in case the read-only mode should be enabled; false otherwise