net.dempsy.serialization.kryo

Class KryoSerializer

java.lang.Object

net.dempsy.serialization.Serializer

net.dempsy.serialization.kryo.KryoSerializer

public class KryoSerializer
extends Serializer

This is the implementation of the Kryo based serialization for Dempsy. It can be configured with registered classes using Spring by passing a list of Registration instances to the constructor.

The serializer will also pick up registrations from a file on the classpath if it's provided. It will default to KRYO_REGISTRATION_FILE but can be overridden by supplying the system property with the name SYS_PROP_REGISTRAION_RESOURCE.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	KryoSerializer.Holder

Field Summary

Fields

Modifier and Type	Field and Description
static String	KRYO_REGISTRATION_FILE
static String	SYS_PROP_REGISTRAION_RESOURCE

Constructor Summary

Constructors

Constructor and Description
KryoSerializer()
KryoSerializer(boolean manageExactClasses) Create an unconfigured default KryoSerializer with no registered classes.
KryoSerializer(boolean manageExactClasses, KryoOptimizer optimizer, Registration... regs) Create an KryoSerializer with the provided registrations and Application specific Optimizer.
KryoSerializer(boolean manageExactClasses, Registration... regs) Create an KryoSerializer with the provided registrations.

Method Summary

Modifier and Type	Method and Description
<T> T	deserialize(MessageBufferInput data, Class<T> clazz)
protected KryoSerializer.Holder	getKryoHolder()
<T> void	serialize(T object, MessageBufferOutput buffer)
void	setKryoOptimizer(KryoOptimizer optimizer) Set the optimizer.
void	setKryoRegistrationRequired(boolean requireRegistration) You can require Kryo to serialize only registered classes by passing 'true' to setKryoRegistrationRequired.

Methods inherited from class net.dempsy.serialization.Serializer

deserialize, serialize

Methods inherited from class java.lang.Object

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

Field Detail

KRYO_REGISTRATION_FILE

public static final String KRYO_REGISTRATION_FILE

See Also:

Constant Field Values

SYS_PROP_REGISTRAION_RESOURCE

public static final String SYS_PROP_REGISTRAION_RESOURCE

See Also:

Constant Field Values

Constructor Detail

KryoSerializer

public KryoSerializer()

KryoSerializer

public KryoSerializer(boolean manageExactClasses)

Create an unconfigured default KryoSerializer with no registered classes. If you set manageExactClasses then the result of serializing and then deserializing a class by referring to its superclass will result in the original class. Otherwise the class passed to the deserialize call will be the actual class that's deserialized.

KryoSerializer

public KryoSerializer(boolean manageExactClasses,
                      Registration... regs)

Create an KryoSerializer with the provided registrations. This can be used from a Spring configuration.

KryoSerializer

public KryoSerializer(boolean manageExactClasses,
                      KryoOptimizer optimizer,
                      Registration... regs)

Create an KryoSerializer with the provided registrations and Application specific Optimizer. This can be used from a Spring configuration.

Method Detail

setKryoOptimizer

public void setKryoOptimizer(KryoOptimizer optimizer)

Set the optimizer. This is provided for a dependency injection framework to use. If it's called

Parameters:

optimizer -

setKryoRegistrationRequired

public void setKryoRegistrationRequired(boolean requireRegistration)

You can require Kryo to serialize only registered classes by passing 'true' to setKryoRegistrationRequired. The default is 'false'.

serialize

public <T> void serialize(T object,
                          MessageBufferOutput buffer)
                   throws IOException

Specified by:

serialize in class Serializer

Throws:

IOException

deserialize

public <T> T deserialize(MessageBufferInput data,
                         Class<T> clazz)
                  throws IOException

Specified by:

deserialize in class Serializer

Throws:

IOException

getKryoHolder

protected KryoSerializer.Holder getKryoHolder()