com.goldencode.util

Class PayloadSerializer

java.lang.Object

com.goldencode.util.PayloadSerializer

public class PayloadSerializer
extends java.lang.Object

Helper class to (de)serialize Message payload (a generic array of Object)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	PayloadSerializer.ArrayHelper<T> Helper class for scalar classes and their arrays
private static class	PayloadSerializer.Cls<T extends java.io.Externalizable> Helper class for processing Externalizable FWD classes
private static class	PayloadSerializer.Core<T> Helper class for processing core Java classes
private static class	PayloadSerializer.Helper<T> Helper class for different types of payload components
private static class	PayloadSerializer.Primitive<T> Helper classes for primitive arrays

Field Summary

Fields

Modifier and Type	Field and Description
private static short	ARRAY
private static short	CORE_ARRAY
private static java.util.Map<java.lang.Class<?>,PayloadSerializer.Core<?>>	CORE_BY_CLASS Helper classes for core Java classes by class
private static PayloadSerializer.Core<?>[]	CORE_BY_TYPECODE Helper classes for core Java classes by typecode
private static short	EXTERNALIZABLE
private static short	NULL Special type codes
private static short	OBJECT
private static java.util.List<PayloadSerializer.Cls<?>>	PAYLOAD_CLASSES Helper classes for FWD classes
private static java.util.Map<java.lang.Class<?>,PayloadSerializer.Cls<?>>	PAYLOAD_CLASSES_BY_CLASS Helper classes for FWD classes by class
private static PayloadSerializer.Cls[]	PAYLOAD_CLASSES_BY_TYPECODE Helper classes for FWD classes by typecode
private static java.util.List<PayloadSerializer.Core<?>>	PAYLOAD_CORE Helper classes for core Java classes
private static java.util.List<PayloadSerializer.Primitive<?>>	PAYLOAD_PRIMITIVES Helper classes for primitive arrays
private static short	PRIMITIVE_ARRAY
private static java.util.Map<java.lang.Class<?>,PayloadSerializer.Primitive<?>>	PRIMITIVES_BY_CLASS Helper classes for primitive arrays by array class
private static PayloadSerializer.Primitive<?>[]	PRIMITIVES_BY_TYPECODE Helper classes for primitive arrays by typecode
private static boolean	USE_PAYLOAD_SERIALIZER "use payload serializer" flag

Constructor Summary

Constructors

Constructor and Description
PayloadSerializer()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	dumpObject(java.lang.Object o) Dump generic object can be array with array member to the string
static void	main(java.lang.String... args) Test program
private static java.util.List<java.lang.Object>	randomData(java.util.Random rnd, int len, int depth) Generate random payload
private static java.io.Serializable	readArray(java.io.ObjectInput in) Read array from the input stream
private static java.io.Serializable	readCoreArray(java.io.ObjectInput in) Read array of core Java classes from the input stream
private static java.io.Serializable	readItem(java.io.ObjectInput in, short type) Read scalar object from the input stream
(package private) static java.lang.String	readLongUTF(java.io.ObjectInput in) Reads a long UTF string from the given ObjectInput, which was chunked into 0x3FFF-sized character chunks when written.
static java.io.Serializable	readPayload(java.io.ObjectInput in) Read Message payload from the input stream
private static java.io.Serializable	readPrimitiveArray(java.io.ObjectInput in) Read primitive array from the input stream
private static int	test(boolean print, int len)
private static void	writeArray(java.io.ObjectOutput out, java.lang.Object o, java.lang.Class<?> c) Write array to the output stream
private static void	writeCoreArray(java.io.ObjectOutput out, java.lang.Object o, PayloadSerializer.Core<?> core) Write array of core Java classes to the output stream
private static void	writeItem(java.io.ObjectOutput out, java.lang.Object o) Write scalar object to the output stream
(package private) static void	writeLongUTF(java.io.ObjectOutput out, java.lang.String longString) Writes a long UTF string to the given ObjectOutput by chunking it into 0x3FFF-sized character chunks.
static void	writePayload(java.io.ObjectOutput out, java.lang.Object o) Write Message payload to the output stream
private static void	writePrimitiveArray(java.io.ObjectOutput out, java.lang.Object o) Write primitive array to the output stream

Methods inherited from class java.lang.Object

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

Field Detail

USE_PAYLOAD_SERIALIZER

private static final boolean USE_PAYLOAD_SERIALIZER

"use payload serializer" flag

See Also:

Constant Field Values

NULL

private static final short NULL

Special type codes

See Also:

Constant Field Values

OBJECT

private static final short OBJECT

See Also:

Constant Field Values

ARRAY

private static final short ARRAY

See Also:

Constant Field Values

PRIMITIVE_ARRAY

private static final short PRIMITIVE_ARRAY

See Also:

Constant Field Values

CORE_ARRAY

private static final short CORE_ARRAY

See Also:

Constant Field Values

EXTERNALIZABLE

private static final short EXTERNALIZABLE

See Also:

Constant Field Values

PAYLOAD_PRIMITIVES

private static final java.util.List<PayloadSerializer.Primitive<?>> PAYLOAD_PRIMITIVES

Helper classes for primitive arrays

PRIMITIVES_BY_CLASS

private static final java.util.Map<java.lang.Class<?>,PayloadSerializer.Primitive<?>> PRIMITIVES_BY_CLASS

Helper classes for primitive arrays by array class

PRIMITIVES_BY_TYPECODE

private static final PayloadSerializer.Primitive<?>[] PRIMITIVES_BY_TYPECODE

Helper classes for primitive arrays by typecode

PAYLOAD_CORE

private static final java.util.List<PayloadSerializer.Core<?>> PAYLOAD_CORE

Helper classes for core Java classes

CORE_BY_CLASS

private static final java.util.Map<java.lang.Class<?>,PayloadSerializer.Core<?>> CORE_BY_CLASS

Helper classes for core Java classes by class

CORE_BY_TYPECODE

private static final PayloadSerializer.Core<?>[] CORE_BY_TYPECODE

Helper classes for core Java classes by typecode

PAYLOAD_CLASSES

private static final java.util.List<PayloadSerializer.Cls<?>> PAYLOAD_CLASSES

Helper classes for FWD classes

PAYLOAD_CLASSES_BY_CLASS

private static final java.util.Map<java.lang.Class<?>,PayloadSerializer.Cls<?>> PAYLOAD_CLASSES_BY_CLASS

Helper classes for FWD classes by class

PAYLOAD_CLASSES_BY_TYPECODE

private static final PayloadSerializer.Cls[] PAYLOAD_CLASSES_BY_TYPECODE

Helper classes for FWD classes by typecode

Constructor Detail

PayloadSerializer

public PayloadSerializer()

Method Detail

dumpObject

public static java.lang.String dumpObject(java.lang.Object o)

Dump generic object can be array with array member to the string

Parameters:

o - object to be rendered

Returns:

result string

readPayload

public static java.io.Serializable readPayload(java.io.ObjectInput in)
                                        throws java.io.IOException,
                                               java.lang.ClassNotFoundException

Read Message payload from the input stream

Parameters:

in - input stream

Returns:

deserialized payload

Throws:

java.io.IOException - In case of I/O error

java.lang.ClassNotFoundException - If class is not found

writePayload

public static void writePayload(java.io.ObjectOutput out,
                                java.lang.Object o)
                         throws java.io.IOException

Write Message payload to the output stream

Parameters:

out - output stream

o - payload to be written

Throws:

java.io.IOException - In case of I/O error

readCoreArray

private static java.io.Serializable readCoreArray(java.io.ObjectInput in)
                                           throws java.io.IOException,
                                                  java.lang.ClassNotFoundException

Read array of core Java classes from the input stream

Parameters:

in - input stream

Returns:

deserialized array

Throws:

java.io.IOException - In case of I/O error

java.lang.ClassNotFoundException - If class is not found

writeCoreArray

private static void writeCoreArray(java.io.ObjectOutput out,
                                   java.lang.Object o,
                                   PayloadSerializer.Core<?> core)
                            throws java.io.IOException

Write array of core Java classes to the output stream

Parameters:

out - output stream

o - array to be written

core - helper for the array component class

Throws:

java.io.IOException - In case of I/O error

readArray

private static java.io.Serializable readArray(java.io.ObjectInput in)
                                       throws java.io.IOException,
                                              java.lang.ClassNotFoundException

Read array from the input stream

Parameters:

in - input stream

Returns:

deserialized array

Throws:

java.io.IOException - In case of I/O error

java.lang.ClassNotFoundException - If class is not found

writeArray

private static void writeArray(java.io.ObjectOutput out,
                               java.lang.Object o,
                               java.lang.Class<?> c)
                        throws java.io.IOException

Write array to the output stream

Parameters:

out - output stream

o - array to be written

c - type of the array component

Throws:

java.io.IOException - In case of I/O error

readPrimitiveArray

private static java.io.Serializable readPrimitiveArray(java.io.ObjectInput in)
                                                throws java.io.IOException

Read primitive array from the input stream

Parameters:

in - input stream

Returns:

deserialized array

Throws:

java.io.IOException - In case of I/O error

writePrimitiveArray

private static void writePrimitiveArray(java.io.ObjectOutput out,
                                        java.lang.Object o)
                                 throws java.io.IOException

Write primitive array to the output stream

Parameters:

out - output stream

o - array to be written

Throws:

java.io.IOException - In case of I/O error

readItem

private static java.io.Serializable readItem(java.io.ObjectInput in,
                                             short type)
                                      throws java.lang.ClassNotFoundException,
                                             java.io.IOException

Read scalar object from the input stream

Parameters:

in - input stream

type - object typecode

Returns:

deserialized object

Throws:

java.lang.ClassNotFoundException - If class is not found

java.io.IOException - In case of I/O error

writeItem

private static void writeItem(java.io.ObjectOutput out,
                              java.lang.Object o)
                       throws java.io.IOException

Write scalar object to the output stream

Parameters:

out - output stream

o - object to be written

Throws:

java.io.IOException - In case of I/O error

readLongUTF

static java.lang.String readLongUTF(java.io.ObjectInput in)
                             throws java.io.IOException

Reads a long UTF string from the given ObjectInput, which was chunked into 0x3FFF-sized character chunks when written. The first chunk is read, followed by the number of remaining chunks (if any), and the remaining chunks.

Parameters:

in - ObjectInput to read the long string from.

Returns:

The long string read from the ObjectInput.

Throws:

java.io.IOException - If an I/O error occurs while reading from the ObjectInput.

writeLongUTF

static void writeLongUTF(java.io.ObjectOutput out,
                         java.lang.String longString)
                  throws java.io.IOException

Writes a long UTF string to the given ObjectOutput by chunking it into 0x3FFF-sized character chunks. The first chunk is written, followed by the number of remaining chunks, and the remaining chunks. If the string fits into a single chunk, only the single chunk is written without the number of chunks. The chunk size is chosen to be 0x3FFF because it is the largest chunk size that can be reliably written by the DataOutputStream.writeUTF() method. The maximum length of a string that can be written by the DataOutputStream.writeUTF() is a string taking the maximum of 0xFFFF UTF-encoded bytes.

Parameters:

out - ObjectOutputStream to write the long string to.

longString - The long string to be written.

Throws:

java.io.IOException - If an I/O error occurs while writing to the ObjectOutput.

java.lang.IllegalArgumentException - If the string is too long to be written. The max length is Short.MAX_VALUE * 0x3FFF.

main

public static void main(java.lang.String... args)
                 throws java.lang.Exception

Test program

Parameters:

args - command line args

Throws:

java.lang.Exception - In case of runtime error

test

private static int test(boolean print,
                        int len)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

randomData

private static java.util.List<java.lang.Object> randomData(java.util.Random rnd,
                                                           int len,
                                                           int depth)

Generate random payload

Parameters:

rnd - random generator

len - list length

depth - depth of the recursion (array as members of array)

Returns:

generated random payload