StdSchedulerFactory (ph-mini-quartz 4.2.0 API)

java.lang.Object
- com.helger.quartz.impl.StdSchedulerFactory

All Implemented Interfaces:

ISchedulerFactory
```
public class StdSchedulerFactory
extends Object
implements ISchedulerFactory
```
An implementation of ISchedulerFactory that does all of its work of creating a QuartzScheduler instance based on the contents of a Properties file.

By default a properties file named "quartz.properties" is loaded from the 'current working directory'. If that fails, then the "quartz.properties" file located (as a resource) in the "quartz" package is loaded. If you wish to use a file other than these defaults, you must define the system property 'org.quartz.properties' to point to the file you want.

Alternatively, you can explicitly initialize the factory by calling one of the initialize(xx) methods before calling getScheduler().

See the sample properties files that are distributed with Quartz for information about the various settings available within the file. Full configuration documentation can be found at http://www.quartz-scheduler.org/docs/index.html

Instances of the specified IJobStore, IThreadPool, and other SPI 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 'org.quartz.jobStore.myProp = 10' then after the JobStore class has been instantiated, the method 'setMyProp()' will be called on it. Type conversion to primitive Java types (int, long, float, double, boolean, and String) are performed before calling the property's setter method.

One property can reference another property's value by specifying a value following the convention of "$@other.property.name", for example, to reference the scheduler's instance name as the value for some other property, you would use "$@org.quartz.scheduler.instanceName".

Author:

James House, Anthony Eden, Mohammad Rezaei

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AUTO_GENERATE_INSTANCE_ID`
`static String`	`DEFAULT_FILENAME`
`static String`	`DEFAULT_INSTANCE_ID`
`static String`	`PROP_JOB_LISTENER_PREFIX`
`static String`	`PROP_JOB_STORE_CLASS`
`static String`	`PROP_JOB_STORE_LOCK_HANDLER_CLASS`
`static String`	`PROP_JOB_STORE_LOCK_HANDLER_PREFIX`
`static String`	`PROP_JOB_STORE_PREFIX`
`static String`	`PROP_JOB_STORE_USE_PROP`
`static String`	`PROP_LISTENER_CLASS`
`static String`	`PROP_PLUGIN_CLASS`
`static String`	`PROP_PLUGIN_PREFIX`
`static String`	`PROP_PROPERTIES_FILE`
`static String`	`PROP_SCHED_BATCH_TIME_WINDOW`
`static String`	`PROP_SCHED_CLASS_LOAD_HELPER_CLASS`
`static String`	`PROP_SCHED_CONTEXT_PREFIX`
`static String`	`PROP_SCHED_IDLE_WAIT_TIME`
`static String`	`PROP_SCHED_INSTANCE_ID`
`static String`	`PROP_SCHED_INSTANCE_ID_GENERATOR_CLASS`
`static String`	`PROP_SCHED_INSTANCE_ID_GENERATOR_PREFIX`
`static String`	`PROP_SCHED_INSTANCE_NAME`
`static String`	`PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN`
`static String`	`PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN_WITH_WAIT`
`static String`	`PROP_SCHED_JOB_FACTORY_CLASS`
`static String`	`PROP_SCHED_JOB_FACTORY_PREFIX`
`static String`	`PROP_SCHED_MAKE_SCHEDULER_THREAD_DAEMON`
`static String`	`PROP_SCHED_MAX_BATCH_SIZE`
`static String`	`PROP_SCHED_SCHEDULER_THREADS_INHERIT_CONTEXT_CLASS_LOADER_OF_INITIALIZING_THREAD`
`static String`	`PROP_SCHED_THREAD_NAME`
`static String`	`PROP_THREAD_EXECUTOR`
`static String`	`PROP_THREAD_EXECUTOR_CLASS`
`static String`	`PROP_THREAD_POOL_CLASS`
`static String`	`PROP_THREAD_POOL_PREFIX`
`static String`	`PROP_TRIGGER_LISTENER_PREFIX`
`static String`	`SYSTEM_PROPERTY_AS_INSTANCE_ID`

Constructor Summary

Constructors
Constructor and Description

StdSchedulerFactory()
Create an uninitialized StdSchedulerFactory.

Constructors
Constructor and Description
`StdSchedulerFactory()` Create an uninitialized StdSchedulerFactory.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.helger.commons.collection.impl.ICommonsCollection<IScheduler>`	`getAllSchedulers()` Returns a handle to all known Schedulers (made by any StdSchedulerFactory instance.).
`static IScheduler`	`getDefaultScheduler()` Returns a handle to the default Scheduler, creating it if it does not yet exist.
`IScheduler`	`getScheduler()` Returns a handle to the Scheduler produced by this factory.
`IScheduler`	`getScheduler(String schedName)` Returns a handle to the Scheduler with the given name, if it exists (if it has already been instantiated).
`StdSchedulerFactory`	`initialize()` Initialize the `ISchedulerFactory` with the contents of a `NonBlockingProperties` file and overriding System properties.
`StdSchedulerFactory`	`initialize(InputStream propertiesStream)` Initialize the `ISchedulerFactory` with the contents of the `Properties` file opened with the given `InputStream`.
`StdSchedulerFactory`	`initialize(com.helger.commons.lang.NonBlockingProperties props)` Initialize the `ISchedulerFactory` with the contents of the given `Properties` object.
`StdSchedulerFactory`	`initialize(String filename)` Initialize the `ISchedulerFactory` with the contents of the `Properties` file with the given name.
`protected IScheduler`	`instantiate(QuartzSchedulerResources rsrcs, QuartzScheduler qs)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_PROPERTIES_FILE
```
public static final String PROP_PROPERTIES_FILE
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_INSTANCE_NAME
```
public static final String PROP_SCHED_INSTANCE_NAME
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_INSTANCE_ID
```
public static final String PROP_SCHED_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_INSTANCE_ID_GENERATOR_PREFIX
```
public static final String PROP_SCHED_INSTANCE_ID_GENERATOR_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_INSTANCE_ID_GENERATOR_CLASS
```
public static final String PROP_SCHED_INSTANCE_ID_GENERATOR_CLASS
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_THREAD_NAME
```
public static final String PROP_SCHED_THREAD_NAME
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_BATCH_TIME_WINDOW
```
public static final String PROP_SCHED_BATCH_TIME_WINDOW
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_MAX_BATCH_SIZE
```
public static final String PROP_SCHED_MAX_BATCH_SIZE
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_IDLE_WAIT_TIME
```
public static final String PROP_SCHED_IDLE_WAIT_TIME
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_MAKE_SCHEDULER_THREAD_DAEMON
```
public static final String PROP_SCHED_MAKE_SCHEDULER_THREAD_DAEMON
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_SCHEDULER_THREADS_INHERIT_CONTEXT_CLASS_LOADER_OF_INITIALIZING_THREAD
```
public static final String PROP_SCHED_SCHEDULER_THREADS_INHERIT_CONTEXT_CLASS_LOADER_OF_INITIALIZING_THREAD
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_CLASS_LOAD_HELPER_CLASS
```
public static final String PROP_SCHED_CLASS_LOAD_HELPER_CLASS
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_JOB_FACTORY_CLASS
```
public static final String PROP_SCHED_JOB_FACTORY_CLASS
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_JOB_FACTORY_PREFIX
```
public static final String PROP_SCHED_JOB_FACTORY_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN
```
public static final String PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN_WITH_WAIT
```
public static final String PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN_WITH_WAIT
```
    See Also:
    
    Constant Field Values
  - PROP_SCHED_CONTEXT_PREFIX
```
public static final String PROP_SCHED_CONTEXT_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_THREAD_POOL_PREFIX
```
public static final String PROP_THREAD_POOL_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_THREAD_POOL_CLASS
```
public static final String PROP_THREAD_POOL_CLASS
```
    See Also:
    
    Constant Field Values
  - PROP_JOB_STORE_PREFIX
```
public static final String PROP_JOB_STORE_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_JOB_STORE_LOCK_HANDLER_PREFIX
```
public static final String PROP_JOB_STORE_LOCK_HANDLER_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_JOB_STORE_LOCK_HANDLER_CLASS
```
public static final String PROP_JOB_STORE_LOCK_HANDLER_CLASS
```
    See Also:
    
    Constant Field Values
  - PROP_JOB_STORE_CLASS
```
public static final String PROP_JOB_STORE_CLASS
```
    See Also:
    
    Constant Field Values
  - PROP_JOB_STORE_USE_PROP
```
public static final String PROP_JOB_STORE_USE_PROP
```
    See Also:
    
    Constant Field Values
  - PROP_PLUGIN_PREFIX
```
public static final String PROP_PLUGIN_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_PLUGIN_CLASS
```
public static final String PROP_PLUGIN_CLASS
```
    See Also:
    
    Constant Field Values
  - PROP_JOB_LISTENER_PREFIX
```
public static final String PROP_JOB_LISTENER_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_TRIGGER_LISTENER_PREFIX
```
public static final String PROP_TRIGGER_LISTENER_PREFIX
```
    See Also:
    
    Constant Field Values
  - PROP_LISTENER_CLASS
```
public static final String PROP_LISTENER_CLASS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_INSTANCE_ID
```
public static final String DEFAULT_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - AUTO_GENERATE_INSTANCE_ID
```
public static final String AUTO_GENERATE_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - PROP_THREAD_EXECUTOR
```
public static final String PROP_THREAD_EXECUTOR
```
    See Also:
    
    Constant Field Values
  - PROP_THREAD_EXECUTOR_CLASS
```
public static final String PROP_THREAD_EXECUTOR_CLASS
```
    See Also:
    
    Constant Field Values
  - SYSTEM_PROPERTY_AS_INSTANCE_ID
```
public static final String SYSTEM_PROPERTY_AS_INSTANCE_ID
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FILENAME
```
public static final String DEFAULT_FILENAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StdSchedulerFactory
```
public StdSchedulerFactory()
```
    Create an uninitialized StdSchedulerFactory.
- Method Detail
  - initialize
```
@Nonnull
public StdSchedulerFactory initialize()
                                         throws SchedulerException
```
    Initialize the ISchedulerFactory with the contents of a NonBlockingProperties file and overriding System properties.
    
    By default a properties file named "quartz.properties" is loaded from the 'current working directory'. If that fails, then the "quartz.properties" file located (as a resource) in the "quartz" package is loaded. If you wish to use a file other than these defaults, you must define the system property 'org.quartz.properties' to point to the file you want.
    
    System properties (environment variables, and -D definitions on the command-line when running the JVM) override any properties in the loaded file. For this reason, you may want to use a different initialize() method if your application security policy prohibits access to System.getProperties().
    
    Returns:
    
    this
    
    Throws:
    
    SchedulerException
  - initialize
```
@Nonnull
public StdSchedulerFactory initialize(String filename)
                                         throws SchedulerException
```
    Initialize the ISchedulerFactory with the contents of the Properties file with the given name.
    
    Returns:
    
    this
    
    Throws:
    
    SchedulerException
  - initialize
```
@Nonnull
public StdSchedulerFactory initialize(@Nonnull @WillNotClose
                                                InputStream propertiesStream)
                                         throws SchedulerException
```
    Initialize the ISchedulerFactory with the contents of the Properties file opened with the given InputStream.
    
    Returns:
    
    this
    
    Throws:
    
    SchedulerException
  - initialize
```
@Nonnull
public StdSchedulerFactory initialize(com.helger.commons.lang.NonBlockingProperties props)
                                         throws SchedulerException
```
    Initialize the ISchedulerFactory with the contents of the given Properties object.
    
    Returns:
    
    this
    
    Throws:
    
    SchedulerException - on error
  - instantiate
```
@Nonnull
protected IScheduler instantiate(QuartzSchedulerResources rsrcs,
                                           QuartzScheduler qs)
```
    Parameters:
    
    rsrcs -
    
    qs -
    
    Returns:
    
    Never null
  - getScheduler
```
public IScheduler getScheduler()
                        throws SchedulerException
```
    Returns a handle to the Scheduler produced by this factory.
    
    If one of the initialize methods has not be previously called, then the default (no-arg) initialize() method will be called by this method.
    
    Specified by:
    
    getScheduler in interface ISchedulerFactory
    
    Throws:
    
    SchedulerException - if there is a problem with the underlying Scheduler.
  - getDefaultScheduler
```
public static IScheduler getDefaultScheduler()
                                      throws SchedulerException
```
    Returns a handle to the default Scheduler, creating it if it does not yet exist.
    
    Throws:
    
    SchedulerException
    
    See Also:
    
    initialize()
  - getScheduler
```
public IScheduler getScheduler(String schedName)
                        throws SchedulerException
```
    Returns a handle to the Scheduler with the given name, if it exists (if it has already been instantiated).
    
    Specified by:
    
    getScheduler in interface ISchedulerFactory
    
    Throws:
    
    SchedulerException
  - getAllSchedulers
```
public com.helger.commons.collection.impl.ICommonsCollection<IScheduler> getAllSchedulers()
                                                                                   throws SchedulerException
```
    Returns a handle to all known Schedulers (made by any StdSchedulerFactory instance.).
    
    Specified by:
    
    getAllSchedulers in interface ISchedulerFactory
    
    Throws:
    
    SchedulerException

Class StdSchedulerFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_PROPERTIES_FILE

PROP_SCHED_INSTANCE_NAME

PROP_SCHED_INSTANCE_ID

PROP_SCHED_INSTANCE_ID_GENERATOR_PREFIX

PROP_SCHED_INSTANCE_ID_GENERATOR_CLASS

PROP_SCHED_THREAD_NAME

PROP_SCHED_BATCH_TIME_WINDOW

PROP_SCHED_MAX_BATCH_SIZE

PROP_SCHED_IDLE_WAIT_TIME

PROP_SCHED_MAKE_SCHEDULER_THREAD_DAEMON

PROP_SCHED_SCHEDULER_THREADS_INHERIT_CONTEXT_CLASS_LOADER_OF_INITIALIZING_THREAD

PROP_SCHED_CLASS_LOAD_HELPER_CLASS

PROP_SCHED_JOB_FACTORY_CLASS

PROP_SCHED_JOB_FACTORY_PREFIX

PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN

PROP_SCHED_INTERRUPT_JOBS_ON_SHUTDOWN_WITH_WAIT

PROP_SCHED_CONTEXT_PREFIX

PROP_THREAD_POOL_PREFIX

PROP_THREAD_POOL_CLASS

PROP_JOB_STORE_PREFIX

PROP_JOB_STORE_LOCK_HANDLER_PREFIX

PROP_JOB_STORE_LOCK_HANDLER_CLASS

PROP_JOB_STORE_CLASS

PROP_JOB_STORE_USE_PROP

PROP_PLUGIN_PREFIX

PROP_PLUGIN_CLASS

PROP_JOB_LISTENER_PREFIX

PROP_TRIGGER_LISTENER_PREFIX

PROP_LISTENER_CLASS

DEFAULT_INSTANCE_ID

AUTO_GENERATE_INSTANCE_ID

PROP_THREAD_EXECUTOR

PROP_THREAD_EXECUTOR_CLASS

SYSTEM_PROPERTY_AS_INSTANCE_ID

DEFAULT_FILENAME

Constructor Detail

StdSchedulerFactory

Method Detail

initialize

initialize

initialize

initialize

instantiate

getScheduler

getDefaultScheduler

getScheduler

getAllSchedulers