er.quartzscheduler.util

Class ERQSSchedulerServiceFrameworkPrincipal

java.lang.Object

er.extensions.ERXFrameworkPrincipal

er.quartzscheduler.util.ERQSSchedulerServiceFrameworkPrincipal

Direct Known Subclasses:

ERQSSchedulerFP4Test

public abstract class ERQSSchedulerServiceFrameworkPrincipal
extends ERXFrameworkPrincipal

This framework principal is abstract so you must create you own class, put your code in the abstract method getListOfJobDescription, implement the methods newEditingContext(), newEditingContext(osc) and that's it!

Don't forget to include the following static code in your class:

 static 
 {
    log.debug("MyClassThatExtendsCOSchedulerServiceFrameworkPrincipal: static: ENTERED");
    setUpFrameworkPrincipalClass(MyClassThatExtendsCOSchedulerServiceFrameworkPrincipal.class);
    log.debug("MyClassThatExtendsCOSchedulerServiceFrameworkPrincipal: static: DONE");
 }

 

Author:

Philippe Rabier

Nested Class Summary

Nested classes/interfaces inherited from class er.extensions.ERXFrameworkPrincipal

ERXFrameworkPrincipal.Observer

Field Summary

Fields

Modifier and Type	Field and Description
static String	INSTANCE_KEY

Fields inherited from class er.extensions.ERXFrameworkPrincipal

initializedFrameworks, launchingFrameworks

Constructor Summary

Constructors

Constructor and Description
ERQSSchedulerServiceFrameworkPrincipal()

Method Summary

Modifier and Type	Method and Description
protected void	addJobListener(org.quartz.JobListener newJobListener) Use this method if you need to add other listeners jobs handled by COScheduler, aka job with group beginning with ERQSJobSupervisor.GROUP_NAME_PREFIX
void	deleteAllJobs()
void	finishInitialization() This method initializes the scheduler service.
List<org.quartz.JobDetail>	getAllJobs() Return a list of all jobs handled by the scheduler, even those that are not managed by the framework, aka jobs that have been added manually.
protected org.quartz.JobListener	getDefaultJobListener() This method returns a joblistener object.
abstract NSArray<? extends ERQSJobDescription>	getListOfJobDescription(com.webobjects.eocontrol.EOEditingContext editingContext) Expects that this method never returns null but an empty array if there is no job
org.quartz.Scheduler	getScheduler() Return the quartz scheduler which schedules the job described by ERQSJobDescription objects.
static ERQSSchedulerServiceFrameworkPrincipal	getSharedInstance()
org.quartz.Trigger	getTriggerOfJob(org.quartz.JobKey aJobKey)
org.quartz.Trigger.TriggerState	getTriggerState(org.quartz.JobKey aJobKey)
boolean	hasRunningJobs()
protected void	instantiateJobSupervisor()
abstract com.webobjects.eocontrol.EOEditingContext	newEditingContext() This method is used by a job that subclasses ERQSAbstractJob.
abstract com.webobjects.eocontrol.EOEditingContext	newEditingContext(com.webobjects.eocontrol.EOObjectStore parent) This method is used by a job that subclasses ERQSAbstractJob.
static boolean	schedulerMustRun() This method reads the the property er.quartzscheduler.schedulerServiceToLaunch
static void	setSharedInstance(ERQSSchedulerServiceFrameworkPrincipal aSharedInstance)
void	stopScheduler()
protected int	supervisorSleepDuration()
void	triggerNow(org.quartz.JobDetail aJob)

Methods inherited from class er.extensions.ERXFrameworkPrincipal

didFinishInitialization, hasFrameworkInstalled, initialize, setUpFrameworkPrincipalClass, sharedInstance, toString

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE_KEY

public static final String INSTANCE_KEY

See Also:

Constant Field Values

Constructor Detail

ERQSSchedulerServiceFrameworkPrincipal

public ERQSSchedulerServiceFrameworkPrincipal()

Method Detail

getSharedInstance

public static ERQSSchedulerServiceFrameworkPrincipal getSharedInstance()

Returns:

shared instance of framework principal

setSharedInstance

public static void setSharedInstance(ERQSSchedulerServiceFrameworkPrincipal aSharedInstance)

getListOfJobDescription

public abstract NSArray<? extends ERQSJobDescription> getListOfJobDescription(com.webobjects.eocontrol.EOEditingContext editingContext)

Expects that this method never returns null but an empty array if there is no job

Returns:

array of job description to check.

newEditingContext

public abstract com.webobjects.eocontrol.EOEditingContext newEditingContext()

This method is used by a job that subclasses ERQSAbstractJob. It must return an editing context and it's highly recommended that useAutolock() returns false.
It's also highly recommended to use a new object store coordinator if you work heavily with EOF. We recommend that you create your own factory as follow:

        private static ERXEC.Factory manualLockingEditingContextFactory = new ERXEC.DefaultFactory() {

                protected EOEditingContext _createEditingContext(final EOObjectStore parent) 
                {
                        return new MyEditingContext(parent == null ? EOEditingContext.defaultParentObjectStore() : parent) 
                        {
                                public boolean useAutoLock() {return false;}

                                public boolean coalesceAutoLocks() {return false;}
                        };
                }

 

Then implement newEditingContext() as follow:

 public EOEditingContext newEditingContext()
 {
    EOObjectStoreCoordinator osc = ERXTaskObjectStoreCoordinatorPool.objectStoreCoordinator();
    return COEditingContextFactory.newManualLockingEditingContext(osc);
 }
 

Returns:

new editingContext

newEditingContext

public abstract com.webobjects.eocontrol.EOEditingContext newEditingContext(com.webobjects.eocontrol.EOObjectStore parent)

This method is used by a job that subclasses ERQSAbstractJob. The first time a job asks for a new editing context, the method newEditingContext() is called. Then the following requests call this method by passing the object store coordinator used the first time.

finishInitialization

public void finishInitialization()

This method initializes the scheduler service.

The following services must be set:

• er.quartzscheduler.schedulerServiceToLaunch=true or false to launch or not the service
• er.quartzscheduler.triggersAutomaticallyPaused=true or false. If true any new job/trigger will be in pause mode when added to the scheduler. Very useful when you are developing and debugging your code.

Specified by:

finishInitialization in class ERXFrameworkPrincipal

schedulerMustRun

public static boolean schedulerMustRun()

This method reads the the property er.quartzscheduler.schedulerServiceToLaunch

It's a static method because the sharedInstance could be null if it's not running.

Returns:

true if the scheduler should run, false by default.

getScheduler

public org.quartz.Scheduler getScheduler()

Return the quartz scheduler which schedules the job described by ERQSJobDescription objects.

As the quartz scheduler is uses a ram job stores, everything is gone when the scheduler stops.
The persistence must be handled by your own EOs which must implement ERQSJobDescription interface.

You have several options to set quartz properties:

• do nothing. Quartz will use the default property file quartz.properties in quartz.jar
• define the property "org.quartz.properties" with the full path of your property file
• define the properties "quartz.properties.fileName" and "quartz.properties.framework". If "quartz.properties.framework" is missing the mainBundle is used to find the filePath of your property file.

Returns:

the scheduler

See Also:

ERQSJobDescription

getAllJobs

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

Return a list of all jobs handled by the scheduler, even those that are not managed by the framework, aka jobs that have been added manually.

Returns:

immutable list of all job detail or an empty list

hasRunningJobs

public boolean hasRunningJobs()

getTriggerState

public org.quartz.Trigger.TriggerState getTriggerState(org.quartz.JobKey aJobKey)

getTriggerOfJob

public org.quartz.Trigger getTriggerOfJob(org.quartz.JobKey aJobKey)

triggerNow

public void triggerNow(org.quartz.JobDetail aJob)
                throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

instantiateJobSupervisor

protected void instantiateJobSupervisor()

addJobListener

protected void addJobListener(org.quartz.JobListener newJobListener)

Use this method if you need to add other listeners jobs handled by COScheduler, aka job with group beginning with ERQSJobSupervisor.GROUP_NAME_PREFIX

Parameters:

newJobListener -

getDefaultJobListener

protected org.quartz.JobListener getDefaultJobListener()

This method returns a joblistener object. If you used annotation to change the default job listener, getDefaultJobListener() will return an instance of your own class. Otherwise, it will return a ERQSJobListener object

Returns:

a JobListener object

supervisorSleepDuration

protected int supervisorSleepDuration()

deleteAllJobs

public void deleteAllJobs()

stopScheduler

public void stopScheduler()