er.quartzscheduler.foundation

Class ERQSJobSupervisor

java.lang.Object

er.quartzscheduler.foundation.ERQSAbstractJob

er.quartzscheduler.foundation.ERQSJobSupervisor

All Implemented Interfaces:

org.quartz.Job

@DisallowConcurrentExecution
public class ERQSJobSupervisor
extends ERQSAbstractJob

The supervisor has in charge to add, remove or update the list of job handled by the quartz scheduler.

Every job handled by the supervisor has a group starting by GROUP_NAME_PREFIX. The goal is to let developers to add any job directly, aka not linked to a job description. For that reason, by convention, the jobs not handled by the supervisor must have a group not starting with GROUP_NAME_PREFIX

Author:

Philippe Rabier

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SLEEP_DURATION
static String	GROUP_NAME_PREFIX
static String	TRIGGER_SUFFIX

Fields inherited from class er.quartzscheduler.foundation.ERQSAbstractJob

log

Constructor Summary

Constructors

Constructor and Description
ERQSJobSupervisor()

Method Summary

Modifier and Type	Method and Description
protected void	addJob2Scheduler(ERQSJobDescription job2Add) Add a job to the scheduler described the job description job2Add.
protected void	addOrModifyJobs(NSArray<? extends ERQSJobDescription> jobs2Check) From jobs2Check (a fresh list of ERQSJobDescription objects), addOrModifyJobs checks if jobs must be added or modified.
protected String	buildGroup(String group)
protected org.quartz.JobDetail	buildJobDetail(ERQSJobDescription jobDescription) Return a job detail built from a ERQSJobDescription object
protected org.quartz.Trigger	buildTrigger(String name, String group, String cronExpression, org.quartz.JobDataMap map, org.quartz.JobDetail job)
protected org.quartz.Trigger	buildTriggerForJob(ERQSJobDescription jobDescription, org.quartz.JobDetail job) Return a trigger built from a ERQSJobDescription object and a JobDetail object
protected String	buildTriggerName(String name)
void	execute(org.quartz.JobExecutionContext jobexecutioncontext)
protected Class<? extends org.quartz.Job>	getClass(String path)
org.quartz.JobKey	getJobKeyForJobDescription(ERQSJobDescription aJobDescription)
protected Set<org.quartz.JobKey>	getScheduledJobKeys() Return a a set of jobs handled currently by Quartz.
protected boolean	isJobDescriptionValid(ERQSJobDescription aJobDescription)
protected void	modifyJob(ERQSJobDescription job2Check, org.quartz.JobDetail job)
EOEditingContext	newEditingContext() Called by editingContext().
protected void	removeObsoleteJobs(NSArray<? extends ERQSJobDescription> jobs2Check) From jobs2Check (a fresh list of ERQSJobDescription objects), removeJobs checks if jobs must be removed.

Methods inherited from class er.quartzscheduler.foundation.ERQSAbstractJob

editingContext, getJobContext, getScheduler, getSchedulerFPInstance, setResultMessage

Methods inherited from class java.lang.Object

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

Field Detail

TRIGGER_SUFFIX

public static final String TRIGGER_SUFFIX

DEFAULT_SLEEP_DURATION

public static final int DEFAULT_SLEEP_DURATION

See Also:

Constant Field Values

GROUP_NAME_PREFIX

public static final String GROUP_NAME_PREFIX

Constructor Detail

ERQSJobSupervisor

public ERQSJobSupervisor()

Method Detail

execute

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

Specified by:

execute in interface org.quartz.Job

Overrides:

execute in class ERQSAbstractJob

Throws:

org.quartz.JobExecutionException

getScheduledJobKeys

protected Set<org.quartz.JobKey> getScheduledJobKeys()

Return a a set of jobs handled currently by Quartz. Actually, it's a set of JobKey rather than Job.

Returns:

set of JobKeys, never return null but an empty set instead.

removeObsoleteJobs

protected void removeObsoleteJobs(NSArray<? extends ERQSJobDescription> jobs2Check)

From jobs2Check (a fresh list of ERQSJobDescription objects), removeJobs checks if jobs must be removed.

Parameters:

jobs2Check - list of ERQSJobDescription objects

addOrModifyJobs

protected void addOrModifyJobs(NSArray<? extends ERQSJobDescription> jobs2Check)

From jobs2Check (a fresh list of ERQSJobDescription objects), addOrModifyJobs checks if jobs must be added or modified.

Parameters:

jobs2Check - list of ERQSJobDescription objects

getJobKeyForJobDescription

public org.quartz.JobKey getJobKeyForJobDescription(ERQSJobDescription aJobDescription)

addJob2Scheduler

protected void addJob2Scheduler(ERQSJobDescription job2Add)

Add a job to the scheduler described the job description job2Add.

Parameters:

job2Add - job to add

modifyJob

protected void modifyJob(ERQSJobDescription job2Check,
                         org.quartz.JobDetail job)

buildJobDetail

protected org.quartz.JobDetail buildJobDetail(ERQSJobDescription jobDescription)

Return a job detail built from a ERQSJobDescription object

Parameters:

jobDescription -

Returns:

a JobDetail object

buildTriggerForJob

protected org.quartz.Trigger buildTriggerForJob(ERQSJobDescription jobDescription,
                                                org.quartz.JobDetail job)

Return a trigger built from a ERQSJobDescription object and a JobDetail object

Parameters:

jobDescription - (we suppose that jobDescription is a subclass of ERXGenericRecord or a non persistent object)

job -

Returns:

a Trigger object

buildTrigger

protected org.quartz.Trigger buildTrigger(String name,
                                          String group,
                                          String cronExpression,
                                          org.quartz.JobDataMap map,
                                          org.quartz.JobDetail job)

buildTriggerName

protected String buildTriggerName(String name)

buildGroup

protected String buildGroup(String group)

isJobDescriptionValid

protected boolean isJobDescriptionValid(ERQSJobDescription aJobDescription)

getClass

protected Class<? extends org.quartz.Job> getClass(String path)

newEditingContext

public EOEditingContext newEditingContext()

Description copied from class: ERQSAbstractJob

Called by editingContext(). Should not be called directly except if you need several editingContext.

Overrides:

newEditingContext in class ERQSAbstractJob

Returns:

new editingContext