Package org.springframework.scheduling.quartz

Class SpringBeanJobFactory

java.lang.Object

org.springframework.scheduling.quartz.AdaptableJobFactory

org.springframework.scheduling.quartz.SpringBeanJobFactory

All Implemented Interfaces:

JobFactory, Aware, ApplicationContextAware, SchedulerContextAware

public class SpringBeanJobFactory
extends AdaptableJobFactory
implements ApplicationContextAware, SchedulerContextAware

Subclass of AdaptableJobFactory that also supports Spring-style dependency injection on bean properties. This is essentially the direct equivalent of Spring's QuartzJobBean in the shape of a Quartz JobFactory.

Applies scheduler context, job data map and trigger data map entries as bean property values. If no matching bean property is found, the entry is by default simply ignored. This is analogous to QuartzJobBean's behavior.

Compatible with Quartz 2.1.4 and higher, as of Spring 4.1.

Since:

2.0

Author:

Juergen Hoeller

See Also:

• SchedulerFactoryBean.setJobFactory(org.quartz.spi.JobFactory)
• QuartzJobBean

Constructor Summary

Constructors

Constructor	Description
SpringBeanJobFactory()

Method Summary

Modifier and Type	Method	Description
protected Object	createJobInstance(TriggerFiredBundle bundle)	Create the job instance, populating it with property values taken from the scheduler context, job data map and trigger data map.
protected boolean	isEligibleForPropertyPopulation(Object jobObject)	Return whether the given job object is eligible for having its bean properties populated.
void	setApplicationContext(ApplicationContext applicationContext)	Set the ApplicationContext that this object runs in.
void	setIgnoredUnknownProperties(String... ignoredUnknownProperties)	Specify the unknown properties (not found in the bean) that should be ignored.
void	setSchedulerContext(SchedulerContext schedulerContext)	Set the SchedulerContext of the current Quartz Scheduler.

Methods inherited from class org.springframework.scheduling.quartz.AdaptableJobFactory

adaptJob, newJob

Methods inherited from class java.lang.Object

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

Constructor Details

SpringBeanJobFactory

public SpringBeanJobFactory()

Method Details

setIgnoredUnknownProperties

public void setIgnoredUnknownProperties(String... ignoredUnknownProperties)

Specify the unknown properties (not found in the bean) that should be ignored.

Default is null, indicating that all unknown properties should be ignored. Specify an empty array to throw an exception in case of any unknown properties, or a list of property names that should be ignored if there is no corresponding property found on the particular job class (all other unknown properties will still trigger an exception).

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

setSchedulerContext

public void setSchedulerContext(SchedulerContext schedulerContext)

Description copied from interface: SchedulerContextAware

Set the SchedulerContext of the current Quartz Scheduler.

Specified by:

setSchedulerContext in interface SchedulerContextAware

See Also:

• Scheduler.getContext()

createJobInstance

protected Object createJobInstance(TriggerFiredBundle bundle)
                            throws Exception

Create the job instance, populating it with property values taken from the scheduler context, job data map and trigger data map.

Overrides:

createJobInstance in class AdaptableJobFactory

Parameters:

bundle - the TriggerFiredBundle from which the JobDetail and other info relating to the trigger firing can be obtained

Returns:

the job instance

Throws:

Exception - if job instantiation failed

isEligibleForPropertyPopulation

protected boolean isEligibleForPropertyPopulation(Object jobObject)

Return whether the given job object is eligible for having its bean properties populated.

The default implementation ignores QuartzJobBean instances, which will inject bean properties themselves.

Parameters:

jobObject - the job object to introspect

See Also:

• QuartzJobBean