org.apache.flink.api.common.typeutils

Class TypeSerializerSerializationUtil

java.lang.Object

org.apache.flink.api.common.typeutils.TypeSerializerSerializationUtil

@Internal
public class TypeSerializerSerializationUtil
extends Object

Utility methods for serialization of TypeSerializer and TypeSerializerConfigSnapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TypeSerializerSerializationUtil.TypeSerializerSerializationProxy<T> Utility serialization proxy for a TypeSerializer.

Constructor Summary

Constructors

Constructor and Description
TypeSerializerSerializationUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static TypeSerializerConfigSnapshot	readSerializerConfigSnapshot(DataInputView in, ClassLoader userCodeClassLoader) Reads from a data input view a TypeSerializerConfigSnapshot that was previously written using writeSerializerConfigSnapshot(DataOutputView, TypeSerializerConfigSnapshot).
static TypeSerializerConfigSnapshot[]	readSerializerConfigSnapshots(DataInputView in, ClassLoader userCodeClassLoader) Reads from a data input view multiple TypeSerializerConfigSnapshots that was previously written using writeSerializerConfigSnapshot(DataOutputView, TypeSerializerConfigSnapshot).
static List<Tuple2<TypeSerializer<?>,TypeSerializerConfigSnapshot>>	readSerializersAndConfigsWithResilience(DataInputView in, ClassLoader userCodeClassLoader) Reads from a data input view a list of serializers and their corresponding config snapshots written using writeSerializersAndConfigsWithResilience(DataOutputView, List).
static <T> TypeSerializer<T>	tryReadSerializer(DataInputView in, ClassLoader userCodeClassLoader) Reads from a data input view a TypeSerializer that was previously written using writeSerializer(DataOutputView, TypeSerializer).
static <T> TypeSerializer<T>	tryReadSerializer(DataInputView in, ClassLoader userCodeClassLoader, boolean useDummyPlaceholder) Reads from a data input view a TypeSerializer that was previously written using writeSerializer(DataOutputView, TypeSerializer).
static <T> void	writeSerializer(DataOutputView out, TypeSerializer<T> serializer) Writes a TypeSerializer to the provided data output view.
static void	writeSerializerConfigSnapshot(DataOutputView out, TypeSerializerConfigSnapshot serializerConfigSnapshot) Writes a TypeSerializerConfigSnapshot to the provided data output view.
static void	writeSerializerConfigSnapshots(DataOutputView out, TypeSerializerConfigSnapshot... serializerConfigSnapshots) Writes multiple TypeSerializerConfigSnapshots to the provided data output view.
static void	writeSerializersAndConfigsWithResilience(DataOutputView out, List<Tuple2<TypeSerializer<?>,TypeSerializerConfigSnapshot>> serializersAndConfigs) Write a list of serializers and their corresponding config snapshots to the provided data output view.

Methods inherited from class java.lang.Object

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

Constructor Detail

TypeSerializerSerializationUtil

public TypeSerializerSerializationUtil()

Method Detail

writeSerializer

public static <T> void writeSerializer(DataOutputView out,
                       TypeSerializer<T> serializer)
                            throws IOException

Writes a TypeSerializer to the provided data output view.

It is written with a format that can be later read again using tryReadSerializer(DataInputView, ClassLoader, boolean).

Type Parameters:

T - Data type of the serializer.

Parameters:

out - the data output view.

serializer - the serializer to write.

Throws:

IOException

tryReadSerializer

public static <T> TypeSerializer<T> tryReadSerializer(DataInputView in,
                                      ClassLoader userCodeClassLoader)

Reads from a data input view a TypeSerializer that was previously written using writeSerializer(DataOutputView, TypeSerializer).

If deserialization fails for any reason (corrupted serializer bytes, serializer class no longer in classpath, serializer class no longer valid, etc.), null will be returned instead.

Type Parameters:

T - Data type of the serializer.

Parameters:

in - the data input view.

userCodeClassLoader - the user code class loader to use.

Returns:

the deserialized serializer.

tryReadSerializer

public static <T> TypeSerializer<T> tryReadSerializer(DataInputView in,
                                      ClassLoader userCodeClassLoader,
                                      boolean useDummyPlaceholder)

Reads from a data input view a TypeSerializer that was previously written using writeSerializer(DataOutputView, TypeSerializer).

If deserialization fails due to ClassNotFoundException or InvalidClassException, users can opt to use a dummy UnloadableDummyTypeSerializer to hold the serializer bytes, otherwise null is returned. If the failure is due to a StreamCorruptedException, then null is returned.

Type Parameters:

T - Data type of the serializer.

Parameters:

in - the data input view.

userCodeClassLoader - the user code class loader to use.

useDummyPlaceholder - whether or not to use a dummy UnloadableDummyTypeSerializer to hold the serializer bytes in the case of a ClassNotFoundException or InvalidClassException.

Returns:

the deserialized serializer.

writeSerializersAndConfigsWithResilience

public static void writeSerializersAndConfigsWithResilience(DataOutputView out,
                                            List<Tuple2<TypeSerializer<?>,TypeSerializerConfigSnapshot>> serializersAndConfigs)
                                                     throws IOException

Write a list of serializers and their corresponding config snapshots to the provided data output view. This method writes in a fault tolerant way, so that when read again using readSerializersAndConfigsWithResilience(DataInputView, ClassLoader), if deserialization of the serializer fails, its configuration snapshot will remain intact.

Specifically, all written serializers and their config snapshots are indexed by their offset positions within the serialized bytes. The serialization format is as follows:

• 1. number of serializer and configuration snapshot pairs.
• 2. offsets of each serializer and configuration snapshot, in order.
• 3. total number of bytes for the serialized serializers and the config snapshots.
• 4. serialized serializers and the config snapshots.

Parameters:

out - the data output view.

serializersAndConfigs - serializer and configuration snapshot pairs

Throws:

IOException

readSerializersAndConfigsWithResilience

public static List<Tuple2<TypeSerializer<?>,TypeSerializerConfigSnapshot>> readSerializersAndConfigsWithResilience(DataInputView in,
                                                                                                   ClassLoader userCodeClassLoader)
                                                                                                            throws IOException

Reads from a data input view a list of serializers and their corresponding config snapshots written using writeSerializersAndConfigsWithResilience(DataOutputView, List). This is fault tolerant to any failures when deserializing the serializers. Serializers which were not successfully deserialized will be replaced by null.

Parameters:

in - the data input view.

userCodeClassLoader - the user code class loader to use.

Returns:

the deserialized serializer and config snapshot pairs.

Throws:

IOException

writeSerializerConfigSnapshot

public static void writeSerializerConfigSnapshot(DataOutputView out,
                                 TypeSerializerConfigSnapshot serializerConfigSnapshot)
                                          throws IOException

Writes a TypeSerializerConfigSnapshot to the provided data output view.

It is written with a format that can be later read again using readSerializerConfigSnapshot(DataInputView, ClassLoader).

Parameters:

out - the data output view

serializerConfigSnapshot - the serializer configuration snapshot to write

Throws:

IOException

readSerializerConfigSnapshot

public static TypeSerializerConfigSnapshot readSerializerConfigSnapshot(DataInputView in,
                                                        ClassLoader userCodeClassLoader)
                                                                 throws IOException

Reads from a data input view a TypeSerializerConfigSnapshot that was previously written using writeSerializerConfigSnapshot(DataOutputView, TypeSerializerConfigSnapshot).

Parameters:

in - the data input view

userCodeClassLoader - the user code class loader to use

Returns:

the read serializer configuration snapshot

Throws:

IOException

writeSerializerConfigSnapshots

public static void writeSerializerConfigSnapshots(DataOutputView out,
                                  TypeSerializerConfigSnapshot... serializerConfigSnapshots)
                                           throws IOException

Writes multiple TypeSerializerConfigSnapshots to the provided data output view.

It is written with a format that can be later read again using readSerializerConfigSnapshots(DataInputView, ClassLoader).

Parameters:

out - the data output view

serializerConfigSnapshots - the serializer configuration snapshots to write

Throws:

IOException

readSerializerConfigSnapshots

public static TypeSerializerConfigSnapshot[] readSerializerConfigSnapshots(DataInputView in,
                                                           ClassLoader userCodeClassLoader)
                                                                    throws IOException

Reads from a data input view multiple TypeSerializerConfigSnapshots that was previously written using writeSerializerConfigSnapshot(DataOutputView, TypeSerializerConfigSnapshot).

Parameters:

in - the data input view

userCodeClassLoader - the user code class loader to use

Returns:

the read serializer configuration snapshots

Throws:

IOException