SchedulerFactoryBean (Spring Framework 3.2.1.RELEASE API)
Date: 2013-01-24

org.springframework.scheduling.quartz

## Class SchedulerFactoryBean

- java.lang.Object
- - org.springframework.scheduling.quartz.SchedulerAccessor
  - - org.springframework.scheduling.quartz.SchedulerFactoryBean

- All Implemented Interfaces:
    Aware, BeanNameAware, DisposableBean, FactoryBean<Scheduler>, InitializingBean, ApplicationContextAware, Lifecycle, Phased, ResourceLoaderAware, SmartLifecycle

      public class SchedulerFactoryBean
      extends SchedulerAccessor
      implements FactoryBean<Scheduler>, BeanNameAware, ApplicationContextAware, InitializingBean, DisposableBean, SmartLifecycle

  `FactoryBean` that creates and configures a Quartz `Scheduler`, manages its lifecycle as part of the Spring application context, and exposes the Scheduler as bean reference for dependency injection.

  Allows registration of JobDetails, Calendars and Triggers, automatically starting the scheduler on initialization and shutting it down on destruction. In scenarios that just require static registration of jobs at startup, there is no need to access the Scheduler instance itself in application code.

  For dynamic registration of jobs at runtime, use a bean reference to this SchedulerFactoryBean to get direct access to the Quartz Scheduler (`org.quartz.Scheduler`). This allows you to create new jobs and triggers, and also to control and monitor the entire Scheduler.

  Note that Quartz instantiates a new Job for each execution, in contrast to Timer which uses a TimerTask instance that is shared between repeated executions. Just JobDetail descriptors are shared.

  When using persistent jobs, it is strongly recommended to perform all operations on the Scheduler within Spring-managed (or plain JTA) transactions. Else, database locking will not properly work and might even break. (See `setDataSource` javadoc for details.)

  The preferred way to achieve transactional execution is to demarcate declarative transactions at the business facade level, which will automatically apply to Scheduler operations performed within those scopes. Alternatively, you may add transactional advice for the Scheduler itself.

  Compatible with Quartz 1.5+ as well as Quartz 2.0/2.1, as of Spring 3.1.

  Since:
    18.02.2004
  Author:
    Juergen Hoeller
  See Also:
    `setDataSource(javax.sql.DataSource)`, `Scheduler`, `SchedulerFactory`, `StdSchedulerFactory`, `TransactionProxyFactoryBean`

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `DEFAULT_THREAD_COUNT`
    `static String` | `PROP_THREAD_COUNT`

    - ### Fields inherited from class org.springframework.scheduling.quartz.SchedulerAccessor

      `logger, resourceLoader`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SchedulerFactoryBean()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `afterPropertiesSet()` Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
    `protected Scheduler` | `createScheduler(SchedulerFactory schedulerFactory, String schedulerName)` Create the Scheduler instance for the given factory and scheduler name.
    `void` | `destroy()` Shut down the Quartz scheduler on bean factory shutdown, stopping all scheduled jobs.
    `static DataSource` | `getConfigTimeDataSource()` Return the DataSource for the currently configured Quartz Scheduler, to be used by LocalDataSourceJobStore.
    `static DataSource` | `getConfigTimeNonTransactionalDataSource()` Return the non-transactional DataSource for the currently configured Quartz Scheduler, to be used by LocalDataSourceJobStore.
    `static ResourceLoader` | `getConfigTimeResourceLoader()` Return the ResourceLoader for the currently configured Quartz Scheduler, to be used by ResourceLoaderClassLoadHelper.
    `static Executor` | `getConfigTimeTaskExecutor()` Return the TaskExecutor for the currently configured Quartz Scheduler, to be used by LocalTaskExecutorThreadPool.
    `Scheduler` | `getObject()` Return an instance (possibly shared or independent) of the object managed by this factory.
    `Class<? extends Scheduler>` | `getObjectType()` Return the type of object that this FactoryBean creates, or `null` if not known in advance.
    `int` | `getPhase()` Return the phase in which this scheduler will be started and stopped.
    `Scheduler` | `getScheduler()` Template method that determines the Scheduler to operate on.
    `boolean` | `isAutoStartup()` Return whether this scheduler is configured for auto-startup.
    `boolean` | `isRunning()` Check whether this component is currently running.
    `boolean` | `isSingleton()` Is the object managed by this factory a singleton? That is, will `FactoryBean.getObject()` always return the same object (a reference that can be cached)?
    `void` | `setApplicationContext(ApplicationContext applicationContext)` Set the ApplicationContext that this object runs in.
    `void` | `setApplicationContextSchedulerContextKey(String applicationContextSchedulerContextKey)` Set the key of an ApplicationContext reference to expose in the SchedulerContext, for example "applicationContext".
    `void` | `setAutoStartup(boolean autoStartup)` Set whether to automatically start the scheduler after initialization.
    `void` | `setBeanName(String name)` Set the name of the bean in the bean factory that created this bean.
    `void` | `setConfigLocation(Resource configLocation)` Set the location of the Quartz properties config file, for example as classpath resource "classpath:quartz.properties".
    `void` | `setDataSource(DataSource dataSource)` Set the default DataSource to be used by the Scheduler.
    `void` | `setExposeSchedulerInRepository(boolean exposeSchedulerInRepository)` Set whether to expose the Spring-managed `Scheduler` instance in the Quartz `SchedulerRepository`.
    `void` | `setJobFactory(org.quartz.spi.JobFactory jobFactory)` Set the Quartz JobFactory to use for this Scheduler.
    `void` | `setNonTransactionalDataSource(DataSource nonTransactionalDataSource)` Set the DataSource to be used by the Scheduler for non-transactional access.
    `void` | `setPhase(int phase)` Specify the phase in which this scheduler should be started and stopped.
    `void` | `setQuartzProperties(Properties quartzProperties)` Set Quartz properties, like "org.quartz.threadPool.class".
    `void` | `setSchedulerContextAsMap(Map schedulerContextAsMap)` Register objects in the Scheduler context via a given Map.
    `void` | `setSchedulerFactoryClass(Class schedulerFactoryClass)` Set the Quartz SchedulerFactory implementation to use.
    `void` | `setSchedulerName(String schedulerName)` Set the name of the Scheduler to create via the SchedulerFactory.
    `void` | `setStartupDelay(int startupDelay)` Set the number of seconds to wait after initialization before starting the scheduler asynchronously.
    `void` | `setTaskExecutor(Executor taskExecutor)` Set the Spring TaskExecutor to use as Quartz backend.
    `void` | `setWaitForJobsToCompleteOnShutdown(boolean waitForJobsToCompleteOnShutdown)` Set whether to wait for running jobs to complete on shutdown.
    `void` | `start()` Start this component.
    `protected void` | `startScheduler(Scheduler scheduler, int startupDelay)` Start the Quartz Scheduler, respecting the "startupDelay" setting.
    `void` | `stop()` Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
    `void` | `stop(Runnable callback)` Indicates that a Lifecycle component must stop if it is currently running.

    - ### Methods inherited from class org.springframework.scheduling.quartz.SchedulerAccessor

      `registerJobsAndTriggers, registerListeners, setCalendars, setGlobalJobListeners, setGlobalTriggerListeners, setJobDetails, setJobListeners, setJobSchedulingDataLocation, setJobSchedulingDataLocations, setOverwriteExistingJobs, setResourceLoader, setSchedulerListeners, setTransactionManager, setTriggerListeners, setTriggers`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### PROP_THREAD_COUNT

          public static final String PROP_THREAD_COUNT

      See Also:
        Constant Field Values

    - #### DEFAULT_THREAD_COUNT

          public static final int DEFAULT_THREAD_COUNT

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### SchedulerFactoryBean

          public SchedulerFactoryBean()

  - ### Method Detail

    - #### getConfigTimeResourceLoader

          public static ResourceLoader getConfigTimeResourceLoader()

      Return the ResourceLoader for the currently configured Quartz Scheduler, to be used by ResourceLoaderClassLoadHelper.

      This instance will be set before initialization of the corresponding Scheduler, and reset immediately afterwards. It is thus only available during configuration.

      See Also:
        `setApplicationContext(org.springframework.context.ApplicationContext)`, `ResourceLoaderClassLoadHelper`

    - #### getConfigTimeTaskExecutor

          public static Executor getConfigTimeTaskExecutor()

      Return the TaskExecutor for the currently configured Quartz Scheduler, to be used by LocalTaskExecutorThreadPool.

      This instance will be set before initialization of the corresponding Scheduler, and reset immediately afterwards. It is thus only available during configuration.

      See Also:
        `setTaskExecutor(java.util.concurrent.Executor)`, `LocalTaskExecutorThreadPool`

    - #### getConfigTimeDataSource

          public static DataSource getConfigTimeDataSource()

      Return the DataSource for the currently configured Quartz Scheduler, to be used by LocalDataSourceJobStore.

      This instance will be set before initialization of the corresponding Scheduler, and reset immediately afterwards. It is thus only available during configuration.

      See Also:
        `setDataSource(javax.sql.DataSource)`, `LocalDataSourceJobStore`

    - #### getConfigTimeNonTransactionalDataSource

          public static DataSource getConfigTimeNonTransactionalDataSource()

      Return the non-transactional DataSource for the currently configured Quartz Scheduler, to be used by LocalDataSourceJobStore.

      This instance will be set before initialization of the corresponding Scheduler, and reset immediately afterwards. It is thus only available during configuration.

      See Also:
        `setNonTransactionalDataSource(javax.sql.DataSource)`, `LocalDataSourceJobStore`

    - #### setSchedulerFactoryClass

          public void setSchedulerFactoryClass(Class schedulerFactoryClass)

      Set the Quartz SchedulerFactory implementation to use.

      Default is StdSchedulerFactory, reading in the standard `quartz.properties` from `quartz.jar`. To use custom Quartz properties, specify the "configLocation" or "quartzProperties" bean property on this FactoryBean.

      See Also:
        `StdSchedulerFactory`, `setConfigLocation(org.springframework.core.io.Resource)`, `setQuartzProperties(java.util.Properties)`

    - #### setSchedulerName

          public void setSchedulerName(String schedulerName)

      Set the name of the Scheduler to create via the SchedulerFactory.

      If not specified, the bean name will be used as default scheduler name.

      See Also:
        `setBeanName(java.lang.String)`, `SchedulerFactory.getScheduler()`, `SchedulerFactory.getScheduler(String)`

    - #### setConfigLocation

          public void setConfigLocation(Resource configLocation)

      Set the location of the Quartz properties config file, for example as classpath resource "classpath:quartz.properties".

      Note: Can be omitted when all necessary properties are specified locally via this bean, or when relying on Quartz' default configuration.

      See Also:
        `setQuartzProperties(java.util.Properties)`

    - #### setQuartzProperties

          public void setQuartzProperties(Properties quartzProperties)

      Set Quartz properties, like "org.quartz.threadPool.class".

      Can be used to override values in a Quartz properties config file, or to specify all necessary properties locally.

      See Also:
        `setConfigLocation(org.springframework.core.io.Resource)`

    - #### setTaskExecutor

          public void setTaskExecutor(Executor taskExecutor)

      Set the Spring TaskExecutor to use as Quartz backend. Exposed as thread pool through the Quartz SPI.

      Can be used to assign a JDK 1.5 ThreadPoolExecutor or a CommonJ WorkManager as Quartz backend, to avoid Quartz's manual thread creation.

      By default, a Quartz SimpleThreadPool will be used, configured through the corresponding Quartz properties.

      See Also:
        `setQuartzProperties(java.util.Properties)`, `LocalTaskExecutorThreadPool`, `ThreadPoolTaskExecutor`, `WorkManagerTaskExecutor`

    - #### setDataSource

          public void setDataSource(DataSource dataSource)

      Set the default DataSource to be used by the Scheduler. If set, this will override corresponding settings in Quartz properties.

      Note: If this is set, the Quartz settings should not define a job store "dataSource" to avoid meaningless double configuration.

      A Spring-specific subclass of Quartz' JobStoreCMT will be used. It is therefore strongly recommended to perform all operations on the Scheduler within Spring-managed (or plain JTA) transactions. Else, database locking will not properly work and might even break (e.g. if trying to obtain a lock on Oracle without a transaction).

      Supports both transactional and non-transactional DataSource access. With a non-XA DataSource and local Spring transactions, a single DataSource argument is sufficient. In case of an XA DataSource and global JTA transactions, SchedulerFactoryBean's "nonTransactionalDataSource" property should be set, passing in a non-XA DataSource that will not participate in global transactions.

      See Also:
        `setNonTransactionalDataSource(javax.sql.DataSource)`, `setQuartzProperties(java.util.Properties)`, `SchedulerAccessor.setTransactionManager(org.springframework.transaction.PlatformTransactionManager)`, `LocalDataSourceJobStore`

    - #### setNonTransactionalDataSource

          public void setNonTransactionalDataSource(DataSource nonTransactionalDataSource)

      Set the DataSource to be used by the Scheduler for non-transactional access.

      This is only necessary if the default DataSource is an XA DataSource that will always participate in transactions: A non-XA version of that DataSource should be specified as "nonTransactionalDataSource" in such a scenario.

      This is not relevant with a local DataSource instance and Spring transactions. Specifying a single default DataSource as "dataSource" is sufficient there.

      See Also:
        `setDataSource(javax.sql.DataSource)`, `LocalDataSourceJobStore`

    - #### setSchedulerContextAsMap

          public void setSchedulerContextAsMap(Map schedulerContextAsMap)

      Register objects in the Scheduler context via a given Map. These objects will be available to any Job that runs in this Scheduler.

      Note: When using persistent Jobs whose JobDetail will be kept in the database, do not put Spring-managed beans or an ApplicationContext reference into the JobDataMap but rather into the SchedulerContext.

      Parameters:
        `schedulerContextAsMap` - Map with String keys and any objects as values (for example Spring-managed beans)
      See Also:
        `JobDetailBean.setJobDataAsMap(java.util.Map)`

    - #### setApplicationContextSchedulerContextKey

          public void setApplicationContextSchedulerContextKey(String applicationContextSchedulerContextKey)

      Set the key of an ApplicationContext reference to expose in the SchedulerContext, for example "applicationContext". Default is none. Only applicable when running in a Spring ApplicationContext.

      Note: When using persistent Jobs whose JobDetail will be kept in the database, do not put an ApplicationContext reference into the JobDataMap but rather into the SchedulerContext.

      In case of a QuartzJobBean, the reference will be applied to the Job instance as bean property. An "applicationContext" attribute will correspond to a "setApplicationContext" method in that scenario.

      Note that BeanFactory callback interfaces like ApplicationContextAware are not automatically applied to Quartz Job instances, because Quartz itself is reponsible for the lifecycle of its Jobs.

      See Also:
        `JobDetailBean.setApplicationContextJobDataKey(java.lang.String)`, `ApplicationContext`

    - #### setJobFactory

          public void setJobFactory(org.quartz.spi.JobFactory jobFactory)

      Set the Quartz JobFactory to use for this Scheduler.

      Default is Spring's `AdaptableJobFactory`, which supports `Runnable` objects as well as standard Quartz `Job` instances. Note that this default only applies to a local Scheduler, not to a RemoteScheduler (where setting a custom JobFactory is not supported by Quartz).

      Specify an instance of Spring's `SpringBeanJobFactory` here (typically as an inner bean definition) to automatically populate a job's bean properties from the specified job data map and scheduler context.

      See Also:
        `AdaptableJobFactory`, `SpringBeanJobFactory`

    - #### setAutoStartup

          public void setAutoStartup(boolean autoStartup)

      Set whether to automatically start the scheduler after initialization.

      Default is "true"; set this to "false" to allow for manual startup.

    - #### isAutoStartup

          public boolean isAutoStartup()

      Return whether this scheduler is configured for auto-startup. If "true", the scheduler will start after the context is refreshed and after the start delay, if any.
      Specified by:
        `isAutoStartup` in interface `SmartLifecycle`

    - #### setPhase

          public void setPhase(int phase)

      Specify the phase in which this scheduler should be started and stopped. The startup order proceeds from lowest to highest, and the shutdown order is the reverse of that. By default this value is Integer.MAX_VALUE meaning that this scheduler starts as late as possible and stops as soon as possible.

    - #### getPhase

          public int getPhase()

      Return the phase in which this scheduler will be started and stopped.
      Specified by:
        `getPhase` in interface `Phased`

    - #### setStartupDelay

          public void setStartupDelay(int startupDelay)

      Set the number of seconds to wait after initialization before starting the scheduler asynchronously. Default is 0, meaning immediate synchronous startup on initialization of this bean.

      Setting this to 10 or 20 seconds makes sense if no jobs should be run before the entire application has started up.

    - #### setExposeSchedulerInRepository

          public void setExposeSchedulerInRepository(boolean exposeSchedulerInRepository)

      Set whether to expose the Spring-managed `Scheduler` instance in the Quartz `SchedulerRepository`. Default is "false", since the Spring-managed Scheduler is usually exclusively intended for access within the Spring context.

      Switch this flag to "true" in order to expose the Scheduler globally. This is not recommended unless you have an existing Spring application that relies on this behavior. Note that such global exposure was the accidental default in earlier Spring versions; this has been fixed as of Spring 2.5.6.

    - #### setWaitForJobsToCompleteOnShutdown

          public void setWaitForJobsToCompleteOnShutdown(boolean waitForJobsToCompleteOnShutdown)

      Set whether to wait for running jobs to complete on shutdown.

      Default is "false". Switch this to "true" if you prefer fully completed jobs at the expense of a longer shutdown phase.

      See Also:
        `Scheduler.shutdown(boolean)`

    - #### setBeanName

          public void setBeanName(String name)

      Description copied from interface: `BeanNameAware`
      Set the name of the bean in the bean factory that created this bean.

      Invoked after population of normal bean properties but before an init callback such as `InitializingBean.afterPropertiesSet()` or a custom init-method.

      Specified by:
        `setBeanName` in interface `BeanNameAware`
      Parameters:
        `name` - the name of the bean in the factory. Note that this name is the actual bean name used in the factory, which may differ from the originally specified name: in particular for inner bean names, the actual bean name might have been made unique through appending "#..." suffixes. Use the `BeanFactoryUtils.originalBeanName(String)` method to extract the original bean name (without suffix), if desired.

    - #### setApplicationContext

          public void setApplicationContext(ApplicationContext applicationContext)

      Description copied from interface: `ApplicationContextAware`
      Set the ApplicationContext that this object runs in. Normally this call will be used to initialize the object.

      Invoked after population of normal bean properties but before an init callback such as `InitializingBean.afterPropertiesSet()` or a custom init-method. Invoked after `ResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader)`, `ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)` and `MessageSourceAware`, if applicable.

      Specified by:
        `setApplicationContext` in interface `ApplicationContextAware`
      Parameters:
        `applicationContext` - the ApplicationContext object to be used by this object
      See Also:
        `BeanInitializationException`

    - #### afterPropertiesSet

          public void afterPropertiesSet()
                                  throws Exception

      Description copied from interface: `InitializingBean`
      Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

      This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

      Specified by:
        `afterPropertiesSet` in interface `InitializingBean`
      Throws:
        `Exception` - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails.

    - #### createScheduler

          protected Scheduler createScheduler(SchedulerFactory schedulerFactory,
                                  String schedulerName)
                                       throws SchedulerException

      Create the Scheduler instance for the given factory and scheduler name. Called by `afterPropertiesSet()`.

      The default implementation invokes SchedulerFactory's `getScheduler` method. Can be overridden for custom Scheduler creation.

      Parameters:
        `schedulerFactory` - the factory to create the Scheduler with
        `schedulerName` - the name of the scheduler to create
      Returns:
        the Scheduler instance
      Throws:
        `SchedulerException` - if thrown by Quartz methods
      See Also:
        `afterPropertiesSet()`, `SchedulerFactory.getScheduler()`

    - #### startScheduler

          protected void startScheduler(Scheduler scheduler,
                            int startupDelay)
                                 throws SchedulerException

      Start the Quartz Scheduler, respecting the "startupDelay" setting.
      Parameters:
        `scheduler` - the Scheduler to start
        `startupDelay` - the number of seconds to wait before starting the Scheduler asynchronously
      Throws:
        `SchedulerException`

    - #### getScheduler

          public Scheduler getScheduler()

      Description copied from class: `SchedulerAccessor`
      Template method that determines the Scheduler to operate on. To be implemented by subclasses.
      Specified by:
        `getScheduler` in class `SchedulerAccessor`

    - #### getObject

          public Scheduler getObject()

      Description copied from interface: `FactoryBean`
      Return an instance (possibly shared or independent) of the object managed by this factory.

      As with a `BeanFactory`, this allows support for both the Singleton and Prototype design pattern.

      If this FactoryBean is not fully initialized yet at the time of the call (for example because it is involved in a circular reference), throw a corresponding `FactoryBeanNotInitializedException`.

      As of Spring 2.0, FactoryBeans are allowed to return `null` objects. The factory will consider this as normal value to be used; it will not throw a FactoryBeanNotInitializedException in this case anymore. FactoryBean implementations are encouraged to throw FactoryBeanNotInitializedException themselves now, as appropriate.

      Specified by:
        `getObject` in interface `FactoryBean<Scheduler>`
      Returns:
        an instance of the bean (can be `null`)
      See Also:
        `FactoryBeanNotInitializedException`

    - #### getObjectType

          public Class<? extends Scheduler> getObjectType()

      Description copied from interface: `FactoryBean`
      Return the type of object that this FactoryBean creates, or `null` if not known in advance.

      This allows one to check for specific types of beans without instantiating objects, for example on autowiring.

      In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.

      This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.

      NOTE: Autowiring will simply ignore FactoryBeans that return `null` here. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.

      Specified by:
        `getObjectType` in interface `FactoryBean<Scheduler>`
      Returns:
        the type of object that this FactoryBean creates, or `null` if not known at the time of the call
      See Also:
        `ListableBeanFactory.getBeansOfType(java.lang.Class<T>)`

    - #### isSingleton

          public boolean isSingleton()

      Description copied from interface: `FactoryBean`
      Is the object managed by this factory a singleton? That is, will `FactoryBean.getObject()` always return the same object (a reference that can be cached)?

      NOTE: If a FactoryBean indicates to hold a singleton object, the object returned from `getObject()` might get cached by the owning BeanFactory. Hence, do not return `true` unless the FactoryBean always exposes the same reference.

      The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.

      NOTE: This method returning `false` does not necessarily indicate that returned objects are independent instances. An implementation of the extended `SmartFactoryBean` interface may explicitly indicate independent instances through its `SmartFactoryBean.isPrototype()` method. Plain `FactoryBean` implementations which do not implement this extended interface are simply assumed to always return independent instances if the `isSingleton()` implementation returns `false`.

      Specified by:
        `isSingleton` in interface `FactoryBean<Scheduler>`
      Returns:
        whether the exposed object is a singleton
      See Also:
        `FactoryBean.getObject()`, `SmartFactoryBean.isPrototype()`

    - #### start

          public void start()
                     throws SchedulingException

      Description copied from interface: `Lifecycle`
      Start this component. Should not throw an exception if the component is already running.

      In the case of a container, this will propagate the start signal to all components that apply.

      Specified by:
        `start` in interface `Lifecycle`
      Throws:
        `SchedulingException`

    - #### stop

          public void stop()
                    throws SchedulingException

      Description copied from interface: `Lifecycle`
      Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing `SmartLifecycle` and its `stop(Runnable)` variant in cases where asynchronous stop behavior is necessary.

      Should not throw an exception if the component isn't started yet.

      In the case of a container, this will propagate the stop signal to all components that apply.

      Specified by:
        `stop` in interface `Lifecycle`
      Throws:
        `SchedulingException`
      See Also:
        `SmartLifecycle.stop(Runnable)`

    - #### stop

          public void stop(Runnable callback)
                    throws SchedulingException

      Description copied from interface: `SmartLifecycle`
      Indicates that a Lifecycle component must stop if it is currently running.

      The provided callback is used by the `LifecycleProcessor` to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the SmartLifecycle component does indeed stop.

      The `LifecycleProcessor` will call only this variant of the `stop` method; i.e. `Lifecycle.stop()` will not be called for `SmartLifecycle` implementations unless explicitly delegated to within this method.

      Specified by:
        `stop` in interface `SmartLifecycle`
      Throws:
        `SchedulingException`

    - #### isRunning

          public boolean isRunning()
                            throws SchedulingException

      Description copied from interface: `Lifecycle`
      Check whether this component is currently running.

      In the case of a container, this will return `true` only if all components that apply are currently running.

      Specified by:
        `isRunning` in interface `Lifecycle`
      Returns:
        whether the component is currently running
      Throws:
        `SchedulingException`

    - #### destroy

          public void destroy()
                       throws SchedulerException

      Shut down the Quartz scheduler on bean factory shutdown, stopping all scheduled jobs.
      Specified by:
        `destroy` in interface `DisposableBean`
      Throws:
        `SchedulerException`