org.openhubframework.openhub.api.common.quartz

Annotation Type QuartzJob

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface QuartzJob

Defined one quartz Job with simple trigger (QuartzSimpleTrigger) or cron trigger QuartzCronTrigger.

Annotation can be added on method and this method will be called when trigger will be executed.

Every job must have at least one QuartzCronTrigger or QuartzSimpleTrigger. And one job can have one or more QuartzCronTriggers and QuartzSimpleTrigger.

In cluster mode must be set if job will be execute in all nodes (JobExecuteTypeInCluster.CONCURRENT) or only in one node (JobExecuteTypeInCluster.NOT_CONCURRENT) at the same time.

Example:

  @QuartzJob(name = "jobName", group = "groupName", executeTypeInCluster = JobExecuteTypeInCluster.CONCURRENT,
      simpleTriggers = @QuartzSimpleTrigger(repeatIntervalMillis = 1000))
 public final void invokeJob() throws Exception {

 }
 

This example show that will be create job with group groupName and name jobName and method invokeJob will be called every 1000 millis in all nodes in cluster.

Since:

2.0

Author:

Roman Havlicek

See Also:

QuartzSimpleTrigger, QuartzCronTrigger, JobExecuteTypeInCluster, CronTriggerMisfireInstruction, SimpleTriggerMisfireInstruction, SimpleTriggerPropertyUnit

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
JobExecuteTypeInCluster	executeTypeInCluster Gets execute type in cluster mode.
String	group Job group name.
String	name Job name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
QuartzCronTrigger[]	cronTriggers All cron triggers definition for this job.
String	description Job description.
QuartzSimpleTrigger[]	simpleTriggers All simple triggers definition for this job.
boolean	stateful Uses a Quartz DisallowConcurrentExecution instead of the default job.

Element Detail

group

public abstract String group

Job group name.

Returns:

group name

name

public abstract String name

Job name.

Returns:

name

executeTypeInCluster

public abstract JobExecuteTypeInCluster executeTypeInCluster

Gets execute type in cluster mode.

Returns:

execute type in cluster mode

description

public abstract String description

Job description.

Returns:

description

Default:

""

stateful

public abstract boolean stateful

Uses a Quartz DisallowConcurrentExecution instead of the default job.

Returns:

true uses DisallowConcurrentExecution, false - otherwise

Default:

false

cronTriggers

public abstract QuartzCronTrigger[] cronTriggers

All cron triggers definition for this job.

Returns:

cron triggers

Default:

{}

simpleTriggers

public abstract QuartzSimpleTrigger[] simpleTriggers

All simple triggers definition for this job.

Returns:

simple triggers

Default:

{}