public class JobDetailBean extends JobDetail implements BeanNameAware, ApplicationContextAware, InitializingBean
JobDetail
class,
making bean-style usage easier.
JobDetail
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.
NOTE: This convenience subclass does not work against Quartz 2.0.
Use Quartz 2.0's native JobDetailImpl
class or the new Quartz 2.0
builder API instead. Alternatively, switch to Spring's JobDetailFactoryBean
which largely is a drop-in replacement for this class and its properties and
consistently works against Quartz 1.x as well as Quartz 2.0/2.1.
JobDetail.setName(java.lang.String)
,
JobDetail.setGroup(java.lang.String)
,
BeanNameAware
,
Scheduler.DEFAULT_GROUP
,
Serialized FormConstructor and Description |
---|
JobDetailBean() |
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).
|
Class |
getJobClass()
Overridden to support any job class, to allow a custom JobFactory
to adapt the given job class to the Quartz Job interface.
|
void |
setApplicationContext(ApplicationContext applicationContext)
Set the ApplicationContext that this object runs in.
|
void |
setApplicationContextJobDataKey(String applicationContextJobDataKey)
Set the key of an ApplicationContext reference to expose in the JobDataMap,
for example "applicationContext".
|
void |
setBeanName(String beanName)
Set the name of the bean in the bean factory that created this bean.
|
void |
setJobClass(Class jobClass)
Overridden to support any job class, to allow a custom JobFactory
to adapt the given job class to the Quartz Job interface.
|
void |
setJobDataAsMap(Map jobDataAsMap)
Register objects in the JobDataMap via a given Map.
|
void |
setJobListenerNames(String[] names)
Set a list of JobListener names for this job, referring to
non-global JobListeners registered with the Scheduler.
|
addJobListener, clone, equals, getDescription, getFullName, getGroup, getJobDataMap, getJobListenerNames, getKey, getName, hashCode, isDurable, isStateful, isVolatile, removeJobListener, requestsRecovery, setDescription, setDurability, setGroup, setJobDataMap, setName, setRequestsRecovery, setVolatility, toString, validate
public void setJobClass(Class jobClass)
setJobClass
in class JobDetail
SchedulerFactoryBean.setJobFactory(org.quartz.spi.JobFactory)
public Class getJobClass()
getJobClass
in class JobDetail
public void setJobDataAsMap(Map jobDataAsMap)
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)
public void setJobListenerNames(String[] names)
A JobListener name always refers to the name returned by the JobListener implementation.
public void setBeanName(String beanName)
BeanNameAware
Invoked after population of normal bean properties but before an
init callback such as InitializingBean.afterPropertiesSet()
or a custom init-method.
setBeanName
in interface 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 the BeanFactoryUtils.originalBeanName(String)
method to extract the original bean name (without suffix), if desired.public void setApplicationContext(ApplicationContext applicationContext)
ApplicationContextAware
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
in interface ApplicationContextAware
applicationContext
- the ApplicationContext object to be used by this objectBeanInitializationException
public void setApplicationContextJobDataKey(String applicationContextJobDataKey)
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.
public void afterPropertiesSet()
InitializingBean
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.
afterPropertiesSet
in interface InitializingBean