org.apache.gobblin.util

Class SerializationUtils

java.lang.Object

org.apache.gobblin.util.SerializationUtils

public class SerializationUtils
extends Object

A utility class for serializing and deserializing Objects to/from Strings.

Constructor Summary

Constructors

Constructor and Description
SerializationUtils()

Method Summary

Modifier and Type	Method and Description
static <T extends Serializable> T	deserialize(String serialized, Class<T> clazz) Deserialize a String obtained via serialize(Serializable) into an object, using BaseEncoding.base64().
static <T extends Serializable> T	deserialize(String serialized, Class<T> clazz, com.google.common.io.BaseEncoding enc) Deserialize a String obtained via serialize(Serializable) into an object, using the given BaseEncoding, which must be the same BaseEncoding used to serialize the object.
static <T extends Serializable> T	deserializeFromBytes(byte[] serialized, Class<T> clazz) Deserialize a String obtained via serializeIntoBytes(Serializable) into an object.
static <T extends State> void	deserializeState(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path jobStateFilePath, T state) Deserialize/read a State instance from a file.
static <T extends State> void	deserializeStateFromInputStream(InputStream is, T state) Deserialize/read a State instance from a file.
static <T extends Serializable> String	serialize(T obj) Serialize an object into a String.
static <T extends Serializable> String	serialize(T obj, com.google.common.io.BaseEncoding enc) Serialize an object into a String.
static <T extends Serializable> byte[]	serializeIntoBytes(T obj) Serialize an object into a byte array.
static <T extends State> void	serializeState(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path jobStateFilePath, T state) Serialize a State instance to a file.
static <T extends State> void	serializeState(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path jobStateFilePath, T state, short replication) Serialize a State instance to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializationUtils

public SerializationUtils()

Method Detail

serialize

public static <T extends Serializable> String serialize(T obj)
                                                 throws IOException

Serialize an object into a String. The object is first serialized into a byte array, which is converted into a String using BaseEncoding.base64().

Parameters:

obj - A Serializable object

Returns:

A String representing the input object

Throws:

IOException - if it fails to serialize the object

serialize

public static <T extends Serializable> String serialize(T obj,
                                                        com.google.common.io.BaseEncoding enc)
                                                 throws IOException

Serialize an object into a String. The object is first serialized into a byte array, which is converted into a String using the given BaseEncoding.

Parameters:

obj - A Serializable object

enc - The BaseEncoding used to encode a byte array.

Returns:

A String representing the input object

Throws:

IOException - if it fails to serialize the object

serializeIntoBytes

public static <T extends Serializable> byte[] serializeIntoBytes(T obj)
                                                          throws IOException

Serialize an object into a byte array.

Parameters:

obj - A Serializable object

Returns:

Byte serialization of input object

Throws:

IOException - if it fails to serialize the object

deserialize

public static <T extends Serializable> T deserialize(String serialized,
                                                     Class<T> clazz)
                                              throws IOException

Deserialize a String obtained via serialize(Serializable) into an object, using BaseEncoding.base64().

Parameters:

serialized - The serialized String

clazz - The class the deserialized object should be cast to.

Returns:

The deserialized object

Throws:

IOException - if it fails to deserialize the object

deserialize

public static <T extends Serializable> T deserialize(String serialized,
                                                     Class<T> clazz,
                                                     com.google.common.io.BaseEncoding enc)
                                              throws IOException

Deserialize a String obtained via serialize(Serializable) into an object, using the given BaseEncoding, which must be the same BaseEncoding used to serialize the object.

Parameters:

serialized - The serialized String

clazz - The class the deserialized object should be cast to.

enc - The BaseEncoding used to decode the String.

Returns:

The deserialized object

Throws:

IOException - if it fails to deserialize the object

deserializeFromBytes

public static <T extends Serializable> T deserializeFromBytes(byte[] serialized,
                                                              Class<T> clazz)
                                                       throws IOException

Deserialize a String obtained via serializeIntoBytes(Serializable) into an object.

Parameters:

serialized - The serialized bytes

clazz - The class the deserialized object should be cast to.

Returns:

The deserialized object

Throws:

IOException - if it fails to deserialize the object

serializeState

public static <T extends State> void serializeState(org.apache.hadoop.fs.FileSystem fs,
                                                    org.apache.hadoop.fs.Path jobStateFilePath,
                                                    T state)
                                             throws IOException

Serialize a State instance to a file.

Type Parameters:

T - the State object type

Parameters:

fs - the FileSystem instance for creating the file

jobStateFilePath - the path to the file

state - the State to serialize

Throws:

IOException - if it fails to serialize the State instance

serializeState

public static <T extends State> void serializeState(org.apache.hadoop.fs.FileSystem fs,
                                                    org.apache.hadoop.fs.Path jobStateFilePath,
                                                    T state,
                                                    short replication)
                                             throws IOException

Serialize a State instance to a file.

Type Parameters:

T - the State object type

Parameters:

fs - the FileSystem instance for creating the file

jobStateFilePath - the path to the file

state - the State to serialize

replication - replication of the serialized file.

Throws:

IOException - if it fails to serialize the State instance

deserializeState

public static <T extends State> void deserializeState(org.apache.hadoop.fs.FileSystem fs,
                                                      org.apache.hadoop.fs.Path jobStateFilePath,
                                                      T state)
                                               throws IOException

Deserialize/read a State instance from a file.

Type Parameters:

T - the State object type

Parameters:

fs - the FileSystem instance for opening the file

jobStateFilePath - the path to the file

state - an empty State instance to deserialize into

Throws:

IOException - if it fails to deserialize the State instance

deserializeStateFromInputStream

public static <T extends State> void deserializeStateFromInputStream(InputStream is,
                                                                     T state)
                                                              throws IOException

Deserialize/read a State instance from a file.

Type Parameters:

T - the State object type

Parameters:

is - InputStream containing the state.

state - an empty State instance to deserialize into

Throws:

IOException - if it fails to deserialize the State instance