org.jooby.quartz

Class Quartz

java.lang.Object

org.jooby.quartz.Quartz

All Implemented Interfaces:

Jooby.Module

public class Quartz
extends Object
implements Jooby.Module

Build and create a Quartz Scheduler and jobs.

usage

  {
    use(new Quartz().with(MyJob.class));
  }
 

Previous example will startup Quartz and schedule MyJob.

jobs

A job can implement the Job interface as described in the Quartz documentation

If you prefer to not implement the Job interface, all you have to do is to annotated a method with the Scheduled annotation.

By default, job name is set the class name or to the method name. Default group is set to the package name of the job class.

job methods

A job method must follow this rules:

• It must be a public method
• Without a return value
• Have ZERO arguments
• or just ONE argument of type JobExecutionContext

The next section will you show how to add a trigger to a job and some examples too.

triggers

Trigger are defined by the Scheduled annotation. The annotation defines a single and required attribute, which is basically a trigger expression or a reference to one.

Examples:

Run every 5 minutes, start immediately and repeat for ever:

 @Scheduled("5m")

 @Scheduled("5m; delay=0")

 @Scheduled("5m; delay=0; repeat=*")
 

Previous, expressions are identical.

Run every 1 hour with an initial delay of 15 minutes for 10 times

 @Scheduled("1h; delay=15m; repeat=10")
 

Fire at 12pm (noon) every day

 0 0 12 * * ?
 

Fire at 10:15am every day

 0 15 10 ? * *
 

grouping jobs together

If you have two or more jobs doing something similar, it is possible to group all them into one single class:

  public class MyJobs {
    @Scheduled("5minutes")
    public void job1() {
      ...
    }

    @Scheduled("1h")
    public void job2() {
      ...
    }
  }
 

dependency injection

Not much to add here, just let you know jobs are created by Guice.

  public class MyJob {

    private A a;

    @Inject
    public MyJob(A a) {
      this.a = a;
    }

    @Scheduled("5minutes")
    public void doWork() {
      this.a.doWork();
    }
  }
 

Injecting a Scheduler

  public class MyJobManager {

    private Scheduler scheduler;

    @Inject
    public MyJobManager(Scheduler scheduler) {
      this.scheduler = scheduler;
    }
  }
 

configuration

Example: Setting max number of threads

  # application.conf
  org.quartz.threadPool.threadCount = 1 # default is number of available processors
 

Configuration follows the Quartz documentation. The only difference is that you need to put add the properties on your *.conf file, NOT in a custom quartz.properties file.

jdbc store

Jdbc Store is fully supported but it depends on the jooby-jdbc module. So, in order to use the Jdbc Store you need to follow these steps:

1. Install the Jdbc module:

 {
   use(new Jdbc());
   use(new Quartz(MyJob.class));
 }
 

2. Set the quartz properties:

  org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
  org.quartz.jobStore.driverDelegateClass = org.quartz.impl.jdbcjobstore.StdJDBCDelegate
  org.quartz.jobStore.dataSource = db
 

adding jobs programmatically

When Scheduled isn't not enough and/or if you prefer to build jobs manually, you can try one of the available alternatives.

Example 1: build the trigger and use default job naming

   {
     use(new Quartz()
      .with(MyJob.class, trigger  -> {
        trigger
          .withSchedule(withIntervalInDays(3))
          .startAt(futureDate(10, MINUTES));
      })
     );
   }
 

Example 2: build the job, the trigger and use default job naming

   {
     use(new Quartz()
      .with(MyJob.class, (job, trigger)  -> {
        job.withDescription("etc...");

        trigger
          .withSchedule(withIntervalInDays(3))
          .startAt(futureDate(10, MINUTES));
      })
     );
   }
 

Example 3: build and set everything from scratch

   {
     use(new Quartz()
      .with(
        newJob(MyJob.class).withDescription("etc...")
          .build(),
        newTrigger()
          .withSchedule(withIntervalInDays(3))
          .startAt(futureDate(10, MINUTES))
          .build()
      })
     );
   }
 

Enjoy it!

Since:

0.5.0

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Quartz(Class<?>... jobs) Creates a new Quartz module.

Method Summary

Modifier and Type	Method and Description
com.typesafe.config.Config	config()
void	configure(Env env, com.typesafe.config.Config config, com.google.inject.Binder binder)
Quartz	with(Class<?> jobClass) Setup and schedule the provided job, it might implement a Job and the Scheduled annotation must be present.
Quartz	with(Class<? extends org.quartz.Job> jobClass, BiConsumer<org.quartz.JobBuilder,org.quartz.TriggerBuilder<org.quartz.Trigger>> configurer) Schedule the provided job and trigger.
Quartz	with(Class<? extends org.quartz.Job> jobClass, Consumer<org.quartz.TriggerBuilder<org.quartz.Trigger>> configurer) Schedule the provided job and trigger.
Quartz	with(org.quartz.JobDetail job, org.quartz.Trigger trigger) Schedule the provided job and trigger.

Methods inherited from class java.lang.Object

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

Constructor Detail

Quartz

public Quartz(Class<?>... jobs)

Creates a new Quartz module. Optionally add some jobs.

Parameters:

jobs - Jobs to setup. Optional.

See Also:

with(Class)

Method Detail

with

public Quartz with(org.quartz.JobDetail job,
                   org.quartz.Trigger trigger)

Schedule the provided job and trigger.

Parameters:

job - A job to schedule.

trigger - A trigger for provided job.

Returns:

This quartz instance.

with

public Quartz with(Class<?> jobClass)

Setup and schedule the provided job, it might implement a Job and the Scheduled annotation must be present.

Parameters:

jobClass - A jobClass to setup and schedule.

Returns:

This quartz instance.

with

public Quartz with(Class<? extends org.quartz.Job> jobClass,
                   BiConsumer<org.quartz.JobBuilder,org.quartz.TriggerBuilder<org.quartz.Trigger>> configurer)

Schedule the provided job and trigger. This method will setup a default name and group for both.

Parameters:

jobClass - A jobClass to setup and schedule.

configurer - A callback to setup the job and trigger.

Returns:

This quartz instance.

with

public Quartz with(Class<? extends org.quartz.Job> jobClass,
                   Consumer<org.quartz.TriggerBuilder<org.quartz.Trigger>> configurer)

Schedule the provided job and trigger. This method will setup a default name and group for both.

Parameters:

jobClass - A jobClass to setup and schedule.

configurer - A callback to setup the trigger.

Returns:

This quartz instance.

configure

public void configure(Env env,
                      com.typesafe.config.Config config,
                      com.google.inject.Binder binder)

Specified by:

configure in interface Jooby.Module

config

public com.typesafe.config.Config config()

Specified by:

config in interface Jooby.Module