Installation

Important

All your servers must run the same version of your code! If your webapp server has a newer version with a method signature that is not compatible with the server that processes your background jobs, a NoSuchMethod Exception will be thrown and job processing will fail!

Requirements

JobRunr works with Java 8 and up - You can integrate it with Spring framework, use it in Tomcat or any other Java framework.

When you depend on JobRunr via Maven or Gradle, the following dependencies are required:

• JobRunr itself
• ASM
• A JSON serialization library (Jackson, Gson, JSON-B, or Kotlin Serialization)
• SLF4J

JobRunr is distributed as a standard java jar which is available on Maven Central. You can add these jars easily with either Maven or Gradle as follows:

<dependency>
    <groupId>org.jobrunr</groupId>
    <artifactId>jobrunr</artifactId>
    <version>${jobrunr.version}</version>
</dependency>
<!-- Add a JSON library, you can use either Jackson, Gson,
 Yasson (JSON-B compatible) or Kotlin Serialization. -->

implementation 'org.jobrunr:jobrunr:${jobrunr.version}'
// Add a JSON library, you can use either Jackson, Gson,
//  Yasson (JSON-B compatible) or Kotlin Serialization.

Note

For JSON serialization library installation and configuration, see the Serialization documentation. JobRunr supports Jackson 2, Jackson 3, Gson, JSON-B, and Kotlin Serialization.