io.camunda.zeebe.protocol.jackson.ZeebeProtocolModule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of zeebe-protocol-jackson Show documentation

There is a newer version: 8.7.0-alpha3

Show newest version

/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH under
 * one or more contributor license agreements. See the NOTICE file distributed
 * with this work for additional information regarding copyright ownership.
 * Licensed under the Zeebe Community License 1.1. You may not use this file
 * except in compliance with the Zeebe Community License 1.1.
 */
package io.camunda.zeebe.protocol.jackson;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import io.camunda.zeebe.protocol.record.ImmutableRecord;
import io.camunda.zeebe.protocol.record.Record;
import io.camunda.zeebe.protocol.record.value.ImmutableCommandDistributionRecordValue;

/**
 * A Jackson module which enables your {@link ObjectMapper} to serialize and deserialize Zeebe
 * protocol objects, e.g. {@link Record}, {@link
 * io.camunda.zeebe.protocol.record.value.ErrorRecordValue}, etc., essentially anything annotated
 * with {@link io.camunda.zeebe.protocol.record.ImmutableProtocol}, out of the box.
 *
 * To use, simply create an {@link ObjectMapper} as you normally would, and add this module.
 *
 * Usage
 *
 * {@code
 * 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);
 * }
 */
public final class ZeebeProtocolModule extends SimpleModule {
  public ZeebeProtocolModule() {
    setMixInAnnotation(ImmutableRecord.Builder.class, RecordMixin.class);
    setMixInAnnotation(ImmutableCommandDistributionRecordValue.Builder.class, RecordMixin.class);
  }

  @Override
  public void setupModule(final SetupContext context) {
    super.setupModule(context);
    context.insertAnnotationIntrospector(new AnnotationIntrospector());
  }
}