org.springframework.scheduling.quartz: abstract public class: QuartzJobBean

org.springframework.scheduling.quartz
abstract public class: QuartzJobBean [javadoc | source]

java.lang.Object
   org.springframework.scheduling.quartz.QuartzJobBean

All Implemented Interfaces:
org.quartz.Job

Direct Known Subclasses:
StatefulMethodInvokingJob, MethodInvokingJob

Simple implementation of the Quartz Job interface, applying the passed-in JobDataMap and also the SchedulerContext as bean property values. This is appropriate because a new Job instance will be created for each execution. JobDataMap entries will override SchedulerContext entries with the same keys.

For example, let's assume that the JobDataMap contains a key "myParam" with value "5": The Job implementation can then expose a bean property "myParam" of type int to receive such a value, i.e. a method "setMyParam(int)". This will also work for complex types like business objects etc.

Note: The QuartzJobBean class itself only implements the standard Quartz org.quartz.Job interface. Let your subclass explicitly implement the Quartz org.quartz.StatefulJob interface to mark your concrete job bean as stateful.

This version of QuartzJobBean requires Quartz 1.5 or higher, due to the support for trigger-specific job data.

Note that as of Spring 2.0 and Quartz 1.5, the preferred way to apply dependency injection to Job instances is via a JobFactory: that is, to specify SpringBeanJobFactory as Quartz JobFactory (typically via SchedulerFactoryBean#setJobFactory SchedulerFactoryBean's "jobFactory" property}). This allows to implement dependency-injected Quartz Jobs without a dependency on Spring base classes.

Also see:

org.quartz.JobExecutionContext#getMergedJobDataMap()

org.quartz.Scheduler#getContext()

JobDetailBean#setJobDataAsMap

SimpleTriggerBean#setJobDataAsMap

CronTriggerBean#setJobDataAsMap

SchedulerFactoryBean#setSchedulerContextAsMap

SpringBeanJobFactory

SchedulerFactoryBean#setJobFactory

author: Juergen - Hoeller

since: 18.02.2004 -

Method from org.springframework.scheduling.quartz.QuartzJobBean Summary:
execute, executeInternal

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.springframework.scheduling.quartz.QuartzJobBean Detail:
public final void execute(JobExecutionContext context) throws JobExecutionException { try { BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this); MutablePropertyValues pvs = new MutablePropertyValues(); pvs.addPropertyValues(context.getScheduler().getContext()); pvs.addPropertyValues(context.getMergedJobDataMap()); bw.setPropertyValues(pvs, true); } catch (SchedulerException ex) { throw new JobExecutionException(ex); } executeInternal(context); } This implementation applies the passed-in job data map as bean property values, and delegates to `executeInternal` afterwards.
abstract protected void executeInternal(JobExecutionContext context) throws JobExecutionException Execute the actual job. The job data map will already have been applied as bean property values by execute. The contract is exactly the same as for the standard Quartz execute method.

Method from org.springframework.scheduling.quartz.QuartzJobBean Detail:

 public final  void execute(JobExecutionContext context) throws JobExecutionException {
		try {
			BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
			MutablePropertyValues pvs = new MutablePropertyValues();
			pvs.addPropertyValues(context.getScheduler().getContext());
			pvs.addPropertyValues(context.getMergedJobDataMap());
			bw.setPropertyValues(pvs, true);
		}
		catch (SchedulerException ex) {
			throw new JobExecutionException(ex);
		}
		executeInternal(context);
}

executeInternal

 abstract protected  void executeInternal(JobExecutionContext context) throws JobExecutionExceptionExecute the actual job. The job data map will already have been
applied as bean property values by execute. The contract is
exactly the same as for the standard Quartz execute method.