com.microsoft.durabletask.DataConverter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of durabletask-client Show documentation

This package contains classes and interfaces for building Durable Task orchestrations in Java.

There is a newer version: 1.5.0

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.microsoft.durabletask;

import com.google.protobuf.Timestamp;

import javax.annotation.Nullable;
import java.time.Instant;
import java.time.temporal.ChronoUnit;

/**
 * Interface for serializing and deserializing data that gets passed to and from orchestrators and activities.
 * 
 * Implementations of this abstract class are free to use any serialization method. Currently, only strings are
 * supported as the serialized representation of data. Byte array payloads and streams are not supported by this
 * abstraction. Note that these methods all accept null values, in which case the return value should also be null.
 */
public interface DataConverter {
    /**
     * Serializes the input into a text representation.
     *
     * @param value the value to be serialized
     * @return a serialized text representation of the value or null if the value is null
     */
    @Nullable
    String serialize(@Nullable Object value);

    /**
     * Deserializes the given text data into an object of the specified type.
     *
     * @param data the text data to deserialize into an object
     * @param target the target class to deserialize the input into
     * @param  the generic parameter type representing the target class to deserialize the input into
     * @return a deserialized object of type T
     * @throws DataConverterException if the text data cannot be deserialized
     */
    @Nullable
     T deserialize(@Nullable String data, Class target);

    // Data conversion errors are expected to be unrecoverable in most cases, hence an unchecked runtime exception
    class DataConverterException extends RuntimeException {
        public DataConverterException(String message, Throwable cause) {
            super(message, cause);
        }
    }

    static Instant getInstantFromTimestamp(Timestamp ts) {
        if (ts == null) {
            return null;
        }

        // We don't include nanoseconds because of serialization round-trip issues
        return Instant.ofEpochSecond(ts.getSeconds(), ts.getNanos()).truncatedTo(ChronoUnit.MILLIS);
    }

    static Timestamp getTimestampFromInstant(Instant instant) {
        if (instant == null) {
            return null;
        }

        return Timestamp.newBuilder()
                .setSeconds(instant.getEpochSecond())
                .setNanos(instant.getNano())
                .build();
    }
}