org.springframework.scheduling.quartz
Class SimpleTriggerBean

java.lang.Object
  org.quartz.Trigger
      org.quartz.SimpleTrigger
          org.springframework.scheduling.quartz.SimpleTriggerBean

All Implemented Interfaces:

BeanNameAware, java.lang.Cloneable, java.lang.Comparable, InitializingBean, JobDetailAwareTrigger, java.io.Serializable

public class SimpleTriggerBean

extends org.quartz.SimpleTrigger

implements JobDetailAwareTrigger, BeanNameAware, InitializingBean

Convenience subclass of Quartz' SimpleTrigger class that eases bean-style usage.

SimpleTrigger itself is already a JavaBean but lacks sensible defaults. This class uses the Spring bean name as job name, the Quartz default group ("DEFAULT") as job group, the current time as start time, and indefinite repetition, if not specified.

This class will also register the trigger with the job name and group of a given JobDetail. This allows SchedulerFactoryBean to automatically register a trigger for the respective JobDetail, instead of registering the JobDetail separately.

Since:

18.02.2004

Author:

Juergen Hoeller

See Also:

Trigger.setName(java.lang.String), Trigger.setGroup(java.lang.String), SimpleTrigger.setStartTime(java.util.Date), Trigger.setJobName(java.lang.String), Trigger.setJobGroup(java.lang.String), setJobDetail(org.quartz.JobDetail), SchedulerFactoryBean.setTriggers(org.quartz.Trigger[]), SchedulerFactoryBean.setJobDetails(org.quartz.JobDetail[]), Serialized Form

Field Summary

Fields inherited from class org.quartz.SimpleTrigger

MISFIRE_INSTRUCTION_FIRE_NOW, MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT, MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT, MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT, MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT, REPEAT_INDEFINITELY

Fields inherited from class org.quartz.Trigger

INSTRUCTION_DELETE_TRIGGER, INSTRUCTION_NOOP, INSTRUCTION_RE_EXECUTE_JOB, INSTRUCTION_SET_ALL_JOB_TRIGGERS_COMPLETE, INSTRUCTION_SET_TRIGGER_COMPLETE, MISFIRE_INSTRUCTION_SMART_POLICY, STATE_COMPLETE, STATE_ERROR, STATE_NONE, STATE_NORMAL, STATE_PAUSED

Constructor Summary

SimpleTriggerBean()

Method Summary

void	afterPropertiesSet() Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
org.quartz.JobDetail	getJobDetail() Return the JobDetail that this Trigger is associated with.
void	setBeanName(java.lang.String beanName) Set the name of the bean in the bean factory that created this bean.
void	setJobDetail(org.quartz.JobDetail jobDetail) Set the JobDetail that this trigger should be associated with.
void	setMisfireInstructionName(java.lang.String constantName) Set the misfire instruction via the name of the corresponding constant in the SimpleTrigger class.
void	setStartDelay(long startDelay) Set the delay before starting the job for the first time.

Methods inherited from class org.quartz.SimpleTrigger

computeFirstFireTime, computeNumTimesFiredBetween, executionComplete, getEndTime, getFinalFireTime, getFireTimeAfter, getFireTimeBefore, getNextFireTime, getPreviousFireTime, getRepeatCount, getRepeatInterval, getStartTime, getTimesTriggered, main, mayFireAgain, setEndTime, setNextFireTime, setPreviousFireTime, setRepeatCount, setRepeatInterval, setStartTime, setTimesTriggered, triggered, updateAfterMisfire, validate, validateMisfireInstruction

Methods inherited from class org.quartz.Trigger

addTriggerListener, clone, compareTo, equals, getCalendarName, getDescription, getFireInstanceId, getFullJobName, getFullName, getGroup, getJobGroup, getJobName, getMisfireInstruction, getName, getTriggerListenerNames, isVolatile, removeTriggerListener, setCalendarName, setDescription, setFireInstanceId, setGroup, setJobGroup, setJobName, setMisfireInstruction, setName, setVolatility, toString

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SimpleTriggerBean

public SimpleTriggerBean()

Method Detail

setJobDetail

public void setJobDetail(org.quartz.JobDetail jobDetail)

Set the JobDetail that this trigger should be associated with.

This is typically used with a bean reference if the JobDetail is a Spring-managed bean. Alternatively, the trigger can also be associated with a job by name and group.

See Also:

Trigger.setJobName(java.lang.String), Trigger.setJobGroup(java.lang.String)

getJobDetail

public org.quartz.JobDetail getJobDetail()

Description copied from interface: JobDetailAwareTrigger

Return the JobDetail that this Trigger is associated with.

Specified by:

getJobDetail in interface JobDetailAwareTrigger

Returns:

the associated JobDetail, or null if none

setStartDelay

public void setStartDelay(long startDelay)

Set the delay before starting the job for the first time. The given number of milliseconds will be added to the current time to calculate the start time. Default is 0.

This delay will just be applied if no custom start time was specified. However, in typical usage within a Spring context, the start time will be the container startup time anyway. Specifying a relative delay is appropriate in that case.

See Also:

SimpleTrigger.setStartTime(java.util.Date)

setMisfireInstructionName

public void setMisfireInstructionName(java.lang.String constantName)

Set the misfire instruction via the name of the corresponding constant in the SimpleTrigger class. Default is MISFIRE_INSTRUCTION_SMART_POLICY.

See Also:

SimpleTrigger.MISFIRE_INSTRUCTION_FIRE_NOW, Trigger.MISFIRE_INSTRUCTION_SMART_POLICY

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 like InitializingBean's afterPropertiesSet or a custom init-method.

Specified by:

setBeanName in interface BeanNameAware

Parameters:

beanName - the name of the bean in the factory

afterPropertiesSet

public void afterPropertiesSet()
                        throws java.text.ParseException

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

Throws:

java.text.ParseException