Package io.temporal.common.converter

Class Jackson3JsonPayloadConverter

java.lang.Object

io.temporal.common.converter.Jackson3JsonPayloadConverter

All Implemented Interfaces:

PayloadConverter

@Experimental
public class Jackson3JsonPayloadConverter
extends java.lang.Object
implements PayloadConverter

A PayloadConverter that uses Jackson 3.x for JSON serialization/deserialization. This converter uses the same "json/plain" encoding type as JacksonJsonPayloadConverter, making it wire-compatible.

This is a stub for Java versions prior to 17. On Java 17+ with Jackson 3.x on the classpath, the real implementation is loaded automatically via the multi-release JAR mechanism.

Requires Java 17+ and tools.jackson.core:jackson-databind:3.x on the classpath.

See Also:

JacksonJsonPayloadConverter.setDefaultAsJackson3(boolean, boolean)

Constructor Summary

Constructors

Constructor	Description
Jackson3JsonPayloadConverter()
Jackson3JsonPayloadConverter(boolean jackson2Compat)

Method Summary

Modifier and Type	Method	Description
<T> T	fromData(io.temporal.api.common.v1.Payload content, java.lang.Class<T> valueType, java.lang.reflect.Type valueGenericType)	Implements conversion of a single value.
java.lang.String	getEncodingType()	Each PayloadConverter has an Encoding Type that it handles.
java.util.Optional<io.temporal.api.common.v1.Payload>	toData(java.lang.Object value)	Implements conversion of a list of values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.temporal.common.converter.PayloadConverter

withContext

Constructor Detail

Jackson3JsonPayloadConverter

public Jackson3JsonPayloadConverter()

Jackson3JsonPayloadConverter

public Jackson3JsonPayloadConverter(boolean jackson2Compat)

Method Detail

getEncodingType

public java.lang.String getEncodingType()

Description copied from interface: PayloadConverter

Each PayloadConverter has an Encoding Type that it handles. Each PayloadConverter should add the information about its Encoding Type into the Payload it produces inside PayloadConverter.toData(Object) by associating it with the EncodingKeys.METADATA_ENCODING_KEY key attached to the Payload's Metadata using Payload.Builder.putMetadata(String, ByteString).

Specified by:

getEncodingType in interface PayloadConverter

Returns:

encoding type that this converter handles.

toData

public java.util.Optional<io.temporal.api.common.v1.Payload> toData(java.lang.Object value)
                                                             throws DataConverterException

Description copied from interface: PayloadConverter

Implements conversion of a list of values.

Specified by:

toData in interface PayloadConverter

Parameters:

value - Java value to convert.

Returns:

converted value

Throws:

DataConverterException - if conversion of the value passed as parameter failed for any reason.

See Also:

getEncodingType javadoc for an important implementation detail

fromData

public <T> T fromData(io.temporal.api.common.v1.Payload content,
                      java.lang.Class<T> valueType,
                      java.lang.reflect.Type valueGenericType)
               throws DataConverterException

Description copied from interface: PayloadConverter

Implements conversion of a single value.

Specified by:

fromData in interface PayloadConverter

Parameters:

content - Serialized value to convert to a Java object.

valueType - type of the value stored in the content

valueGenericType - generic type of the value stored in the content

Returns:

converted Java object

Throws:

DataConverterException - if conversion of the data passed as parameter failed for any reason.