StdSchedulerFactory Class

Quartz.NET 3.0 API Documentation
An implementation of ISchedulerFactory that does all of it's work of creating a QuartzScheduler instance based on the contents of a properties file.
Inheritance Hierarchy

SystemObject
  Quartz.ImplStdSchedulerFactory

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

C#
public class StdSchedulerFactory : ISchedulerFactory

The StdSchedulerFactory type exposes the following members.

Constructors

  NameDescription
Public methodStdSchedulerFactory
Initializes a new instance of the StdSchedulerFactory class.
Public methodStdSchedulerFactory(NameValueCollection)
Initializes a new instance of the StdSchedulerFactory class.
Top
Methods

  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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.)
Public methodGetAllSchedulers

Returns a handle to all known Schedulers (made by any StdSchedulerFactory instance.).

Public methodStatic memberGetDefaultScheduler
Returns a handle to the default Scheduler, creating it if it does not yet exist.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetScheduler(CancellationToken)
Returns a handle to the Scheduler produced by this factory.
Public methodGetScheduler(String, CancellationToken)

Returns a handle to the Scheduler with the given name, if it exists (if it has already been instantiated).

Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initialize the ISchedulerFactory.
Public methodInitialize(NameValueCollection)
Initialize the ISchedulerFactory with the contents of the given key value collection object.
Protected methodInstantiate
Protected methodLoadType
Needed while loadhelper is not constructed.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodValidateConfiguration
Top
Fields

  NameDescription
Public fieldStatic memberAutoGenerateInstanceId
Public fieldStatic memberConfigurationSectionName
Public fieldStatic memberDefaultInstanceId
Public fieldStatic memberPropertiesFile
Public fieldStatic memberPropertyCheckConfiguration
Public fieldStatic memberPropertyDataSourceConnectionString
Public fieldStatic memberPropertyDataSourceConnectionStringName
Public fieldStatic memberPropertyDataSourcePrefix
Public fieldStatic memberPropertyDataSourceProvider
Public fieldStatic memberPropertyDbProvider
Public fieldStatic memberPropertyDbProviderType
Public fieldStatic memberPropertyJobListenerPrefix
Public fieldStatic memberPropertyJobStoreLockHandlerPrefix
Public fieldStatic memberPropertyJobStoreLockHandlerType
Public fieldStatic memberPropertyJobStorePrefix
Public fieldStatic memberPropertyJobStoreType
Public fieldStatic memberPropertyListenerType
Public fieldStatic memberPropertyObjectSerializer
Public fieldStatic memberPropertyPluginPrefix
Public fieldStatic memberPropertyPluginType
Public fieldStatic memberPropertySchedulerBatchTimeWindow
Public fieldStatic memberPropertySchedulerContextPrefix
Public fieldStatic memberPropertySchedulerDbFailureRetryInterval
Public fieldStatic memberPropertySchedulerExporterPrefix
Public fieldStatic memberPropertySchedulerExporterType
Public fieldStatic memberPropertySchedulerIdleWaitTime
Public fieldStatic memberPropertySchedulerInstanceId
Public fieldStatic memberPropertySchedulerInstanceIdGeneratorPrefix
Public fieldStatic memberPropertySchedulerInstanceIdGeneratorType
Public fieldStatic memberPropertySchedulerInstanceName
Public fieldStatic memberPropertySchedulerInterruptJobsOnShutdown
Public fieldStatic memberPropertySchedulerInterruptJobsOnShutdownWithWait
Public fieldStatic memberPropertySchedulerJobFactoryPrefix
Public fieldStatic memberPropertySchedulerJobFactoryType
Public fieldStatic memberPropertySchedulerMakeSchedulerThreadDaemon
Public fieldStatic memberPropertySchedulerMaxBatchSize
Public fieldStatic memberPropertySchedulerName
Public fieldStatic memberPropertySchedulerProxy
Public fieldStatic memberPropertySchedulerProxyType
Public fieldStatic memberPropertySchedulerThreadName
Public fieldStatic memberPropertySchedulerTypeLoadHelperType
Public fieldStatic memberPropertyTablePrefix
Public fieldStatic memberPropertyThreadExecutor
Public fieldStatic memberPropertyThreadExecutorType
Public fieldStatic memberPropertyThreadPoolPrefix
Public fieldStatic memberPropertyThreadPoolType
Public fieldStatic memberPropertyTriggerListenerPrefix
Public fieldStatic memberSystemPropertyAsInstanceId
Top
Remarks

By default a properties are loaded from App.config's quartz section. If that fails, then the file is loaded "quartz.config". If file does not exist, default configuration located (as a embedded resource) in Quartz.dll is loaded. If you wish to use a file other than these defaults, you must define the system property 'quartz.properties' to point to the file you want.

See the sample properties that are distributed with Quartz for information about the various settings available within the file.

Alternatively, you can explicitly Initialize the factory by calling one of the Initialize methods before calling GetScheduler(CancellationToken).

Instances of the specified IJobStore, IThreadPool, classes will be created by name, and then any additional properties specified for them in the config file will be set on the instance by calling an equivalent 'set' method. For example if the properties file contains the property 'quartz.jobStore. myProp = 10' then after the JobStore class has been instantiated, the property 'MyProp' will be set with the value. Type conversion to primitive CLR types (int, long, float, double, boolean, enum and string) are performed before calling the property's setter method.

See Also

Reference