Spring Framework

org.springframework.scheduling.quartz
Class JobDetailBean

java.lang.Object
  extended by org.quartz.JobDetail
      extended by org.springframework.scheduling.quartz.JobDetailBean
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Aware, BeanNameAware, InitializingBean, ApplicationContextAware

public class JobDetailBean
extends org.quartz.JobDetail
implements BeanNameAware, ApplicationContextAware, InitializingBean

Convenience subclass of Quartz's 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.

Since:
18.02.2004
Author:
Juergen Hoeller
See Also:
JobDetail.setName(java.lang.String), JobDetail.setGroup(java.lang.String), BeanNameAware, Scheduler.DEFAULT_GROUP, Serialized Form

Constructor Summary
JobDetailBean()
           
 
Method Summary
 void afterPropertiesSet()
          Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
 java.lang.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(java.lang.String applicationContextJobDataKey)
          Set the key of an ApplicationContext reference to expose in the JobDataMap, for example "applicationContext".
 void setBeanName(java.lang.String beanName)
          Set the name of the bean in the bean factory that created this bean.
 void setJobClass(java.lang.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(java.util.Map jobDataAsMap)
          Register objects in the JobDataMap via a given Map.
 void setJobListenerNames(java.lang.String[] names)
          Set a list of JobListener names for this job, referring to non-global JobListeners registered with the Scheduler.
 
Methods inherited from class org.quartz.JobDetail
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
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JobDetailBean

public JobDetailBean()
Method Detail

setJobClass

public void setJobClass(java.lang.Class jobClass)
Overridden to support any job class, to allow a custom JobFactory to adapt the given job class to the Quartz Job interface.

Overrides:
setJobClass in class org.quartz.JobDetail
See Also:
SchedulerFactoryBean.setJobFactory(org.quartz.spi.JobFactory)

getJobClass

public java.lang.Class getJobClass()
Overridden to support any job class, to allow a custom JobFactory to adapt the given job class to the Quartz Job interface.

Overrides:
getJobClass in class org.quartz.JobDetail

setJobDataAsMap

public void setJobDataAsMap(java.util.Map 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.

Parameters:
jobDataAsMap - Map with String keys and any objects as values (for example Spring-managed beans)
See Also:
SchedulerFactoryBean.setSchedulerContextAsMap(java.util.Map)

setJobListenerNames

public void setJobListenerNames(java.lang.String[] names)
Set a list of JobListener names for this job, referring to non-global JobListeners registered with the Scheduler.

A JobListener name always refers to the name returned by the JobListener implementation.

See Also:
SchedulerAccessor.setJobListeners(org.quartz.JobListener[]), JobListener.getName()

setBeanName

public void setBeanName(java.lang.String beanName)
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:
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.

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

setApplicationContextJobDataKey

public void setApplicationContextJobDataKey(java.lang.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.

See Also:
SchedulerFactoryBean.setApplicationContextSchedulerContextKey(java.lang.String), ApplicationContext

afterPropertiesSet

public void afterPropertiesSet()
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

Spring Framework