org.quartz.impl.jdbcjobstore

Class JobStoreSupport

java.lang.Object

org.quartz.impl.jdbcjobstore.JobStoreSupport

All Implemented Interfaces:

Constants, JobStore

Direct Known Subclasses:

JobStoreCMT, JobStoreTX

public abstract class JobStoreSupport
extends java.lang.Object
implements JobStore, Constants

Contains base functionality for JDBC-based JobStore implementations.

Author:

Jeffrey Wescott, James House

Field Summary

Fields inherited from interface org.quartz.impl.jdbcjobstore.Constants

ALIAS_COL_NEXT_FIRE_TIME, ALL_GROUPS_PAUSED, COL_BLOB, COL_CALENDAR, COL_CALENDAR_NAME, COL_CHECKIN_INTERVAL, COL_CRON_EXPRESSION, COL_DESCRIPTION, COL_END_TIME, COL_ENTRY_ID, COL_ENTRY_STATE, COL_FIRED_TIME, COL_INSTANCE_NAME, COL_IS_DURABLE, COL_IS_STATEFUL, COL_IS_VOLATILE, COL_JOB_CLASS, COL_JOB_DATAMAP, COL_JOB_GROUP, COL_JOB_LISTENER, COL_JOB_NAME, COL_LAST_CHECKIN_TIME, COL_LOCK_NAME, COL_MISFIRE_INSTRUCTION, COL_NEXT_FIRE_TIME, COL_PREV_FIRE_TIME, COL_PRIORITY, COL_REPEAT_COUNT, COL_REPEAT_INTERVAL, COL_REQUESTS_RECOVERY, COL_START_TIME, COL_TIME_ZONE_ID, COL_TIMES_TRIGGERED, COL_TRIGGER_GROUP, COL_TRIGGER_LISTENER, COL_TRIGGER_NAME, COL_TRIGGER_STATE, COL_TRIGGER_TYPE, DEFAULT_TABLE_PREFIX, STATE_ACQUIRED, STATE_BLOCKED, STATE_COMPLETE, STATE_DELETED, STATE_ERROR, STATE_EXECUTING, STATE_MISFIRED, STATE_PAUSED, STATE_PAUSED_BLOCKED, STATE_WAITING, TABLE_BLOB_TRIGGERS, TABLE_CALENDARS, TABLE_CRON_TRIGGERS, TABLE_FIRED_TRIGGERS, TABLE_JOB_DETAILS, TABLE_JOB_LISTENERS, TABLE_LOCKS, TABLE_PAUSED_TRIGGERS, TABLE_SCHEDULER_STATE, TABLE_SIMPLE_TRIGGERS, TABLE_TRIGGER_LISTENERS, TABLE_TRIGGERS, TTYPE_BLOB, TTYPE_CRON, TTYPE_SIMPLE

Constructor Summary

Constructors

Constructor and Description
JobStoreSupport()

Method Summary

Methods

Modifier and Type	Method and Description
Trigger	acquireNextTrigger(SchedulingContext ctxt, long noLaterThan) Get a handle to the next N triggers to be fired, and mark them as 'reserved' by the calling scheduler.
boolean	canUseProperties() Get whether String-only properties will be handled in JobDataMaps.
java.lang.Object	executeWithoutLock(org.quartz.impl.jdbcjobstore.JobStoreSupport.TransactionCallback txCallback) Execute the given callback in a transaction.
java.lang.String[]	getCalendarNames(SchedulingContext ctxt) Get the names of all of the Calendar s in the JobStore.
long	getClusterCheckinInterval() Get the frequency (in milliseconds) at which this instance "checks-in" with the other instances of the cluster. -- Affects the rate of detecting failed instances.
java.lang.String	getDataSource() Get the name of the DataSource that should be used for performing database functions.
long	getDbRetryInterval()
boolean	getDoubleCheckLockMisfireHandler() Get whether to check to see if there are Triggers that have misfired before actually acquiring the lock to recover them.
java.lang.String	getDriverDelegateClass() Get the JDBC driver delegate class name.
java.lang.String	getInstanceId() Get the instance Id of the Scheduler (must be unique within a cluster).
java.lang.String	getInstanceName() Get the instance name of the Scheduler (must be unique within this server instance).
java.lang.String[]	getJobGroupNames(SchedulingContext ctxt) Get the names of all of the Job groups.
java.lang.String[]	getJobNames(SchedulingContext ctxt, java.lang.String groupName) Get the names of all of the Job s that have the given group name.
boolean	getMakeThreadsDaemons() Get whether the threads spawned by this JobStore should be marked as daemon.
int	getMaxMisfiresToHandleAtATime() Get the maximum number of misfired triggers that the misfire handling thread will try to recover at one time (within one transaction).
long	getMisfireThreshold()
int	getNumberOfCalendars(SchedulingContext ctxt) Get the number of Calendar s that are stored in the JobsStore.
int	getNumberOfJobs(SchedulingContext ctxt) Get the number of Job s that are stored in the JobStore.
int	getNumberOfTriggers(SchedulingContext ctxt) Get the number of Trigger s that are stored in the JobsStore.
java.util.Set	getPausedTriggerGroups(java.sql.Connection conn, SchedulingContext ctxt) Pause all of the Triggers in the given group.
java.util.Set	getPausedTriggerGroups(SchedulingContext ctxt)
java.lang.String	getSelectWithLockSQL()
java.lang.String	getTablePrefix() Get the prefix that should be pre-pended to all table names.
java.lang.String[]	getTriggerGroupNames(SchedulingContext ctxt) Get the names of all of the Trigger groups.
java.lang.String[]	getTriggerNames(SchedulingContext ctxt, java.lang.String groupName) Get the names of all of the Trigger s that have the given group name.
Trigger[]	getTriggersForJob(SchedulingContext ctxt, java.lang.String jobName, java.lang.String groupName) Get all of the Triggers that are associated to the given Job.
int	getTriggerState(java.sql.Connection conn, SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName)
int	getTriggerState(SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName) Get the current state of the identified Trigger.
boolean	getUseDBLocks() Get whether this instance should use database-based thread synchronization.
void	initialize(ClassLoadHelper loadHelper, SchedulerSignaler signaler) Called by the QuartzScheduler before the JobStore is used, in order to give it a chance to initialize.
boolean	isAcquireTriggersWithinLock() Whether or not the query and update to acquire a Trigger for firing should be performed after obtaining an explicit DB lock (to avoid possible race conditions on the trigger's db row).
boolean	isClustered() Get whether this instance is part of a cluster.
boolean	isDontSetAutoCommitFalse()
boolean	isLockOnInsert()
boolean	isThreadsInheritInitializersClassLoadContext() Get whether to set the class load context of spawned threads to that of the initializing thread.
boolean	isTxIsolationLevelSerializable()
void	pauseAll(java.sql.Connection conn, SchedulingContext ctxt) Pause all triggers - equivalent of calling pauseTriggerGroup(group) on every group.
void	pauseAll(SchedulingContext ctxt) Pause all triggers - equivalent of calling pauseTriggerGroup(group) on every group.
void	pauseJob(SchedulingContext ctxt, java.lang.String jobName, java.lang.String groupName) Pause the Job with the given name - by pausing all of its current Triggers.
void	pauseJobGroup(SchedulingContext ctxt, java.lang.String groupName) Pause all of the Jobs in the given group - by pausing all of their Triggers.
void	pauseTrigger(java.sql.Connection conn, SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName) Pause the Trigger with the given name.
void	pauseTrigger(SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName) Pause the Trigger with the given name.
void	pauseTriggerGroup(java.sql.Connection conn, SchedulingContext ctxt, java.lang.String groupName) Pause all of the Triggers in the given group.
void	pauseTriggerGroup(SchedulingContext ctxt, java.lang.String groupName) Pause all of the Triggers in the given group.
void	releaseAcquiredTrigger(SchedulingContext ctxt, Trigger trigger) Inform the JobStore that the scheduler no longer plans to fire the given Trigger, that it had previously acquired (reserved).
boolean	removeCalendar(SchedulingContext ctxt, java.lang.String calName) Remove (delete) the Calendar with the given name.
boolean	removeJob(SchedulingContext ctxt, java.lang.String jobName, java.lang.String groupName) Remove (delete) the Job with the given name, and any Trigger s that reference it.
boolean	removeTrigger(SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName) Remove (delete) the Trigger with the given name.
boolean	replaceTrigger(SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName, Trigger newTrigger) Remove (delete) the Trigger with the given name, and store the new given one - which must be associated with the same job.
void	resumeAll(java.sql.Connection conn, SchedulingContext ctxt) protected Resume (un-pause) all triggers - equivalent of calling resumeTriggerGroup(group) on every group.
void	resumeAll(SchedulingContext ctxt) Resume (un-pause) all triggers - equivalent of calling resumeTriggerGroup(group) on every group.
void	resumeJob(SchedulingContext ctxt, java.lang.String jobName, java.lang.String groupName) Resume (un-pause) the Job with the given name.
void	resumeJobGroup(SchedulingContext ctxt, java.lang.String groupName) Resume (un-pause) all of the Jobs in the given group.
void	resumeTrigger(java.sql.Connection conn, SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName) Resume (un-pause) the Trigger with the given name.
void	resumeTrigger(SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName) Resume (un-pause) the Trigger with the given name.
void	resumeTriggerGroup(java.sql.Connection conn, SchedulingContext ctxt, java.lang.String groupName) Resume (un-pause) all of the Triggers in the given group.
void	resumeTriggerGroup(SchedulingContext ctxt, java.lang.String groupName) Resume (un-pause) all of the Triggers in the given group.
Calendar	retrieveCalendar(SchedulingContext ctxt, java.lang.String calName) Retrieve the given Trigger.
JobDetail	retrieveJob(SchedulingContext ctxt, java.lang.String jobName, java.lang.String groupName) Retrieve the JobDetail for the given Job.
Trigger	retrieveTrigger(SchedulingContext ctxt, java.lang.String triggerName, java.lang.String groupName) Retrieve the given Trigger.
void	schedulerStarted() Called by the QuartzScheduler to inform the JobStore that the scheduler has started.
void	setAcquireTriggersWithinLock(boolean acquireTriggersWithinLock) Whether or not the query and update to acquire a Trigger for firing should be performed after obtaining an explicit DB lock.
void	setClusterCheckinInterval(long l) Set the frequency (in milliseconds) at which this instance "checks-in" with the other instances of the cluster. -- Affects the rate of detecting failed instances.
void	setDataSource(java.lang.String dsName) Set the name of the DataSource that should be used for performing database functions.
void	setDbRetryInterval(long dbRetryInterval)
void	setDontSetAutoCommitFalse(boolean b) Don't call set autocommit(false) on connections obtained from the DataSource.
void	setDoubleCheckLockMisfireHandler(boolean doubleCheckLockMisfireHandler) Set whether to check to see if there are Triggers that have misfired before actually acquiring the lock to recover them.
void	setDriverDelegateClass(java.lang.String delegateClassName) Set the JDBC driver delegate class.
void	setInstanceId(java.lang.String instanceId) Set the instance Id of the Scheduler (must be unique within a cluster).
void	setInstanceName(java.lang.String instanceName) Set the instance name of the Scheduler (must be unique within this server instance).
void	setIsClustered(boolean isClustered) Set whether this instance is part of a cluster.
void	setLockHandler(Semaphore lockHandler)
void	setLockOnInsert(boolean lockOnInsert) Whether or not to obtain locks when inserting new jobs/triggers.
void	setMakeThreadsDaemons(boolean makeThreadsDaemons) Set whether the threads spawned by this JobStore should be marked as daemon.
void	setMaxMisfiresToHandleAtATime(int maxToRecoverAtATime) Set the maximum number of misfired triggers that the misfire handling thread will try to recover at one time (within one transaction).
void	setMisfireThreshold(long misfireThreshold) The the number of milliseconds by which a trigger must have missed its next-fire-time, in order for it to be considered "misfired" and thus have its misfire instruction applied.
void	setSelectWithLockSQL(java.lang.String string) set the SQL statement to use to select and lock a row in the "locks" table.
void	setTablePrefix(java.lang.String prefix) Set the prefix that should be pre-pended to all table names.
void	setThreadsInheritInitializersClassLoadContext(boolean threadsInheritInitializersClassLoadContext) Set whether to set the class load context of spawned threads to that of the initializing thread.
void	setTxIsolationLevelSerializable(boolean b) Set the transaction isolation level of DB connections to sequential.
void	setUseDBLocks(boolean useDBLocks) Set whether this instance should use database-based thread synchronization.
void	setUseProperties(java.lang.String useProp) Set whether String-only properties will be handled in JobDataMaps.
void	shutdown() Called by the QuartzScheduler to inform the JobStore that it should free up all of it's resources because the scheduler is shutting down.
void	storeCalendar(SchedulingContext ctxt, java.lang.String calName, Calendar calendar, boolean replaceExisting, boolean updateTriggers) Store the given Calendar.
void	storeJob(SchedulingContext ctxt, JobDetail newJob, boolean replaceExisting) Store the given JobDetail.
void	storeJobAndTrigger(SchedulingContext ctxt, JobDetail newJob, Trigger newTrigger) Store the given JobDetail and Trigger.
void	storeTrigger(SchedulingContext ctxt, Trigger newTrigger, boolean replaceExisting) Store the given Trigger.
boolean	supportsPersistence()
void	triggeredJobComplete(SchedulingContext ctxt, Trigger trigger, JobDetail jobDetail, int triggerInstCode) Inform the JobStore that the scheduler has completed the firing of the given Trigger (and the execution its associated Job), and that the JobDataMap in the given JobDetail should be updated if the Job is stateful.
TriggerFiredBundle	triggerFired(SchedulingContext ctxt, Trigger trigger) Inform the JobStore that the scheduler is now firing the given Trigger (executing its associated Job), that it had previously acquired (reserved).

Methods inherited from class java.lang.Object

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

Constructor Detail

JobStoreSupport

public JobStoreSupport()

Method Detail

setDataSource

public void setDataSource(java.lang.String dsName)

Set the name of the DataSource that should be used for performing database functions.

getDataSource

public java.lang.String getDataSource()

Get the name of the DataSource that should be used for performing database functions.

setTablePrefix

public void setTablePrefix(java.lang.String prefix)

Set the prefix that should be pre-pended to all table names.

getTablePrefix

public java.lang.String getTablePrefix()

Get the prefix that should be pre-pended to all table names.

setUseProperties

public void setUseProperties(java.lang.String useProp)

Set whether String-only properties will be handled in JobDataMaps.

canUseProperties

public boolean canUseProperties()

Get whether String-only properties will be handled in JobDataMaps.

setInstanceId

public void setInstanceId(java.lang.String instanceId)

Set the instance Id of the Scheduler (must be unique within a cluster).

getInstanceId

public java.lang.String getInstanceId()

Get the instance Id of the Scheduler (must be unique within a cluster).

setInstanceName

public void setInstanceName(java.lang.String instanceName)

Set the instance name of the Scheduler (must be unique within this server instance).

getInstanceName

public java.lang.String getInstanceName()

Get the instance name of the Scheduler (must be unique within this server instance).

setIsClustered

public void setIsClustered(boolean isClustered)

Set whether this instance is part of a cluster.

isClustered

public boolean isClustered()

Get whether this instance is part of a cluster.

getClusterCheckinInterval

public long getClusterCheckinInterval()

Get the frequency (in milliseconds) at which this instance "checks-in" with the other instances of the cluster. -- Affects the rate of detecting failed instances.

setClusterCheckinInterval

public void setClusterCheckinInterval(long l)

Set the frequency (in milliseconds) at which this instance "checks-in" with the other instances of the cluster. -- Affects the rate of detecting failed instances.

getMaxMisfiresToHandleAtATime

public int getMaxMisfiresToHandleAtATime()

Get the maximum number of misfired triggers that the misfire handling thread will try to recover at one time (within one transaction). The default is 20.

setMaxMisfiresToHandleAtATime

public void setMaxMisfiresToHandleAtATime(int maxToRecoverAtATime)

Set the maximum number of misfired triggers that the misfire handling thread will try to recover at one time (within one transaction). The default is 20.

getDbRetryInterval

public long getDbRetryInterval()

Returns:

Returns the dbRetryInterval.

setDbRetryInterval

public void setDbRetryInterval(long dbRetryInterval)

Parameters:

dbRetryInterval - The dbRetryInterval to set.

setUseDBLocks

public void setUseDBLocks(boolean useDBLocks)

Set whether this instance should use database-based thread synchronization.

getUseDBLocks

public boolean getUseDBLocks()

Get whether this instance should use database-based thread synchronization.

isLockOnInsert

public boolean isLockOnInsert()

setLockOnInsert

public void setLockOnInsert(boolean lockOnInsert)

Whether or not to obtain locks when inserting new jobs/triggers. Defaults to true, which is safest - some db's (such as MS SQLServer) seem to require this to avoid deadlocks under high load, while others seem to do fine without.

Setting this property to false will provide a significant performance increase during the addition of new jobs and triggers.

Parameters:

lockOnInsert -

getMisfireThreshold

public long getMisfireThreshold()

setMisfireThreshold

public void setMisfireThreshold(long misfireThreshold)

The the number of milliseconds by which a trigger must have missed its next-fire-time, in order for it to be considered "misfired" and thus have its misfire instruction applied.

Parameters:

misfireThreshold -

isDontSetAutoCommitFalse

public boolean isDontSetAutoCommitFalse()

setDontSetAutoCommitFalse

public void setDontSetAutoCommitFalse(boolean b)

Don't call set autocommit(false) on connections obtained from the DataSource. This can be helpfull in a few situations, such as if you have a driver that complains if it is called when it is already off.

Parameters:

b -

isTxIsolationLevelSerializable

public boolean isTxIsolationLevelSerializable()

setTxIsolationLevelSerializable

public void setTxIsolationLevelSerializable(boolean b)

Set the transaction isolation level of DB connections to sequential.

Parameters:

b -

isAcquireTriggersWithinLock

public boolean isAcquireTriggersWithinLock()

Whether or not the query and update to acquire a Trigger for firing should be performed after obtaining an explicit DB lock (to avoid possible race conditions on the trigger's db row). This is the behavior prior to Quartz 1.6.3, but is considered unnecessary for most databases (due to the nature of the SQL update that is performed), and therefore a superfluous performance hit.

setAcquireTriggersWithinLock

public void setAcquireTriggersWithinLock(boolean acquireTriggersWithinLock)

Whether or not the query and update to acquire a Trigger for firing should be performed after obtaining an explicit DB lock. This is the behavior prior to Quartz 1.6.3, but is considered unnecessary for most databases, and therefore a superfluous performance hit.

setDriverDelegateClass

public void setDriverDelegateClass(java.lang.String delegateClassName)
                            throws InvalidConfigurationException

Set the JDBC driver delegate class.

Parameters:

delegateClassName - the delegate class name

Throws:

InvalidConfigurationException

getDriverDelegateClass

public java.lang.String getDriverDelegateClass()

Get the JDBC driver delegate class name.

Returns:

the delegate class name

getSelectWithLockSQL

public java.lang.String getSelectWithLockSQL()

setSelectWithLockSQL

public void setSelectWithLockSQL(java.lang.String string)

set the SQL statement to use to select and lock a row in the "locks" table.

See Also:

StdRowLockSemaphore

getMakeThreadsDaemons

public boolean getMakeThreadsDaemons()

Get whether the threads spawned by this JobStore should be marked as daemon. Possible threads include the MisfireHandler and the ClusterManager.

See Also:

Thread.setDaemon(boolean)

setMakeThreadsDaemons

public void setMakeThreadsDaemons(boolean makeThreadsDaemons)

Set whether the threads spawned by this JobStore should be marked as daemon. Possible threads include the MisfireHandler and the ClusterManager.

See Also:

Thread.setDaemon(boolean)

isThreadsInheritInitializersClassLoadContext

public boolean isThreadsInheritInitializersClassLoadContext()

Get whether to set the class load context of spawned threads to that of the initializing thread.

setThreadsInheritInitializersClassLoadContext

public void setThreadsInheritInitializersClassLoadContext(boolean threadsInheritInitializersClassLoadContext)

Set whether to set the class load context of spawned threads to that of the initializing thread.

getDoubleCheckLockMisfireHandler

public boolean getDoubleCheckLockMisfireHandler()

Get whether to check to see if there are Triggers that have misfired before actually acquiring the lock to recover them. This should be set to false if the majority of the time, there are are misfired Triggers.

setDoubleCheckLockMisfireHandler

public void setDoubleCheckLockMisfireHandler(boolean doubleCheckLockMisfireHandler)

Set whether to check to see if there are Triggers that have misfired before actually acquiring the lock to recover them. This should be set to false if the majority of the time, there are are misfired Triggers.

initialize

public void initialize(ClassLoadHelper loadHelper,
              SchedulerSignaler signaler)
                throws SchedulerConfigException

Called by the QuartzScheduler before the JobStore is used, in order to give it a chance to initialize.

Specified by:

initialize in interface JobStore

Throws:

SchedulerConfigException

schedulerStarted

public void schedulerStarted()
                      throws SchedulerException

Description copied from interface: JobStore

Called by the QuartzScheduler to inform the JobStore that the scheduler has started.

Specified by:

schedulerStarted in interface JobStore

Throws:

SchedulerException

See Also:

JobStore.schedulerStarted()

shutdown

public void shutdown()

Called by the QuartzScheduler to inform the JobStore that it should free up all of it's resources because the scheduler is shutting down.

Specified by:

shutdown in interface JobStore

supportsPersistence

public boolean supportsPersistence()

Specified by:

supportsPersistence in interface JobStore

storeJobAndTrigger

public void storeJobAndTrigger(SchedulingContext ctxt,
                      JobDetail newJob,
                      Trigger newTrigger)
                        throws ObjectAlreadyExistsException,
                               JobPersistenceException

Store the given JobDetail and Trigger.

Specified by:

storeJobAndTrigger in interface JobStore

Parameters:

newJob - The JobDetail to be stored.

newTrigger - The Trigger to be stored.

Throws:

ObjectAlreadyExistsException - if a Job with the same name/group already exists.

JobPersistenceException

storeJob

public void storeJob(SchedulingContext ctxt,
            JobDetail newJob,
            boolean replaceExisting)
              throws ObjectAlreadyExistsException,
                     JobPersistenceException

Store the given JobDetail.

Specified by:

storeJob in interface JobStore

Parameters:

newJob - The JobDetail to be stored.

replaceExisting - If true, any Job existing in the JobStore with the same name & group should be over-written.

Throws:

ObjectAlreadyExistsException - if a Job with the same name/group already exists, and replaceExisting is set to false.

JobPersistenceException

storeTrigger

public void storeTrigger(SchedulingContext ctxt,
                Trigger newTrigger,
                boolean replaceExisting)
                  throws ObjectAlreadyExistsException,
                         JobPersistenceException

Store the given Trigger.

Specified by:

storeTrigger in interface JobStore

Parameters:

newTrigger - The Trigger to be stored.

replaceExisting - If true, any Trigger existing in the JobStore with the same name & group should be over-written.

Throws:

ObjectAlreadyExistsException - if a Trigger with the same name/group already exists, and replaceExisting is set to false.

JobPersistenceException

See Also:

JobStore.pauseTriggerGroup(SchedulingContext, String)

removeJob

public boolean removeJob(SchedulingContext ctxt,
                java.lang.String jobName,
                java.lang.String groupName)
                  throws JobPersistenceException

Remove (delete) the Job with the given name, and any Trigger s that reference it.

If removal of the Job results in an empty group, the group should be removed from the JobStore's list of known group names.

Specified by:

removeJob in interface JobStore

Parameters:

jobName - The name of the Job to be removed.

groupName - The group name of the Job to be removed.

Returns:

true if a Job with the given name & group was found and removed from the store.

Throws:

JobPersistenceException

retrieveJob

public JobDetail retrieveJob(SchedulingContext ctxt,
                    java.lang.String jobName,
                    java.lang.String groupName)
                      throws JobPersistenceException

Retrieve the JobDetail for the given Job.

Specified by:

retrieveJob in interface JobStore

Parameters:

jobName - The name of the Job to be retrieved.

groupName - The group name of the Job to be retrieved.

Returns:

The desired Job, or null if there is no match.

Throws:

JobPersistenceException

removeTrigger

public boolean removeTrigger(SchedulingContext ctxt,
                    java.lang.String triggerName,
                    java.lang.String groupName)
                      throws JobPersistenceException

Remove (delete) the Trigger with the given name.

If removal of the Trigger results in an empty group, the group should be removed from the JobStore's list of known group names.

If removal of the Trigger results in an 'orphaned' Job that is not 'durable', then the Job should be deleted also.

Specified by:

removeTrigger in interface JobStore

Parameters:

triggerName - The name of the Trigger to be removed.

groupName - The group name of the Trigger to be removed.

Returns:

true if a Trigger with the given name & group was found and removed from the store.

Throws:

JobPersistenceException

replaceTrigger

public boolean replaceTrigger(SchedulingContext ctxt,
                     java.lang.String triggerName,
                     java.lang.String groupName,
                     Trigger newTrigger)
                       throws JobPersistenceException

Description copied from interface: JobStore

Remove (delete) the Trigger with the given name, and store the new given one - which must be associated with the same job.

Specified by:

replaceTrigger in interface JobStore

triggerName - The name of the Trigger to be removed.

groupName - The group name of the Trigger to be removed.

newTrigger - The new Trigger to be stored.

Returns:

true if a Trigger with the given name & group was found and removed from the store.

Throws:

JobPersistenceException

See Also:

JobStore.replaceTrigger(org.quartz.core.SchedulingContext, java.lang.String, java.lang.String, org.quartz.Trigger)

retrieveTrigger

public Trigger retrieveTrigger(SchedulingContext ctxt,
                      java.lang.String triggerName,
                      java.lang.String groupName)
                        throws JobPersistenceException

Retrieve the given Trigger.

Specified by:

retrieveTrigger in interface JobStore

Parameters:

triggerName - The name of the Trigger to be retrieved.

groupName - The group name of the Trigger to be retrieved.

Returns:

The desired Trigger, or null if there is no match.

Throws:

JobPersistenceException

getTriggerState

public int getTriggerState(SchedulingContext ctxt,
                  java.lang.String triggerName,
                  java.lang.String groupName)
                    throws JobPersistenceException

Get the current state of the identified Trigger.

Specified by:

getTriggerState in interface JobStore

Throws:

JobPersistenceException

See Also:

Trigger.STATE_NORMAL, Trigger.STATE_PAUSED, Trigger.STATE_COMPLETE, Trigger.STATE_ERROR, Trigger.STATE_NONE

getTriggerState

public int getTriggerState(java.sql.Connection conn,
                  SchedulingContext ctxt,
                  java.lang.String triggerName,
                  java.lang.String groupName)
                    throws JobPersistenceException

Throws:

JobPersistenceException

storeCalendar

public void storeCalendar(SchedulingContext ctxt,
                 java.lang.String calName,
                 Calendar calendar,
                 boolean replaceExisting,
                 boolean updateTriggers)
                   throws ObjectAlreadyExistsException,
                          JobPersistenceException

Store the given Calendar.

Specified by:

storeCalendar in interface JobStore

Parameters:

calName - The name of the calendar.

calendar - The Calendar to be stored.

replaceExisting - If true, any Calendar existing in the JobStore with the same name & group should be over-written.

updateTriggers - If true, any Triggers existing in the JobStore that reference an existing Calendar with the same name with have their next fire time re-computed with the new Calendar.

Throws:

ObjectAlreadyExistsException - if a Calendar with the same name already exists, and replaceExisting is set to false.

JobPersistenceException

removeCalendar

public boolean removeCalendar(SchedulingContext ctxt,
                     java.lang.String calName)
                       throws JobPersistenceException

Remove (delete) the Calendar with the given name.

If removal of the Calendar would result in s pointing to non-existent calendars, then a JobPersistenceException will be thrown.

*

Specified by:

removeCalendar in interface JobStore

Parameters:

calName - The name of the Calendar to be removed.

Returns:

true if a Calendar with the given name was found and removed from the store.

Throws:

JobPersistenceException

retrieveCalendar

public Calendar retrieveCalendar(SchedulingContext ctxt,
                        java.lang.String calName)
                          throws JobPersistenceException

Retrieve the given Trigger.

Specified by:

retrieveCalendar in interface JobStore

Parameters:

calName - The name of the Calendar to be retrieved.

Returns:

The desired Calendar, or null if there is no match.

Throws:

JobPersistenceException

getNumberOfJobs

public int getNumberOfJobs(SchedulingContext ctxt)
                    throws JobPersistenceException

Get the number of Job s that are stored in the JobStore.

Specified by:

getNumberOfJobs in interface JobStore

Throws:

JobPersistenceException

getNumberOfTriggers

public int getNumberOfTriggers(SchedulingContext ctxt)
                        throws JobPersistenceException

Get the number of Trigger s that are stored in the JobsStore.

Specified by:

getNumberOfTriggers in interface JobStore

Throws:

JobPersistenceException

getNumberOfCalendars

public int getNumberOfCalendars(SchedulingContext ctxt)
                         throws JobPersistenceException

Get the number of Calendar s that are stored in the JobsStore.

Specified by:

getNumberOfCalendars in interface JobStore

Throws:

JobPersistenceException

getJobNames

public java.lang.String[] getJobNames(SchedulingContext ctxt,
                             java.lang.String groupName)
                               throws JobPersistenceException

Get the names of all of the Job s that have the given group name.

If there are no jobs in the given group name, the result should be a zero-length array (not null).

Specified by:

getJobNames in interface JobStore

Throws:

JobPersistenceException

getTriggerNames

public java.lang.String[] getTriggerNames(SchedulingContext ctxt,
                                 java.lang.String groupName)
                                   throws JobPersistenceException

Get the names of all of the Trigger s that have the given group name.

If there are no triggers in the given group name, the result should be a zero-length array (not null).

Specified by:

getTriggerNames in interface JobStore

Throws:

JobPersistenceException

getJobGroupNames

public java.lang.String[] getJobGroupNames(SchedulingContext ctxt)
                                    throws JobPersistenceException

Get the names of all of the Job groups.

If there are no known group names, the result should be a zero-length array (not null).

Specified by:

getJobGroupNames in interface JobStore

Throws:

JobPersistenceException

getTriggerGroupNames

public java.lang.String[] getTriggerGroupNames(SchedulingContext ctxt)
                                        throws JobPersistenceException

Get the names of all of the Trigger groups.

If there are no known group names, the result should be a zero-length array (not null).

Specified by:

getTriggerGroupNames in interface JobStore

Throws:

JobPersistenceException

getCalendarNames

public java.lang.String[] getCalendarNames(SchedulingContext ctxt)
                                    throws JobPersistenceException

Get the names of all of the Calendar s in the JobStore.

If there are no Calendars in the given group name, the result should be a zero-length array (not null).

Specified by:

getCalendarNames in interface JobStore

Throws:

JobPersistenceException

getTriggersForJob

public Trigger[] getTriggersForJob(SchedulingContext ctxt,
                          java.lang.String jobName,
                          java.lang.String groupName)
                            throws JobPersistenceException

Get all of the Triggers that are associated to the given Job.

If there are no matches, a zero-length array should be returned.

Specified by:

getTriggersForJob in interface JobStore

Throws:

JobPersistenceException

pauseTrigger

public void pauseTrigger(SchedulingContext ctxt,
                java.lang.String triggerName,
                java.lang.String groupName)
                  throws JobPersistenceException

Pause the Trigger with the given name.

Specified by:

pauseTrigger in interface JobStore

Throws:

JobPersistenceException

See Also:

resumeTrigger(SchedulingContext, String, String)

pauseTrigger

public void pauseTrigger(java.sql.Connection conn,
                SchedulingContext ctxt,
                java.lang.String triggerName,
                java.lang.String groupName)
                  throws JobPersistenceException

Pause the Trigger with the given name.

Throws:

JobPersistenceException

See Also:

resumeTrigger(Connection, SchedulingContext, String, String)

pauseJob

public void pauseJob(SchedulingContext ctxt,
            java.lang.String jobName,
            java.lang.String groupName)
              throws JobPersistenceException

Pause the Job with the given name - by pausing all of its current Triggers.

Specified by:

pauseJob in interface JobStore

Throws:

JobPersistenceException

See Also:

resumeJob(SchedulingContext, String, String)

pauseJobGroup

public void pauseJobGroup(SchedulingContext ctxt,
                 java.lang.String groupName)
                   throws JobPersistenceException

Pause all of the Jobs in the given group - by pausing all of their Triggers.

Specified by:

pauseJobGroup in interface JobStore

Throws:

JobPersistenceException

See Also:

resumeJobGroup(SchedulingContext, String)

resumeTrigger

public void resumeTrigger(SchedulingContext ctxt,
                 java.lang.String triggerName,
                 java.lang.String groupName)
                   throws JobPersistenceException

Resume (un-pause) the Trigger with the given name.

If the Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeTrigger in interface JobStore

Throws:

JobPersistenceException

See Also:

pauseTrigger(SchedulingContext, String, String)

resumeTrigger

public void resumeTrigger(java.sql.Connection conn,
                 SchedulingContext ctxt,
                 java.lang.String triggerName,
                 java.lang.String groupName)
                   throws JobPersistenceException

Resume (un-pause) the Trigger with the given name.

If the Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Throws:

JobPersistenceException

See Also:

pauseTrigger(Connection, SchedulingContext, String, String)

resumeJob

public void resumeJob(SchedulingContext ctxt,
             java.lang.String jobName,
             java.lang.String groupName)
               throws JobPersistenceException

Resume (un-pause) the Job with the given name.

If any of the Job'sTrigger s missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeJob in interface JobStore

Throws:

JobPersistenceException

See Also:

pauseJob(SchedulingContext, String, String)

resumeJobGroup

public void resumeJobGroup(SchedulingContext ctxt,
                  java.lang.String groupName)
                    throws JobPersistenceException

Resume (un-pause) all of the Jobs in the given group.

If any of the Job s had Trigger s that missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeJobGroup in interface JobStore

Throws:

JobPersistenceException

See Also:

pauseJobGroup(SchedulingContext, String)

pauseTriggerGroup

public void pauseTriggerGroup(SchedulingContext ctxt,
                     java.lang.String groupName)
                       throws JobPersistenceException

Pause all of the Triggers in the given group.

Specified by:

pauseTriggerGroup in interface JobStore

Throws:

JobPersistenceException

See Also:

resumeTriggerGroup(SchedulingContext, String)

pauseTriggerGroup

public void pauseTriggerGroup(java.sql.Connection conn,
                     SchedulingContext ctxt,
                     java.lang.String groupName)
                       throws JobPersistenceException

Pause all of the Triggers in the given group.

Throws:

JobPersistenceException

See Also:

resumeTriggerGroup(Connection, SchedulingContext, String)

getPausedTriggerGroups

public java.util.Set getPausedTriggerGroups(SchedulingContext ctxt)
                                     throws JobPersistenceException

Specified by:

getPausedTriggerGroups in interface JobStore

Throws:

JobPersistenceException

getPausedTriggerGroups

public java.util.Set getPausedTriggerGroups(java.sql.Connection conn,
                                   SchedulingContext ctxt)
                                     throws JobPersistenceException

Pause all of the Triggers in the given group.

Throws:

JobPersistenceException

See Also:

resumeTriggerGroup(Connection, SchedulingContext, String)

resumeTriggerGroup

public void resumeTriggerGroup(SchedulingContext ctxt,
                      java.lang.String groupName)
                        throws JobPersistenceException

Resume (un-pause) all of the Triggers in the given group.

If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeTriggerGroup in interface JobStore

Throws:

JobPersistenceException

See Also:

pauseTriggerGroup(SchedulingContext, String)

resumeTriggerGroup

public void resumeTriggerGroup(java.sql.Connection conn,
                      SchedulingContext ctxt,
                      java.lang.String groupName)
                        throws JobPersistenceException

Resume (un-pause) all of the Triggers in the given group.

If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Throws:

JobPersistenceException

See Also:

pauseTriggerGroup(Connection, SchedulingContext, String)

pauseAll

public void pauseAll(SchedulingContext ctxt)
              throws JobPersistenceException

Pause all triggers - equivalent of calling pauseTriggerGroup(group) on every group.

When resumeAll() is called (to un-pause), trigger misfire instructions WILL be applied.

Specified by:

pauseAll in interface JobStore

Throws:

JobPersistenceException

See Also:

resumeAll(SchedulingContext), pauseTriggerGroup(SchedulingContext, String)

pauseAll

public void pauseAll(java.sql.Connection conn,
            SchedulingContext ctxt)
              throws JobPersistenceException

Pause all triggers - equivalent of calling pauseTriggerGroup(group) on every group.

When resumeAll() is called (to un-pause), trigger misfire instructions WILL be applied.

Throws:

JobPersistenceException

See Also:

resumeAll(SchedulingContext), pauseTriggerGroup(SchedulingContext, String)

resumeAll

public void resumeAll(SchedulingContext ctxt)
               throws JobPersistenceException

Resume (un-pause) all triggers - equivalent of calling resumeTriggerGroup(group) on every group.

If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Specified by:

resumeAll in interface JobStore

Throws:

JobPersistenceException

See Also:

pauseAll(SchedulingContext)

resumeAll

public void resumeAll(java.sql.Connection conn,
             SchedulingContext ctxt)
               throws JobPersistenceException

protected

Resume (un-pause) all triggers - equivalent of calling resumeTriggerGroup(group) on every group.

If any Trigger missed one or more fire-times, then the Trigger's misfire instruction will be applied.

Throws:

JobPersistenceException

See Also:

pauseAll(SchedulingContext)

acquireNextTrigger

public Trigger acquireNextTrigger(SchedulingContext ctxt,
                         long noLaterThan)
                           throws JobPersistenceException

Get a handle to the next N triggers to be fired, and mark them as 'reserved' by the calling scheduler.

Specified by:

acquireNextTrigger in interface JobStore

noLaterThan - If > 0, the JobStore should only return a Trigger that will fire no later than the time represented in this value as milliseconds.

Throws:

JobPersistenceException

See Also:

releaseAcquiredTrigger(SchedulingContext, Trigger)

releaseAcquiredTrigger

public void releaseAcquiredTrigger(SchedulingContext ctxt,
                          Trigger trigger)
                            throws JobPersistenceException

Inform the JobStore that the scheduler no longer plans to fire the given Trigger, that it had previously acquired (reserved).

Specified by:

releaseAcquiredTrigger in interface JobStore

Throws:

JobPersistenceException

triggerFired

public TriggerFiredBundle triggerFired(SchedulingContext ctxt,
                              Trigger trigger)
                                throws JobPersistenceException

Inform the JobStore that the scheduler is now firing the given Trigger (executing its associated Job), that it had previously acquired (reserved).

Specified by:

triggerFired in interface JobStore

Returns:

null if the trigger or its job or calendar no longer exist, or if the trigger was not successfully put into the 'executing' state.

Throws:

JobPersistenceException

triggeredJobComplete

public void triggeredJobComplete(SchedulingContext ctxt,
                        Trigger trigger,
                        JobDetail jobDetail,
                        int triggerInstCode)
                          throws JobPersistenceException

Inform the JobStore that the scheduler has completed the firing of the given Trigger (and the execution its associated Job), and that the JobDataMap in the given JobDetail should be updated if the Job is stateful.

Specified by:

triggeredJobComplete in interface JobStore

Throws:

JobPersistenceException

setLockHandler

public void setLockHandler(Semaphore lockHandler)

executeWithoutLock

public java.lang.Object executeWithoutLock(org.quartz.impl.jdbcjobstore.JobStoreSupport.TransactionCallback txCallback)
                                    throws JobPersistenceException

Execute the given callback in a transaction. Depending on the JobStore, the surrounding transaction may be assumed to be already present (managed).

This method just forwards to executeInLock() with a null lockName.

Throws:

JobPersistenceException

See Also:

executeInLock(String, TransactionCallback)