C# Class Quartz.Plugin.Xml.XMLSchedulingDataProcessorPlugin

This plugin loads XML file(s) to add jobs and schedule them with triggers as the scheduler is initialized, and can optionally periodically scan the file for changes.

The periodically scanning of files for changes is not currently supported in a clustered environment.

Inheritance: ISchedulerPlugin, IFileScanListener

Show file Open project: quartznet/quartznet Class Usage Examples

Private Properties

Property	Type	Description
BuildJobTriggerName	string
ProcessFile	System.Threading.Tasks.Task

Public Methods

Method	Description
FileUpdated ( string fName ) : System.Threading.Tasks.Task
Initialize ( string pluginName, IScheduler scheduler ) : System.Threading.Tasks.Task	Called during creation of the IScheduler in order to give the ISchedulerPlugin a chance to initialize.
ProcessFile ( string filePath ) : System.Threading.Tasks.Task
Shutdown ( ) : System.Threading.Tasks.Task	Called in order to inform the ISchedulerPlugin that it should free up all of it's resources because the scheduler is shutting down.
Start ( ) : System.Threading.Tasks.Task	Called when the associated IScheduler is started, in order to let the plug-in know it can now make calls into the scheduler if it needs to.
XMLSchedulingDataProcessorPlugin ( ) : System	Initializes a new instance of the XMLSchedulingDataProcessorPlugin class.

Private Methods

Method	Description
BuildJobTriggerName ( string fileBasename ) : string	Helper method for generating unique job/trigger name for the file scanning jobs (one per FileJob). The unique names are saved in jobTriggerNameSet.
ProcessFile ( JobFile jobFile ) : System.Threading.Tasks.Task

Method Details

FileUpdated() public method

public FileUpdated ( string fName ) : System.Threading.Tasks.Task
fName	string
return	System.Threading.Tasks.Task

Initialize() public method

Called during creation of the IScheduler in order to give the ISchedulerPlugin a chance to initialize.

public Initialize ( string pluginName, IScheduler scheduler ) : System.Threading.Tasks.Task
pluginName	string	The name.
scheduler	IScheduler	The scheduler.
return	System.Threading.Tasks.Task

ProcessFile() public method

public ProcessFile ( string filePath ) : System.Threading.Tasks.Task
filePath	string
return	System.Threading.Tasks.Task

Shutdown() public method

Called in order to inform the ISchedulerPlugin that it should free up all of it's resources because the scheduler is shutting down.

public Shutdown ( ) : System.Threading.Tasks.Task
return	System.Threading.Tasks.Task

Start() public method

Called when the associated IScheduler is started, in order to let the plug-in know it can now make calls into the scheduler if it needs to.

public Start ( ) : System.Threading.Tasks.Task
return	System.Threading.Tasks.Task

XMLSchedulingDataProcessorPlugin() public method

Initializes a new instance of the XMLSchedulingDataProcessorPlugin class.

public XMLSchedulingDataProcessorPlugin ( ) : System
return	System