类 JobDetailFactoryBean
- java.lang.Object
- org.springframework.scheduling.quartz.JobDetailFactoryBean
public class JobDetailFactoryBean extends Object implements FactoryBean<JobDetail>, BeanNameAware, ApplicationContextAware, InitializingBean
A SpringFactoryBeanfor creating a QuartzJobDetailinstance, supporting bean-style usage for JobDetail configuration.JobDetail(Impl)itself is already a JavaBean but lacks sensible defaults. This class uses the Spring bean name as job name, and the Quartz default group ("DEFAULT") as job group if not specified.- 从以下版本开始:
- 3.1
- 作者:
- Juergen Hoeller
- 另请参阅:
setName(java.lang.String),setGroup(java.lang.String),BeanNameAware,Scheduler.DEFAULT_GROUP
构造器概要
构造器 构造器 说明 JobDetailFactoryBean()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 voidafterPropertiesSet()Invoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.JobDataMapgetJobDataMap()Return the job's JobDataMap.JobDetailgetObject()Return an instance (possibly shared or independent) of the object managed by this factory.Class<?>getObjectType()Return the type of object that this FactoryBean creates, ornullif not known in advance.booleanisSingleton()Is the object managed by this factory a singleton?voidsetApplicationContext(ApplicationContext applicationContext)Set the ApplicationContext that this object runs in.voidsetApplicationContextJobDataKey(String applicationContextJobDataKey)Set the key of an ApplicationContext reference to expose in the JobDataMap, for example "applicationContext".voidsetBeanName(String beanName)Set the name of the bean in the bean factory that created this bean.voidsetDescription(String description)Set a textual description for this job.voidsetDurability(boolean durability)Specify the job's durability, i.e. whether it should remain stored in the job store even if no triggers point to it anymore.voidsetGroup(String group)Specify the job's group.voidsetJobClass(Class<?> jobClass)Specify the job's implementation class.voidsetJobDataAsMap(Map<String,?> jobDataAsMap)Register objects in the JobDataMap via a given Map.voidsetJobDataMap(JobDataMap jobDataMap)Set the job's JobDataMap.voidsetName(String name)Specify the job's name.voidsetRequestsRecovery(boolean requestsRecovery)Set the recovery flag for this job, i.e. whether or not the job should get re-executed if a 'recovery' or 'fail-over' situation is encountered.
构造器详细资料
JobDetailFactoryBean
public JobDetailFactoryBean()
方法详细资料
setJobClass
public void setJobClass(Class<?> jobClass)
Specify the job's implementation class.
setJobDataMap
public void setJobDataMap(JobDataMap jobDataMap)
Set the job's JobDataMap.
getJobDataMap
public JobDataMap getJobDataMap()
Return the job's JobDataMap.
setJobDataAsMap
public void setJobDataAsMap(Map<String,?> jobDataAsMap)
Register objects in the JobDataMap via a given Map.These objects will be available to this Job only, in contrast to objects in the SchedulerContext.
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.
- 参数:
jobDataAsMap- Map with String keys and any objects as values (for example Spring-managed beans)- 另请参阅:
SchedulerFactoryBean.setSchedulerContextAsMap(java.util.Map<java.lang.String, ?>)
setDurability
public void setDurability(boolean durability)
Specify the job's durability, i.e. whether it should remain stored in the job store even if no triggers point to it anymore.
setRequestsRecovery
public void setRequestsRecovery(boolean requestsRecovery)
Set the recovery flag for this job, i.e. whether or not the job should get re-executed if a 'recovery' or 'fail-over' situation is encountered.
setDescription
public void setDescription(String description)
Set a textual description for this job.
setBeanName
public void setBeanName(String beanName)
从接口复制的说明:BeanNameAwareSet 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- 参数:
beanName- 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 theBeanFactoryUtils.originalBeanName(String)method to extract the original bean name (without suffix), if desired.
setApplicationContext
public void setApplicationContext(ApplicationContext applicationContext)
从接口复制的说明:ApplicationContextAwareSet 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 afterResourceLoaderAware.setResourceLoader(org.springframework.core.io.ResourceLoader),ApplicationEventPublisherAware.setApplicationEventPublisher(org.springframework.context.ApplicationEventPublisher)andMessageSourceAware, if applicable.- 指定者:
setApplicationContext在接口中ApplicationContextAware- 参数:
applicationContext- the ApplicationContext object to be used by this object- 另请参阅:
BeanInitializationException
setApplicationContextJobDataKey
public void setApplicationContextJobDataKey(String applicationContextJobDataKey)
Set the key of an ApplicationContext reference to expose in the JobDataMap, for example "applicationContext". Default is none. Only applicable when running in a Spring ApplicationContext.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.
Note: When using persistent job stores where JobDetail contents will be kept in the database, do not put an ApplicationContext reference into the JobDataMap but rather into the SchedulerContext.
afterPropertiesSet
public void afterPropertiesSet()
从接口复制的说明:InitializingBeanInvoked by the containingBeanFactoryafter it has set all bean properties and satisfiedBeanFactoryAware,ApplicationContextAwareetc.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
getObject
public JobDetail getObject()
从接口复制的说明:FactoryBeanReturn 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
nullobjects. 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<JobDetail>- 返回:
- an instance of the bean (can be
null) - 另请参阅:
FactoryBeanNotInitializedException
getObjectType
public Class<?> getObjectType()
从接口复制的说明:FactoryBeanReturn the type of object that this FactoryBean creates, ornullif 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
nullhere. Therefore it is highly recommended to implement this method properly, using the current state of the FactoryBean.- 指定者:
getObjectType在接口中FactoryBean<JobDetail>- 返回:
- the type of object that this FactoryBean creates, or
nullif not known at the time of the call - 另请参阅:
ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
isSingleton
public boolean isSingleton()
从接口复制的说明:FactoryBeanIs the object managed by this factory a singleton? That is, willFactoryBean.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 returntrueunless 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
falsedoes not necessarily indicate that returned objects are independent instances. An implementation of the extendedSmartFactoryBeaninterface may explicitly indicate independent instances through itsSmartFactoryBean.isPrototype()method. PlainFactoryBeanimplementations which do not implement this extended interface are simply assumed to always return independent instances if theisSingleton()implementation returnsfalse.- 指定者:
isSingleton在接口中FactoryBean<JobDetail>- 返回:
- whether the exposed object is a singleton
- 另请参阅:
FactoryBean.getObject(),SmartFactoryBean.isPrototype()