public class

SimpleTriggerBean

extends SimpleTrigger
implements BeanNameAware InitializingBean JobDetailAwareTrigger
java.lang.Object
   ↳ SimpleTrigger
     ↳ org.springframework.scheduling.quartz.SimpleTriggerBean

Class Overview

Convenience subclass of Quartz's org.quartz.SimpleTrigger class, making bean-style usage easier.

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 org.quartz.JobDetail. This allows SchedulerFactoryBean to automatically register a trigger for the corresponding JobDetail, instead of registering the JobDetail separately.

NOTE: This convenience subclass does not work with trigger persistence in Quartz 1.6, due to a change in Quartz's trigger handling. Use Quartz 1.5 if you rely on trigger persistence based on this class, or the standard Quartz org.quartz.SimpleTrigger class instead.

See Also

Summary

Public Constructors
SimpleTriggerBean()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
JobDetail getJobDetail()
Return the JobDetail that this Trigger is associated with.
void setBeanName(String beanName)
Set the name of the bean in the bean factory that created this bean.
void setJobDataAsMap(Map jobDataAsMap)
Register objects in the JobDataMap via a given Map.
void setJobDetail(JobDetail jobDetail)
Set the JobDetail that this trigger should be associated with.
void setMisfireInstructionName(String constantName)
Set the misfire instruction via the name of the corresponding constant in the org.quartz.SimpleTrigger class.
void setStartDelay(long startDelay)
Set the delay before starting the job for the first time.
void setTriggerListenerNames(String[] names)
Set a list of TriggerListener names for this job, referring to non-global TriggerListeners registered with the Scheduler.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.beans.factory.BeanNameAware
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.scheduling.quartz.JobDetailAwareTrigger

Public Constructors

public SimpleTriggerBean ()

Public Methods

public void afterPropertiesSet ()

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.

Throws
ParseException

public JobDetail getJobDetail ()

Return the JobDetail that this Trigger is associated with.

Returns
  • the associated JobDetail, or null if none

public void setBeanName (String beanName)

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 afterPropertiesSet() or a custom init-method.

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.

public void setJobDataAsMap (Map jobDataAsMap)

Register objects in the JobDataMap via a given Map.

These objects will be available to this Trigger only, in contrast to objects in the JobDetail's data map.

Parameters
jobDataAsMap Map with String keys and any objects as values (for example Spring-managed beans)
See Also

public void setJobDetail (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
  • #setJobName
  • #setJobGroup

public void setMisfireInstructionName (String constantName)

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

See Also
  • org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_FIRE_NOW
  • org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_EXISTING_COUNT
  • org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NEXT_WITH_REMAINING_COUNT
  • org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_EXISTING_REPEAT_COUNT
  • org.quartz.SimpleTrigger#MISFIRE_INSTRUCTION_RESCHEDULE_NOW_WITH_REMAINING_REPEAT_COUNT
  • org.quartz.Trigger#MISFIRE_INSTRUCTION_SMART_POLICY

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
  • #setStartTime

public void setTriggerListenerNames (String[] names)

Set a list of TriggerListener names for this job, referring to non-global TriggerListeners registered with the Scheduler.

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

See Also