JobStoreTX Class

Quartz.NET 3.0 API Documentation
JobStoreTX is meant to be used in a standalone environment. Both commit and rollback will be handled by this class.
Inheritance Hierarchy

SystemObject
  Quartz.Impl.AdoJobStoreAdoConstants
    Quartz.Impl.AdoJobStoreJobStoreSupport
      Quartz.Impl.AdoJobStoreJobStoreTX

Namespace:  Quartz.Impl.AdoJobStore
Assembly:  Quartz (in Quartz.dll) Version: 3.0.0
Syntax

C#
public class JobStoreTX : JobStoreSupport

The JobStoreTX type exposes the following members.

Constructors

  NameDescription
Public methodJobStoreTX
Initializes a new instance of the JobStoreTX class
Top
Properties

  NameDescription
Public propertyAcquireTriggersWithinLock
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 is considered unnecessary for most databases (due to the nature of the SQL update that is performed), and therefore a superfluous performance hit.
(Inherited from JobStoreSupport.)
Public propertyCanUseProperties
Get whether String-only properties will be handled in JobDataMaps.
(Inherited from JobStoreSupport.)
Public propertyClusterCheckinInterval
Get or set the frequency at which this instance "checks-in" with the other instances of the cluster. -- Affects the rate of detecting failed instances.
(Inherited from JobStoreSupport.)
Public propertyClustered
Get or set whether this instance is part of a cluster.
(Inherited from JobStoreSupport.)
Public propertyConnectionManager
Get or set the database connection manager.
(Inherited from JobStoreSupport.)
Public propertyDataSource
Get or set the datasource name.
(Inherited from JobStoreSupport.)
Protected propertyDbMetadata (Inherited from JobStoreSupport.)
Public propertyDbRetryInterval
Gets or sets the database retry interval.
(Inherited from JobStoreSupport.)
Protected propertyDelegate
Get the driver delegate for DB operations.
(Inherited from JobStoreSupport.)
Public propertyDontSetAutoCommitFalse
Don't call set autocommit(false) on connections obtained from the DataSource. This can be helpful in a few situations, such as if you have a driver that complains if it is called when it is already off.
(Inherited from JobStoreSupport.)
Public propertyDoubleCheckLockMisfireHandler
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 misfired Triggers.
(Inherited from JobStoreSupport.)
Public propertyDriverDelegateInitString
The driver delegate's initialization string.
(Inherited from JobStoreSupport.)
Public propertyDriverDelegateType
Get or set the ADO.NET driver delegate class name.
(Inherited from JobStoreSupport.)
Public propertyEstimatedTimeToReleaseAndAcquireTrigger (Inherited from JobStoreSupport.)
Public propertyInstanceId
Get or set the instance Id of the Scheduler (must be unique within a cluster).
(Inherited from JobStoreSupport.)
Public propertyInstanceName
Get or set the instance Id of the Scheduler (must be unique within this server instance).
(Inherited from JobStoreSupport.)
Protected propertyLastCheckin (Inherited from JobStoreSupport.)
Protected propertyLockHandler (Inherited from JobStoreSupport.)
Public propertyLockOnInsert
Whether or not to obtain locks when inserting new jobs/triggers.
(Inherited from JobStoreSupport.)
Public propertyMakeThreadsDaemons
Get whether the threads spawned by this JobStore should be marked as daemon. Possible threads include the MisfireHandler and the ClusterManager.
(Inherited from JobStoreSupport.)
Public propertyMaxMisfiresToHandleAtATime
Get or 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.
(Inherited from JobStoreSupport.)
Public propertyMisfireHandlerFrequency
How often should the misfire handler check for misfires. Defaults to MisfireThreshold.
(Inherited from JobStoreSupport.)
Public propertyMisfireThreshold
The time span 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.
(Inherited from JobStoreSupport.)
Protected propertyMisfireTime (Inherited from JobStoreSupport.)
Public propertyObjectSerializer (Inherited from JobStoreSupport.)
Public propertyRetryableActionErrorLogThreshold
Gets or sets the number of retries before an error is logged for recovery operations.
(Inherited from JobStoreSupport.)
Public propertySelectWithLockSQL
set the SQL statement to use to select and lock a row in the "locks" table.
(Inherited from JobStoreSupport.)
Public propertySupportsPersistence
Indicates whether this job store supports persistence.
(Inherited from JobStoreSupport.)
Public propertyTablePrefix
Get or sets the prefix that should be pre-pended to all table names.
(Inherited from JobStoreSupport.)
Public propertyThreadPoolSize (Inherited from JobStoreSupport.)
Public propertyTxIsolationLevelSerializable
Set the transaction isolation level of DB connections to sequential.
(Inherited from JobStoreSupport.)
Protected propertyTypeLoadHelper (Inherited from JobStoreSupport.)
Public propertyUseDBLocks
Get or set whether this instance should use database-based thread synchronization.
(Inherited from JobStoreSupport.)
Public propertyUseProperties
Set whether string-only properties will be handled in JobDataMaps.
(Inherited from JobStoreSupport.)
Top
Methods

  NameDescription
Protected methodAcquireNextTrigger (Inherited from JobStoreSupport.)
Public methodAcquireNextTriggers
Get a handle to the next N triggers to be fired, and mark them as 'reserved' by the calling scheduler.
(Inherited from JobStoreSupport.)
Protected methodCalcFailedIfAfter (Inherited from JobStoreSupport.)
Public methodCalendarExists(String, CancellationToken)
Determine whether a ICalendar with the given identifier already exists within the scheduler.
(Inherited from JobStoreSupport.)
Protected methodCalendarExists(ConnectionAndTransactionHolder, String, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodCheckBlockedState
Determines if a Trigger for the given job should be blocked. State can only transition to StatePausedBlocked/StateBlocked from StatePaused/StateWaiting respectively.
(Inherited from JobStoreSupport.)
Public methodCheckExists(JobKey, CancellationToken)
Determine whether a IJob with the given identifier already exists within the scheduler.
(Inherited from JobStoreSupport.)
Public methodCheckExists(TriggerKey, CancellationToken)
Determine whether a ITrigger with the given identifier already exists within the scheduler.
(Inherited from JobStoreSupport.)
Protected methodCheckExists(ConnectionAndTransactionHolder, JobKey, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodCheckExists(ConnectionAndTransactionHolder, TriggerKey, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodCheckExists(ConnectionAndTransactionHolder, String, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodCleanupConnection
Cleanup the given database connection. This means restoring any modified auto commit or transaction isolation connection attributes, and then closing the underlying connection.
(Inherited from JobStoreSupport.)
Public methodClearAllSchedulingData(CancellationToken)
Clear (delete!) all scheduling data - all IJobs, ITriggers ICalendars.
(Inherited from JobStoreSupport.)
Protected methodClearAllSchedulingData(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodCloseConnection
Closes the supplied connection.
(Inherited from JobStoreSupport.)
Protected methodClusterCheckIn (Inherited from JobStoreSupport.)
Protected methodClusterRecover (Inherited from JobStoreSupport.)
Protected methodCommitConnection
Commit the supplied connection.
(Inherited from JobStoreSupport.)
Protected methodDoCheckin (Inherited from JobStoreSupport.)
Protected methodDoRecoverMisfires (Inherited from JobStoreSupport.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodExecuteInLock(String, FuncConnectionAndTransactionHolder, Task, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodExecuteInLockT(String, FuncConnectionAndTransactionHolder, TaskT, CancellationToken)
Execute the given callback having acquired the given lock. Depending on the JobStore, the surrounding transaction may be assumed to be already present (managed).
(Inherited from JobStoreSupport.)
Protected methodExecuteInLockT(String, FuncConnectionAndTransactionHolder, TaskT, CancellationToken)
Execute the given callback having optionally acquired the given lock. For JobStoreTX, because it manages its own transactions and only has the one datasource, this is the same behavior as ExecuteInNonManagedTXLock(String, FuncConnectionAndTransactionHolder, Task, CancellationToken).
(Overrides JobStoreSupportExecuteInLockT(String, FuncConnectionAndTransactionHolder, TaskT, CancellationToken).)
Protected methodExecuteInNonManagedTXLock(String, FuncConnectionAndTransactionHolder, Task, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodExecuteInNonManagedTXLockT(String, FuncConnectionAndTransactionHolder, TaskT, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodExecuteInNonManagedTXLockT(String, FuncConnectionAndTransactionHolder, TaskT, FuncConnectionAndTransactionHolder, T, TaskBoolean, CancellationToken)
Execute the given callback having optionally acquired the given lock. This uses the non-managed transaction connection.
(Inherited from JobStoreSupport.)
Protected methodExecuteWithoutLockT
Execute the given callback in a transaction. Depending on the JobStore, the surrounding transaction may be assumed to be already present (managed).
(Inherited from JobStoreSupport.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodFindFailedInstances
Get a list of all scheduler instances in the cluster that may have failed. This includes this scheduler if it is checking in for the first time.
(Inherited from JobStoreSupport.)
Public methodGetCalendarNames(CancellationToken)
Get the names of all of the ICalendar s in the IJobStore.
(Inherited from JobStoreSupport.)
Protected methodGetCalendarNames(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodGetConnection
Gets the connection and starts a new transaction.
(Inherited from JobStoreSupport.)
Protected methodGetFiredTriggerRecordId (Inherited from JobStoreSupport.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetJobGroupNames(CancellationToken)
Get the names of all of the IJob groups.
(Inherited from JobStoreSupport.)
Protected methodGetJobGroupNames(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Public methodGetJobKeys
Get the names of all of the IJob s that have the given group name.
(Inherited from JobStoreSupport.)
Protected methodGetJobNames (Inherited from JobStoreSupport.)
Protected methodGetNonManagedTXConnection
For JobStoreTX, the non-managed TX connection is just the normal connection because it is not CMT.
(Overrides JobStoreSupportGetNonManagedTXConnection.)
Public methodGetNumberOfCalendars(CancellationToken)
Get the number of ICalendar s that are stored in the IJobStore.
(Inherited from JobStoreSupport.)
Protected methodGetNumberOfCalendars(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Public methodGetNumberOfJobs(CancellationToken)
Get the number of IJob s that are stored in the IJobStore.
(Inherited from JobStoreSupport.)
Protected methodGetNumberOfJobs(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Public methodGetNumberOfTriggers(CancellationToken)
Get the number of ITrigger s that are stored in the IJobStore.
(Inherited from JobStoreSupport.)
Protected methodGetNumberOfTriggers(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Public methodGetPausedTriggerGroups(CancellationToken) (Inherited from JobStoreSupport.)
Public methodGetPausedTriggerGroups(ConnectionAndTransactionHolder, CancellationToken)
Pause all of the ITriggers in the given group.
(Inherited from JobStoreSupport.)
Public methodGetTriggerGroupNames(CancellationToken)
Get the names of all of the ITrigger groups.
(Inherited from JobStoreSupport.)
Protected methodGetTriggerGroupNames(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Public methodGetTriggerKeys
Get the names of all of the ITrigger s that have the given group name.
(Inherited from JobStoreSupport.)
Protected methodGetTriggerNames (Inherited from JobStoreSupport.)
Public methodGetTriggersForJob(JobKey, CancellationToken)
Get all of the Triggers that are associated to the given Job.
(Inherited from JobStoreSupport.)
Protected methodGetTriggersForJob(ConnectionAndTransactionHolder, JobKey, CancellationToken) (Inherited from JobStoreSupport.)
Public methodGetTriggerState(TriggerKey, CancellationToken)
Get the current state of the identified ITrigger.
(Inherited from JobStoreSupport.)
Protected methodGetTriggerState(ConnectionAndTransactionHolder, TriggerKey, CancellationToken)
Gets the state of the trigger.
(Inherited from JobStoreSupport.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Called by the QuartzScheduler before the IJobStore is used, in order to give the it a chance to Initialize.
(Overrides JobStoreSupportInitialize(ITypeLoadHelper, ISchedulerSignaler, CancellationToken).)
Public methodIsJobGroupPaused
Returns true if the given JobGroup is paused.
(Inherited from JobStoreSupport.)
Protected methodIsTransient (Inherited from JobStoreSupport.)
Public methodIsTriggerGroupPaused
Returns true if the given TriggerGroup is paused.
(Inherited from JobStoreSupport.)
Protected methodJobExists
Check existence of a given job.
(Inherited from JobStoreSupport.)
Protected methodLogWarnIfNonZero (Inherited from JobStoreSupport.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPauseAll(CancellationToken) (Inherited from JobStoreSupport.)
Public methodPauseAll(ConnectionAndTransactionHolder, CancellationToken) (Inherited from JobStoreSupport.)
Public methodPauseJob
Pause the IJob with the given name - by pausing all of its current ITriggers.
(Inherited from JobStoreSupport.)
Public methodPauseJobs
Pause all of the IJobs in the given group - by pausing all of their ITriggers.
(Inherited from JobStoreSupport.)
Public methodPauseTrigger(TriggerKey, CancellationToken)
Pause the ITrigger with the given name.
(Inherited from JobStoreSupport.)
Public methodPauseTrigger(ConnectionAndTransactionHolder, TriggerKey, CancellationToken)
Pause the ITrigger with the given name.
(Inherited from JobStoreSupport.)
Public methodPauseTriggerGroup
Pause all of the ITriggers in the given group.
(Inherited from JobStoreSupport.)
Public methodPauseTriggers
Pause all of the ITriggers in the given group.
(Inherited from JobStoreSupport.)
Protected methodRecoverJobs(CancellationToken)
Will recover any failed or misfired jobs and clean up the data store as appropriate.
(Inherited from JobStoreSupport.)
Protected methodRecoverJobs(ConnectionAndTransactionHolder, CancellationToken)
Will recover any failed or misfired jobs and clean up the data store as appropriate.
(Inherited from JobStoreSupport.)
Public methodRecoverMisfiredJobs (Inherited from JobStoreSupport.)
Public methodReleaseAcquiredTrigger(IOperableTrigger, CancellationToken)
Inform the IJobStore that the scheduler no longer plans to fire the given ITrigger, that it had previously acquired (reserved).
(Inherited from JobStoreSupport.)
Protected methodReleaseAcquiredTrigger(ConnectionAndTransactionHolder, IOperableTrigger, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodReleaseLock (Inherited from JobStoreSupport.)
Public methodRemoveCalendar(String, CancellationToken)
Remove (delete) the ICalendar with the given name.
(Inherited from JobStoreSupport.)
Protected methodRemoveCalendar(ConnectionAndTransactionHolder, String, CancellationToken) (Inherited from JobStoreSupport.)
Public methodRemoveJob(JobKey, CancellationToken)
Remove (delete) the IJob with the given name, and any ITrigger s that reference it.
(Inherited from JobStoreSupport.)
Protected methodRemoveJob(ConnectionAndTransactionHolder, JobKey, Boolean, CancellationToken) (Inherited from JobStoreSupport.)
Public methodRemoveJobs (Inherited from JobStoreSupport.)
Public methodRemoveTrigger(TriggerKey, CancellationToken)
Remove (delete) the ITrigger with the given name.
(Inherited from JobStoreSupport.)
Protected methodRemoveTrigger(ConnectionAndTransactionHolder, TriggerKey, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodRemoveTrigger(ConnectionAndTransactionHolder, TriggerKey, IJobDetail, CancellationToken) (Inherited from JobStoreSupport.)
Public methodRemoveTriggers (Inherited from JobStoreSupport.)
Public methodReplaceTrigger(TriggerKey, IOperableTrigger, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodReplaceTrigger(ConnectionAndTransactionHolder, TriggerKey, IOperableTrigger, CancellationToken) (Inherited from JobStoreSupport.)
Public methodResumeAll(CancellationToken) (Inherited from JobStoreSupport.)
Public methodResumeAll(ConnectionAndTransactionHolder, CancellationToken)
Resume (un-pause) all triggers - equivalent of calling ResumeTriggers(GroupMatcherTriggerKey, CancellationToken) on every group.

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

(Inherited from JobStoreSupport.)
Public methodResumeJob
Resume (un-pause) the IJob with the given name.
(Inherited from JobStoreSupport.)
Public methodResumeJobs
Resume (un-pause) all of the IJobs in the given group.
(Inherited from JobStoreSupport.)
Public methodResumeTrigger(TriggerKey, CancellationToken) (Inherited from JobStoreSupport.)
Public methodResumeTrigger(ConnectionAndTransactionHolder, TriggerKey, CancellationToken)
Resume (un-pause) the ITrigger with the given name.
(Inherited from JobStoreSupport.)
Public methodResumeTriggers(GroupMatcherTriggerKey, CancellationToken) (Inherited from JobStoreSupport.)
Public methodResumeTriggers(ConnectionAndTransactionHolder, GroupMatcherTriggerKey, CancellationToken)
Resume (un-pause) all of the ITriggers in the given group.

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

(Inherited from JobStoreSupport.)
Public methodRetrieveCalendar(String, CancellationToken)
Retrieve the given ITrigger.
(Inherited from JobStoreSupport.)
Protected methodRetrieveCalendar(ConnectionAndTransactionHolder, String, CancellationToken) (Inherited from JobStoreSupport.)
Public methodRetrieveJob(JobKey, CancellationToken)
Retrieve the IJobDetail for the given IJob.
(Inherited from JobStoreSupport.)
Protected methodRetrieveJob(ConnectionAndTransactionHolder, JobKey, CancellationToken) (Inherited from JobStoreSupport.)
Public methodRetrieveTrigger(TriggerKey, CancellationToken)
Retrieve the given ITrigger.
(Inherited from JobStoreSupport.)
Protected methodRetrieveTrigger(ConnectionAndTransactionHolder, TriggerKey, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodRetryExecuteInNonManagedTXLock(String, FuncConnectionAndTransactionHolder, Task, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodRetryExecuteInNonManagedTXLockT(String, FuncConnectionAndTransactionHolder, TaskT, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodRollbackConnection
Rollback the supplied connection.
(Inherited from JobStoreSupport.)
Public methodSchedulerPaused
Called by the QuartzScheduler to inform the JobStore that the scheduler has been paused.
(Inherited from JobStoreSupport.)
Public methodSchedulerResumed
Called by the QuartzScheduler to inform the JobStore that the scheduler has resumed after being paused.
(Inherited from JobStoreSupport.)
Public methodSchedulerStarted (Inherited from JobStoreSupport.)
Public methodShutdown
Called by the QuartzScheduler to inform the IJobStore that it should free up all of it's resources because the scheduler is shutting down.
(Inherited from JobStoreSupport.)
Protected methodSignalSchedulingChangeImmediately (Inherited from JobStoreSupport.)
Public methodStoreCalendar(String, ICalendar, Boolean, Boolean, CancellationToken)
Store the given ICalendar.
(Inherited from JobStoreSupport.)
Protected methodStoreCalendar(ConnectionAndTransactionHolder, String, ICalendar, Boolean, Boolean, CancellationToken) (Inherited from JobStoreSupport.)
Public methodStoreJob(IJobDetail, Boolean, CancellationToken)
Stores the given IJobDetail.
(Inherited from JobStoreSupport.)
Protected methodStoreJob(ConnectionAndTransactionHolder, IJobDetail, Boolean, CancellationToken)

Insert or update a job.

(Inherited from JobStoreSupport.)
Public methodStoreJobAndTrigger
Store the given IJobDetail and IOperableTrigger.
(Inherited from JobStoreSupport.)
Public methodStoreJobsAndTriggers (Inherited from JobStoreSupport.)
Public methodStoreTrigger(IOperableTrigger, Boolean, CancellationToken)
Store the given ITrigger.
(Inherited from JobStoreSupport.)
Protected methodStoreTrigger(ConnectionAndTransactionHolder, IOperableTrigger, IJobDetail, Boolean, String, Boolean, Boolean, CancellationToken)
Insert or update a trigger.
(Inherited from JobStoreSupport.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTriggeredJobComplete(IOperableTrigger, IJobDetail, SchedulerInstruction, CancellationToken)
Inform the IJobStore that the scheduler has completed the firing of the given ITrigger (and the execution its associated IJob), and that the JobDataMap in the given IJobDetail should be updated if the IJob is stateful.
(Inherited from JobStoreSupport.)
Protected methodTriggeredJobComplete(ConnectionAndTransactionHolder, IOperableTrigger, IJobDetail, SchedulerInstruction, CancellationToken) (Inherited from JobStoreSupport.)
Protected methodTriggerExists
Check existence of a given trigger.
(Inherited from JobStoreSupport.)
Protected methodTriggerFired (Inherited from JobStoreSupport.)
Public methodTriggersFired (Inherited from JobStoreSupport.)
Protected methodUpdateMisfiredTrigger (Inherited from JobStoreSupport.)
Top
Fields

  NameDescription
Protected fieldcalendarCache (Inherited from JobStoreSupport.)
Protected fielddelegateType (Inherited from JobStoreSupport.)
Protected fieldfirstCheckIn (Inherited from JobStoreSupport.)
Top
See Also

Reference