Package org.apache.flink.runtime.state.ttl

Class TtlAwareSerializer<T,S extends org.apache.flink.api.common.typeutils.TypeSerializer<T>>

java.lang.Object

org.apache.flink.api.common.typeutils.TypeSerializer<T>

org.apache.flink.runtime.state.ttl.TtlAwareSerializer<T,S>

Type Parameters:

T - The data type that the serializer serializes.

S - The original serializer the TtlAwareSerializer wraps.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TtlAwareSerializer.TtlAwareListSerializer, TtlAwareSerializer.TtlAwareMapSerializer

public class TtlAwareSerializer<T,S extends org.apache.flink.api.common.typeutils.TypeSerializer<T>>
extends org.apache.flink.api.common.typeutils.TypeSerializer<T>

This class wraps a TypeSerializer with ttl awareness. It will return true when the wrapped TypeSerializer is instance of TtlStateFactory.TtlSerializer. Also, it wraps the value migration process between TtlSerializer and non-ttl typeSerializer.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TtlAwareSerializer.TtlAwareListSerializer<T>	The list version of TtlAwareSerializer.
static class	TtlAwareSerializer.TtlAwareMapSerializer<K,V>	The map version of TtlAwareSerializer.

Constructor Summary

Constructors

Constructor	Description
TtlAwareSerializer(S typeSerializer)
TtlAwareSerializer(S typeSerializer, boolean isTtlEnabled)

Method Summary

Modifier and Type	Method	Description
void	copy(org.apache.flink.core.memory.DataInputView source, org.apache.flink.core.memory.DataOutputView target)
T	copy(T from)
T	copy(T from, T reuse)
T	createInstance()
T	deserialize(org.apache.flink.core.memory.DataInputView source)
T	deserialize(T reuse, org.apache.flink.core.memory.DataInputView source)
org.apache.flink.api.common.typeutils.TypeSerializer<T>	duplicate()
boolean	equals(Object o)
int	getLength()
S	getOriginalTypeSerializer()
int	hashCode()
boolean	isImmutableType()
static boolean	isSerializerTtlEnabled(org.apache.flink.api.common.typeutils.TypeSerializer<?> typeSerializer)
boolean	isTtlEnabled()
void	migrateValueFromPriorSerializer(TtlAwareSerializer<T,?> priorTtlAwareSerializer, org.apache.flink.util.function.SupplierWithException<T,IOException> inputSupplier, org.apache.flink.core.memory.DataOutputView target, TtlTimeProvider ttlTimeProvider)
static boolean	needTtlStateMigration(org.apache.flink.api.common.typeutils.TypeSerializer<?> previousSerializer, org.apache.flink.api.common.typeutils.TypeSerializer<?> newSerializer)
void	serialize(T record, org.apache.flink.core.memory.DataOutputView target)
org.apache.flink.api.common.typeutils.TypeSerializerSnapshot<T>	snapshotConfiguration()
static TtlAwareSerializer<?,?>	wrapTtlAwareSerializer(org.apache.flink.api.common.typeutils.TypeSerializer<?> typeSerializer)

Methods inherited from class java.lang.Object

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

Constructor Detail

TtlAwareSerializer

public TtlAwareSerializer(S typeSerializer)

TtlAwareSerializer

public TtlAwareSerializer(S typeSerializer,
                          boolean isTtlEnabled)

Method Detail

isImmutableType

public boolean isImmutableType()

Specified by:

isImmutableType in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

duplicate

public org.apache.flink.api.common.typeutils.TypeSerializer<T> duplicate()

Specified by:

duplicate in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

createInstance

public T createInstance()

Specified by:

createInstance in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

copy

public T copy(T from)

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

copy

public T copy(T from,
              T reuse)

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

getLength

public int getLength()

Specified by:

getLength in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

serialize

public void serialize(T record,
                      org.apache.flink.core.memory.DataOutputView target)
               throws IOException

Specified by:

serialize in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

Throws:

IOException

deserialize

public T deserialize(org.apache.flink.core.memory.DataInputView source)
              throws IOException

Specified by:

deserialize in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

Throws:

IOException

deserialize

public T deserialize(T reuse,
                     org.apache.flink.core.memory.DataInputView source)
              throws IOException

Specified by:

deserialize in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

Throws:

IOException

equals

public boolean equals(Object o)

Specified by:

equals in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

hashCode

public int hashCode()

Specified by:

hashCode in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

migrateValueFromPriorSerializer

public void migrateValueFromPriorSerializer(TtlAwareSerializer<T,?> priorTtlAwareSerializer,
                                            org.apache.flink.util.function.SupplierWithException<T,IOException> inputSupplier,
                                            org.apache.flink.core.memory.DataOutputView target,
                                            TtlTimeProvider ttlTimeProvider)
                                     throws IOException

Throws:

IOException

copy

public void copy(org.apache.flink.core.memory.DataInputView source,
                 org.apache.flink.core.memory.DataOutputView target)
          throws IOException

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

Throws:

IOException

isTtlEnabled

public boolean isTtlEnabled()

getOriginalTypeSerializer

public S getOriginalTypeSerializer()

snapshotConfiguration

public org.apache.flink.api.common.typeutils.TypeSerializerSnapshot<T> snapshotConfiguration()

Specified by:

snapshotConfiguration in class org.apache.flink.api.common.typeutils.TypeSerializer<T>

isSerializerTtlEnabled

public static boolean isSerializerTtlEnabled(org.apache.flink.api.common.typeutils.TypeSerializer<?> typeSerializer)

needTtlStateMigration

public static boolean needTtlStateMigration(org.apache.flink.api.common.typeutils.TypeSerializer<?> previousSerializer,
                                            org.apache.flink.api.common.typeutils.TypeSerializer<?> newSerializer)

wrapTtlAwareSerializer

public static TtlAwareSerializer<?,?> wrapTtlAwareSerializer(org.apache.flink.api.common.typeutils.TypeSerializer<?> typeSerializer)