类 SchedulerFactoryBean

字段详细资料

• PROP_THREAD_COUNT

  public static final String PROP_THREAD_COUNT

  另请参阅:

  常量字段值

• DEFAULT_THREAD_COUNT

  public static final int DEFAULT_THREAD_COUNT

  另请参阅:

  常量字段值

构造器详细资料

• SchedulerFactoryBean

  public SchedulerFactoryBean()

方法详细资料

• 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.

  另请参阅:

  setApplicationContext(org.springframework.context.ApplicationContext), ResourceLoaderClassLoadHelper

• getConfigTimeTaskExecutor

  public static Executor getConfigTimeTaskExecutor()

  Return the Executor 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.

  从以下版本开始:

  2.0

  另请参阅:

  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.

  从以下版本开始:

  1.1

  另请参阅:

  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.

  从以下版本开始:

  1.1

  另请参阅:

  setNonTransactionalDataSource(javax.sql.DataSource), LocalDataSourceJobStore

• setSchedulerFactory

  public void setSchedulerFactory​(SchedulerFactory schedulerFactory)

  Set an external Quartz SchedulerFactory instance to use.

  Default is an internal StdSchedulerFactory instance. If this method is called, it overrides any class specified through setSchedulerFactoryClass(java.lang.Class<? extends org.quartz.SchedulerFactory>) as well as any settings specified through setConfigLocation(org.springframework.core.io.Resource), setQuartzProperties(java.util.Properties), setTaskExecutor(java.util.concurrent.Executor) or setDataSource(javax.sql.DataSource).

  NOTE: With an externally provided SchedulerFactory instance, local settings such as setConfigLocation(org.springframework.core.io.Resource) or setQuartzProperties(java.util.Properties) will be ignored here in SchedulerFactoryBean, expecting the external SchedulerFactory instance to get initialized on its own.

  从以下版本开始:

  4.3.15

  另请参阅:

  setSchedulerFactoryClass(java.lang.Class<? extends org.quartz.SchedulerFactory>)

• setSchedulerFactoryClass

  public void setSchedulerFactoryClass​(Class<? extends SchedulerFactory> schedulerFactoryClass)

  Set the Quartz SchedulerFactory implementation to use.

  Default is the StdSchedulerFactory class, reading in the standard quartz.properties from quartz.jar. For applying custom Quartz properties, specify "configLocation" and/or "quartzProperties" etc on this local SchedulerFactoryBean instance.

  另请参阅:

  StdSchedulerFactory, setConfigLocation(org.springframework.core.io.Resource), setQuartzProperties(java.util.Properties), setTaskExecutor(java.util.concurrent.Executor), setDataSource(javax.sql.DataSource)

• 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.

  另请参阅:

  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.

  另请参阅:

  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.

  另请参阅:

  setConfigLocation(org.springframework.core.io.Resource)

• setTaskExecutor

  public void setTaskExecutor​(Executor taskExecutor)

  Set a Spring-managed Executor to use as Quartz backend. Exposed as thread pool through the Quartz SPI.

  Can be used to assign a local JDK 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.

  从以下版本开始:

  2.0

  另请参阅:

  setQuartzProperties(java.util.Properties), LocalTaskExecutorThreadPool, ThreadPoolTaskExecutor, DefaultManagedTaskExecutor

• 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.

  从以下版本开始:

  1.1

  另请参阅:

  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 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.

  从以下版本开始:

  1.1

  另请参阅:

  setDataSource(javax.sql.DataSource), LocalDataSourceJobStore

• setSchedulerContextAsMap

  public void setSchedulerContextAsMap​(Map<String,​?> 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.

  参数:

  schedulerContextAsMap - a Map with String keys and any objects as values (for example Spring-managed beans)

  另请参阅:

  JobDetailFactoryBean.setJobDataAsMap(java.util.Map<java.lang.String, ?>)

• 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 responsible for the lifecycle of its Jobs.

  另请参阅:

  JobDetailFactoryBean.setApplicationContextJobDataKey(java.lang.String), ApplicationContext

• setJobFactory

  public void setJobFactory​(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.

  从以下版本开始:

  2.0

  另请参阅:

  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.

  指定者:

  isAutoStartup 在接口中 SmartLifecycle

  另请参阅:

  Lifecycle.start(), Phased.getPhase(), LifecycleProcessor.onRefresh(), ConfigurableApplicationContext.refresh()

• 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.

  从以下版本开始:

  3.0

• getPhase

  public int getPhase()

  Return the phase in which this scheduler will be started and stopped.

  指定者:

  getPhase 在接口中 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.

  另请参阅:

  Scheduler.shutdown(boolean)

• setBeanName

  public void setBeanName​(String name)

  从接口复制的说明: 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.

  指定者:

  setBeanName 在接口中 BeanNameAware

  参数:

  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)

  从接口复制的说明: 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.

  指定者:

  setApplicationContext 在接口中 ApplicationContextAware

  参数:

  applicationContext - the ApplicationContext object to be used by this object

  另请参阅:

  BeanInitializationException

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws Exception

  从接口复制的说明: InitializingBean
  Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

  This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

  抛出:

  Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason

• 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.

  参数:

  schedulerFactory - the factory to create the Scheduler with

  schedulerName - the name of the scheduler to create

  返回:

  the Scheduler instance

  抛出:

  SchedulerException - if thrown by Quartz methods

  另请参阅:

  afterPropertiesSet(), SchedulerFactory.getScheduler()

• startScheduler

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

  Start the Quartz Scheduler, respecting the "startupDelay" setting.

  参数:

  scheduler - the Scheduler to start

  startupDelay - the number of seconds to wait before starting the Scheduler asynchronously

  抛出:

  SchedulerException

• getScheduler

  public Scheduler getScheduler()

  从类复制的说明: SchedulerAccessor
  Template method that determines the Scheduler to operate on. To be implemented by subclasses.

  指定者:

  getScheduler 在类中 SchedulerAccessor

• getObject

  public Scheduler getObject()

  从接口复制的说明: 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.

  指定者:

  getObject 在接口中 FactoryBean<Scheduler>

  返回:

  an instance of the bean (can be null)

  另请参阅:

  FactoryBeanNotInitializedException

• getObjectType

  public Class<? extends Scheduler> getObjectType()

  从接口复制的说明: 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.

  指定者:

  getObjectType 在接口中 FactoryBean<Scheduler>

  返回:

  the type of object that this FactoryBean creates, or null if not known at the time of the call

  另请参阅:

  ListableBeanFactory.getBeansOfType(java.lang.Class<T>)

• isSingleton

  public boolean isSingleton()

  从接口复制的说明: 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.

  指定者:

  isSingleton 在接口中 FactoryBean<Scheduler>

  返回:

  whether the exposed object is a singleton

  另请参阅:

  FactoryBean.getObject(), SmartFactoryBean.isPrototype()

• start

  public void start()
             throws SchedulingException

  从接口复制的说明: 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.

  指定者:

  start 在接口中 Lifecycle

  抛出:

  SchedulingException

  另请参阅:

  SmartLifecycle.isAutoStartup()

• stop

  public void stop()
            throws SchedulingException

  从接口复制的说明: 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 when asynchronous stop behavior is necessary.

  Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

  Should not throw an exception if the component is not running (not started yet).

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

  指定者:

  stop 在接口中 Lifecycle

  抛出:

  SchedulingException

  另请参阅:

  SmartLifecycle.stop(Runnable), DisposableBean.destroy()

• stop

  public void stop​(Runnable callback)
            throws SchedulingException

  从接口复制的说明: 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 the implementation of this method.

  指定者:

  stop 在接口中 SmartLifecycle

  抛出:

  SchedulingException

  另请参阅:

  Lifecycle.stop(), Phased.getPhase()

• isRunning

  public boolean isRunning()
                    throws SchedulingException

  从接口复制的说明: 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.

  指定者:

  isRunning 在接口中 Lifecycle

  返回:

  whether the component is currently running

  抛出:

  SchedulingException

• destroy

  public void destroy()
               throws SchedulerException

  Shut down the Quartz scheduler on bean factory shutdown, stopping all scheduled jobs.

  指定者:

  destroy 在接口中 DisposableBean

  抛出:

  SchedulerException