com.scaleoutsoftware.soss.client

Class CustomSerializer<O>

java.lang.Object

com.scaleoutsoftware.soss.client.CustomSerializer<O>

Type Parameters:

O - object type

Direct Known Subclasses:

EventSerializer

public abstract class CustomSerializer<O>
extends java.lang.Object

Custom serializers should extend this class. An instance of the class implementing this interface should be passed to NamedCache.setCustomSerialization(com.scaleoutsoftware.soss.client.CustomSerializer).

This class does not have any built-in routine for type checking. The type information should be saved and retrieved manually. Use this interface only when full control over the byte stream is necessary. In all other cases it might be safer to customize serialization by using objects that implement the Externalizable interface. Externalizable allows control over most of the serialization format, but preserves standard Java typing data, so objects will be automatically deserialized as the correct type. Using a CustomSerializer is advisable when implementing portable Java/C# objects.

If serialization or deserialization of an object is not supported in its implementation, it should throw an ObjectNotSupportedException. This will trigger an attempt to fallback to standard serialization. However, it is not recommended to keep such objects in the cache when a custom serializer is defined. You can use a "magic number" in the beginning of the stream to distinguish custom serialized objects from ones using standard serialization. The standard Java serializer always uses 0xACED as the stream prefix.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Class<O>	objectClass

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CustomSerializer()

Method Summary

Modifier and Type	Method and Description
abstract O	deserialize(java.io.InputStream in) Deserializes an object from InputStream.
O	deserialize(java.io.InputStream in, O instanceToSet) Deserializes an object from InputStream.
java.lang.Class<O>	getObjectClass() Returns the class for the object.
int	getSize() Returns size of fixed size objects.
abstract void	serialize(java.io.OutputStream out, O o) Serializes an object to OutputStream.
void	setObjectClass(java.lang.Class<O> objectClass) Sets the class of the serialized/deserialized objects.

Methods inherited from class java.lang.Object

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

Field Detail

objectClass

protected java.lang.Class<O> objectClass

Constructor Detail

CustomSerializer

protected CustomSerializer()

Method Detail

serialize

public abstract void serialize(java.io.OutputStream out,
                               O o)
                        throws ObjectNotSupportedException,
                               java.io.IOException

Serializes an object to OutputStream.

Parameters:

out - output stream

o - object to be serialized

Throws:

ObjectNotSupportedException - if this object cannot be serialized

java.io.IOException - if serializer experiences an input/output error

deserialize

public abstract O deserialize(java.io.InputStream in)
                       throws ObjectNotSupportedException,
                              java.io.IOException,
                              java.lang.ClassNotFoundException

Deserializes an object from InputStream.

Parameters:

in - input stream

Returns:

deserialized object

Throws:

ObjectNotSupportedException - if this object cannot be deserialized

java.io.IOException - if the serializer experiences an input/output error

java.lang.ClassNotFoundException - if the dependency is not loaded into the JVM

deserialize

public O deserialize(java.io.InputStream in,
                     O instanceToSet)
              throws ObjectNotSupportedException,
                     java.io.IOException,
                     java.lang.ClassNotFoundException

Deserializes an object from InputStream.

Parameters:

in - input stream

instanceToSet - the object to deserialize

Returns:

deserialized object

Throws:

ObjectNotSupportedException - if this object cannot be deserialized

java.io.IOException - if serializer experiences an input/output error

java.lang.ClassNotFoundException - if the dependency is not loaded into the JVM

setObjectClass

public void setObjectClass(java.lang.Class<O> objectClass)

Sets the class of the serialized/deserialized objects.

Parameters:

objectClass - class of the object

getObjectClass

public java.lang.Class<O> getObjectClass()

Returns the class for the object.

Returns:

object class or null if it is not set

getSize

public int getSize()

Returns size of fixed size objects.

Returns:

fixed size in bytes or 0 for variable length objects