Spring Boot Starter

Integration with Spring cannot be easier using the jobrunr-spring-boot-starter!

Add the dependency to the starter

As the jobrunr-spring-boot-starter is available in Maven Central, all you need to do is add this dependency:

Maven

<dependency> 
    <groupId>org.jobrunr</groupId> 
    <artifactId>jobrunr-spring-boot-starter</artifactId> 
    <version>${jobrunr.version}</version> 
</dependency>

Gradle

implementation 'org.jobrunr:jobrunr-spring-boot-starter:${jobrunr.version}'

Do note that if you are not working in a web environment, you also need to add either Jackson, Gson or Yasson for Json serialization. See the installation page for more info.

Configure JobRunr

JobRunr can be configured easily in your application.properties. If you only want to schedule jobs, you don’t need to do anything. If you want to have a BackgroundJobServer to process background jobs or the dashboard enabled, just add the following properties to the application.properties:

org.jobrunr.background-job-server.enabled=true
org.jobrunr.dashboard.enabled=true

These are disabled by default so that your web application does not start processing jobs by accident.

The jobrunr-spring-boot-starter will try to either use an existing DataSource bean for relational databases or it will use one of the provided NoSQL client beans (like MongoClient for MongoDB, RestHighLevelClient for ElasticSearch and JedisPool or RedisClient for Redis).
If no such bean is defined, you will either need to define it or create a StorageProvider bean yourself.

Advanced Configuration

Every aspect of JobRunr can be configured via the application.properties. Below you will find all settings including their default value.

org.jobrunr.job-scheduler.enabled=true
org.jobrunr.background-job-server.enabled=false
org.jobrunr.background-job-server.worker_count=8 #this value normally is defined by the amount of CPU's that are available
org.jobrunr.background-job-server.poll_interval=15 #check for new work every 15 seconds
org.jobrunr.background-job-server.delete_succeeded_jobs_after=36 #succeeded jobs will go to the deleted state after 36 hours
org.jobrunr.background-job-server.permanently_delete_deleted_jobs_after=72 #deleted jobs will be deleted permanently after 72 hours
org.jobrunr.dashboard.enabled=false
org.jobrunr.dashboard.port=8000 #the port on which to start the dashboard