Package org.springframework.batch.core.converter

Class JsonJobParametersConverter

java.lang.Object

org.springframework.batch.core.converter.DefaultJobParametersConverter

org.springframework.batch.core.converter.JsonJobParametersConverter

All Implemented Interfaces:

JobParametersConverter

public class JsonJobParametersConverter
extends DefaultJobParametersConverter

Converter for JobParameters instances that uses a JSON naming convention for converting job parameters. The expected notation is the following:

key='{"value": "parameterStringLiteralValue", "type":"fully.qualified.name.of.the.parameter.Type", "identifying": "booleanValue"}'

where:

• value: string literal representing the value
• type (optional): fully qualified name of the type of the value. Defaults to String.
• identifying (optional): boolean to flag the job parameter as identifying or not. Defaults to true

For example, schedule.date={"value": "2022-12-12", "type":"java.time.LocalDate", "identifying": "false"} will be converted to a non identifying job parameter of type LocalDate with value "2022-12-12".

The literal values are converted to the correct type by using the default Spring conversion service, augmented if necessary by any custom converters. The conversion service should be configured with a converter to and from string literals to job parameter types.

By default, the Spring conversion service is augmented to support the conversion of the following types:

• Date: in the DateTimeFormatter.ISO_INSTANT format
• LocalDate: in the DateTimeFormatter.ISO_LOCAL_DATE format
• LocalTime: in the DateTimeFormatter.ISO_LOCAL_TIME format
• LocalDateTime: in the DateTimeFormatter.ISO_LOCAL_DATE_TIME format

Since:

5.0

Author:

Mahmoud Ben Hassine

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	JsonJobParametersConverter.JobParameterDefinition

Field Summary

Fields inherited from class org.springframework.batch.core.converter.DefaultJobParametersConverter

conversionService

Constructor Summary

Constructors

Constructor	Description
JsonJobParametersConverter()	Create a new JsonJobParametersConverter with a default ObjectMapper.
JsonJobParametersConverter(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Create a new JsonJobParametersConverter with a custom ObjectMapper.

Method Summary

Modifier and Type	Method	Description
protected JobParameter	decode(String encodedJobParameter)	Decode a job parameter from a string.
protected String	encode(JobParameter<?> jobParameter)	Encode a job parameter to a string.

Methods inherited from class org.springframework.batch.core.converter.DefaultJobParametersConverter

getJobParameters, getProperties, setConversionService

Methods inherited from class java.lang.Object

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

Constructor Details

JsonJobParametersConverter

public JsonJobParametersConverter()

Create a new JsonJobParametersConverter with a default ObjectMapper.

JsonJobParametersConverter

public JsonJobParametersConverter(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Create a new JsonJobParametersConverter with a custom ObjectMapper.

Parameters:

objectMapper - the object mapper to use

Method Details

encode

protected String encode(JobParameter<?> jobParameter)

Description copied from class: DefaultJobParametersConverter

Encode a job parameter to a string.

Overrides:

encode in class DefaultJobParametersConverter

Parameters:

jobParameter - the parameter to encode

Returns:

the encoded job parameter

decode

protected JobParameter decode(String encodedJobParameter)

Description copied from class: DefaultJobParametersConverter

Decode a job parameter from a string.

Overrides:

decode in class DefaultJobParametersConverter

Parameters:

encodedJobParameter - the encoded job parameter

Returns:

the decoded job parameter