Package io.camunda.zeebe.protocol.jackson

Class ZeebeProtocolModule

java.lang.Object
com.fasterxml.jackson.databind.Module
com.fasterxml.jackson.databind.module.SimpleModule
io.camunda.zeebe.protocol.jackson.ZeebeProtocolModule
All Implemented Interfaces:
com.fasterxml.jackson.core.Versioned, Serializable
public final class ZeebeProtocolModule extends com.fasterxml.jackson.databind.module.SimpleModule
A Jackson module which enables your ObjectMapper to serialize and deserialize Zeebe protocol objects, e.g. Record, ErrorRecordValue, etc., essentially anything annotated with ImmutableProtocol, out of the box.

To use, simply create an ObjectMapper as you normally would, and add this module.

Usage 

 ObjectMapper mapper = new ObjectMapper();
 ZeebeProtocolModule module = new ZeebeProtocolModule();
 mapper.registerModule(module);

 Record<?> record = mapper.readValue(myJsonString, Record.class);
 ErrorRecordValue errorValue = mapper.readValue(myErrorJsonString, ErrorRecordValue.class);

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.Module

    com.fasterxml.jackson.databind.Module.SetupContext

  • Field Summary

    Fields inherited from class com.fasterxml.jackson.databind.module.SimpleModule

    _abstractTypes, _deserializerModifier, _deserializers, _hasExplicitName, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version

  • Constructor Summary

    Constructors
    Constructor
    Description
    ZeebeProtocolModule()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
     

    Methods inherited from class com.fasterxml.jackson.databind.module.SimpleModule

    _checkNotNull, addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getModuleName, getTypeId, registerSubtypes, registerSubtypes, registerSubtypes, setAbstractTypes, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setValueInstantiators, version

    Methods inherited from class com.fasterxml.jackson.databind.Module

    getDependencies

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ZeebeProtocolModule

      public ZeebeProtocolModule()

  • Method Details

    • setupModule

      public void setupModule(com.fasterxml.jackson.databind.Module.SetupContext context)
      Overrides:
      setupModule in class com.fasterxml.jackson.databind.module.SimpleModule