com.gruelbox.transactionoutbox.InvocationSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of transactionoutbox-core Show documentation

A safe implementation of the transactional outbox pattern for Java (core library)

There is a newer version: 6.0.553

Show newest version

package com.gruelbox.transactionoutbox;

import java.io.Reader;
import java.io.Writer;

/**
 * {@link Invocation} objects are inherently difficult to serialize safely since they are
 * unpredictably polymorphic. Allowing them to contain any type reference opens you up to a
 * host of code injection attacks. At the same time, allowing possibly-unstable types into
 * serialized {@link Invocation}s can result in compatibility issues, with still unprocessed entries
 * in the database containing older versions of your classes. To avoid this, it makes sense to
 * specify the types supported and restrict this set of serializable classes to known-stable types
 * such as primitives and common JDK value types. {@link #createDefaultJsonSerializer()} provides
 * exactly this and is used by default. However, if you want to extend this list or use a different
 * serialization format, you can create your own implementation here, at your own risk.
 */
public interface InvocationSerializer {

  /**
   * Creates a locked-down serializer which supports a limited list of primitives and simple JDK
   * value types. Shortcut to {@link DefaultInvocationSerializer}.
   *
   * @return The serializer.
   */
  static InvocationSerializer createDefaultJsonSerializer() {
    return DefaultInvocationSerializer.builder().build();
  }

  /**
   * Serializes an invocation to the supplied writer.
   *
   * @param invocation The invocation.
   * @param writer The writer.
   */
  void serializeInvocation(Invocation invocation, Writer writer);

  /**
   * Deserializes an invocation from the supplied reader.
   *
   * @param reader The reader.
   * @return The deserialized invocation.
   */
  Invocation deserializeInvocation(Reader reader);
}