JSON-B

JSON-B (Jakarta JSON Binding) is the Jakarta EE standard for JSON serialization, providing a portable API across different implementations. JobRunr supports JSON-B through the JsonbJsonMapper implementation, tested against the Yasson reference implementation.

Installation

Add a JSON-B compatible serialization library to your project dependencies. Below is an example for Yasson.

Maven

<dependency>
  <groupId>org.eclipse</groupId>
  <artifactId>yasson</artifactId>
  <version><!-- latest version --></version>
</dependency>

Gradle

implementation 'org.eclipse:yasson' // version omitted, use latest

Other JSON-B implementations may work as well, but JobRunr’s support is primarily tested against Yasson.

Usage

JobRunr automatically detects JSON-B on your classpath and uses it for serialization. When multiple JSON libraries are available, JSON-B has the lowest priority in the detection hierarchy.

If auto-detection doesn’t work, you can manually configure it:

JobRunr.configure()
  .useJsonMapper(new JsonbJsonMapper())
  //...
  .initialize();

Or when using a supported framework, define a JsonMapper bean. Example for Spring (can easily be adapted for other frameworks):

import org.jobrunr.utils.mapper.JsonMapper;

@Bean
public JsonMapper jsonMapper() {
  return new JsonbJsonMapper();
}

Custom JSON-B configuration

Customize JSON-B by creating your own JsonbJsonMapper instance with a configured JsonbConfig.

Before proceeding, note that JobRunr may overwrite your custom configuration. Verify through testing that everything behaves as expected.

Using JsonbConfig

Pass a configured JsonbConfig to customize serialization behavior:

var jsonbConfig = new JsonbConfig()
  .withDeserializers(new MyCustomTypeDeserializer());

var jsonMapper = new JsonbJsonMapper(jsonbConfig);

When using a supported framework, overwrite JobRunr’s JsonMapper bean. Example for Spring (can easily be adapted for other frameworks):

import org.jobrunr.utils.mapper.JsonMapper;

@Bean
public JsonMapper jsonMapper() {
  var jsonbConfig = new JsonbConfig()
    .withDeserializers(new MyCustomTypeDeserializer());

  return new JsonbJsonMapper(jsonbConfig);
}