com.hazelcast.internal.serialization.impl

Class AbstractSerializationService

java.lang.Object

com.hazelcast.internal.serialization.impl.AbstractSerializationService

All Implemented Interfaces:

InternalSerializationService, Disposable, SerializationService

Direct Known Subclasses:

SerializationServiceV1

public abstract class AbstractSerializationService
extends Object
implements InternalSerializationService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSerializationService.Builder<T extends AbstractSerializationService.Builder<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferPoolThreadLocal	bufferPoolThreadLocal
protected com.hazelcast.internal.serialization.impl.SerializerAdapter	dataSerializerAdapter
protected PartitioningStrategy	globalPartitioningStrategy
protected InputOutputFactory	inputOutputFactory
protected com.hazelcast.internal.serialization.impl.SerializerAdapter	javaExternalizableAdapter
protected com.hazelcast.internal.serialization.impl.SerializerAdapter	javaSerializerAdapter
protected ManagedContext	managedContext
protected com.hazelcast.internal.serialization.impl.SerializerAdapter	nullSerializerAdapter
protected com.hazelcast.internal.serialization.impl.SerializerAdapter	portableSerializerAdapter

Fields inherited from interface com.hazelcast.internal.serialization.InternalSerializationService

VERSION_1

Method Summary

Modifier and Type	Method and Description
protected int	calculatePartitionHash(Object obj, PartitioningStrategy strategy)
BufferObjectDataInput	createObjectDataInput(byte[] data)
BufferObjectDataInput	createObjectDataInput(Data data)
BufferObjectDataOutput	createObjectDataOutput()
BufferObjectDataOutput	createObjectDataOutput(int size)
void	dispose() Disposes this object and releases any data and/or resources associated with it.
void	disposeData(Data data)
ByteOrder	getByteOrder() Returns the byte order used when serializing/deserializing objects.
ClassLoader	getClassLoader()
ManagedContext	getManagedContext() see Config.setManagedContext(ManagedContext)
byte	getVersion()
<T> T	readObject(ObjectDataInput in)
<T> T	readObject(ObjectDataInput in, Class aClass)
void	register(Class type, Serializer serializer)
protected void	registerConstant(Class type, Serializer serializer)
protected void	registerConstant(Class type, com.hazelcast.internal.serialization.impl.SerializerAdapter serializer)
void	registerGlobal(Serializer serializer)
void	registerGlobal(Serializer serializer, boolean overrideJavaSerialization)
protected boolean	safeRegister(Class type, Serializer serializer)
protected boolean	safeRegister(Class type, com.hazelcast.internal.serialization.impl.SerializerAdapter serializer)
protected com.hazelcast.internal.serialization.impl.SerializerAdapter	serializerFor(int typeId)
protected com.hazelcast.internal.serialization.impl.SerializerAdapter	serializerFor(Object object)
byte[]	toBytes(Object obj) Writes the obj to a byte array.
byte[]	toBytes(Object obj, int leftPadding, boolean insertPartitionHash) Writes an object to a byte-array.
<B extends Data> B	toData(Object obj) Serializes an object to a Data.
<B extends Data> B	toData(Object obj, PartitioningStrategy strategy) Serializes an object to a Data.
<T> T	toObject(Object object) Deserializes an object.
<T> T	toObject(Object object, Class aClass) Deserializes an object.
void	writeObject(ObjectDataOutput out, Object obj)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.internal.serialization.InternalSerializationService

convertData, createPortableReader, getPortableContext, toData, toData

Field Detail

managedContext

protected final ManagedContext managedContext

inputOutputFactory

protected final InputOutputFactory inputOutputFactory

globalPartitioningStrategy

protected final PartitioningStrategy globalPartitioningStrategy

bufferPoolThreadLocal

protected final BufferPoolThreadLocal bufferPoolThreadLocal

dataSerializerAdapter

protected com.hazelcast.internal.serialization.impl.SerializerAdapter dataSerializerAdapter

portableSerializerAdapter

protected com.hazelcast.internal.serialization.impl.SerializerAdapter portableSerializerAdapter

nullSerializerAdapter

protected final com.hazelcast.internal.serialization.impl.SerializerAdapter nullSerializerAdapter

javaSerializerAdapter

protected com.hazelcast.internal.serialization.impl.SerializerAdapter javaSerializerAdapter

javaExternalizableAdapter

protected com.hazelcast.internal.serialization.impl.SerializerAdapter javaExternalizableAdapter

Method Detail

toData

public final <B extends Data> B toData(Object obj)

Description copied from interface: SerializationService

Serializes an object to a Data.

This method can safely be called with a Data instance. In that case, that instance is returned.

If this method is called with null, null is returned.

Specified by:

toData in interface SerializationService

Parameters:

obj - the object to serialize.

Returns:

the serialized object.

toData

public final <B extends Data> B toData(Object obj,
                                       PartitioningStrategy strategy)

Description copied from interface: SerializationService

Serializes an object to a Data.

This method can safely be called with a Data instance. In that case, that instance is returned.

If this method is called with null, null is returned.

Specified by:

toData in interface SerializationService

Parameters:

obj - the object to serialize.

strategy - strategy is used to calculate partition ID of the resulting data see PartitioningStrategy

Returns:

the serialized object.

toBytes

public byte[] toBytes(Object obj)

Description copied from interface: InternalSerializationService

Writes the obj to a byte array. This call is exactly the same as calling SerializationService.toData(Object) and then calling Data.toByteArray(). But it doesn't force a HeapData object being created.

IMPORTANT: The byte order used to serialize obj's serializer type ID is always ByteOrder.BIG_ENDIAN.

Specified by:

toBytes in interface InternalSerializationService

toBytes

public byte[] toBytes(Object obj,
                      int leftPadding,
                      boolean insertPartitionHash)

Description copied from interface: InternalSerializationService

Writes an object to a byte-array. It allows for configurable padding on the left. The padded bytes are not zero'd out since they will be written by the caller. Zero'ing them out would be waste of time.

If you want to convert an object to a Data (or its byte representation) then you want to have the partition hash, because that is part of the Data-definition. But if you want to serialize an object to a byte-array and don't care for the Data partition-hash, the hash can be disabled.

IMPORTANT: The byte order used to serialize obj's serializer type ID is the byte order configured in SerializationConfig.getByteOrder().

Specified by:

toBytes in interface InternalSerializationService

Parameters:

obj - object to write to byte array

leftPadding - offset from beginning of byte array to start writing the object's bytes

insertPartitionHash - true to include the partition hash in the byte array, otherwise false

toObject

public final <T> T toObject(Object object)

Description copied from interface: SerializationService

Deserializes an object.

This method can safely be called on an object that is already deserialized. In that case, that instance is returned.

If this method is called with null, null is returned.

Specified by:

toObject in interface SerializationService

Parameters:

object - the data to deserialize.

Returns:

the deserialized object.

toObject

public final <T> T toObject(Object object,
                            Class aClass)

Description copied from interface: SerializationService

Deserializes an object.

This method can safely be called on an object that is already deserialized. In that case, that instance is returned.

If this method is called with null, null is returned.

Specified by:

toObject in interface SerializationService

Parameters:

object - the data to deserialize.

aClass - The class to instantiate when deserializing the object.

Returns:

the deserialized object.

writeObject

public final void writeObject(ObjectDataOutput out,
                              Object obj)

Specified by:

writeObject in interface InternalSerializationService

readObject

public final <T> T readObject(ObjectDataInput in)

Specified by:

readObject in interface InternalSerializationService

readObject

public final <T> T readObject(ObjectDataInput in,
                              Class aClass)

Specified by:

readObject in interface InternalSerializationService

disposeData

public void disposeData(Data data)

Specified by:

disposeData in interface InternalSerializationService

createObjectDataInput

public final BufferObjectDataInput createObjectDataInput(byte[] data)

Specified by:

createObjectDataInput in interface InternalSerializationService

createObjectDataInput

public final BufferObjectDataInput createObjectDataInput(Data data)

Specified by:

createObjectDataInput in interface InternalSerializationService

createObjectDataOutput

public final BufferObjectDataOutput createObjectDataOutput(int size)

Specified by:

createObjectDataOutput in interface InternalSerializationService

createObjectDataOutput

public BufferObjectDataOutput createObjectDataOutput()

Specified by:

createObjectDataOutput in interface InternalSerializationService

getClassLoader

public final ClassLoader getClassLoader()

Specified by:

getClassLoader in interface InternalSerializationService

getManagedContext

public final ManagedContext getManagedContext()

Description copied from interface: SerializationService

see Config.setManagedContext(ManagedContext)

Specified by:

getManagedContext in interface SerializationService

Returns:

ManagedContext that is set by user in Config

getByteOrder

public ByteOrder getByteOrder()

Description copied from interface: InternalSerializationService

Returns the byte order used when serializing/deserializing objects. A notable exception is the top-level object's serializerTypeId: when using InternalSerializationService.toBytes(Object), the object's serializerTypeId is serialized always in ByteOrder.BIG_ENDIAN, while when using InternalSerializationService.toBytes(Object, int, boolean), the configured byte order is used. Inner objects (for example those serialized within an IdentifiedDataSerializable's writeData(ObjectDataOutput) with ObjectDataOutput.writeObject(Object)) always use the configured byte order.

Specified by:

getByteOrder in interface InternalSerializationService

Returns:

the ByteOrder which is configured for this InternalSerializationService.

See Also:

SerializationConfig.setByteOrder(ByteOrder), SerializationConfig.setUseNativeByteOrder(boolean), SerializationConfig.setAllowUnsafe(boolean)

getVersion

public byte getVersion()

Specified by:

getVersion in interface InternalSerializationService

dispose

public void dispose()

Description copied from interface: Disposable

Disposes this object and releases any data and/or resources associated with it. If this object is already disposed then invoking this method has no effect.

Specified by:

dispose in interface Disposable

register

public final void register(Class type,
                           Serializer serializer)

registerGlobal

public final void registerGlobal(Serializer serializer)

registerGlobal

public final void registerGlobal(Serializer serializer,
                                 boolean overrideJavaSerialization)

calculatePartitionHash

protected final int calculatePartitionHash(Object obj,
                                           PartitioningStrategy strategy)

safeRegister

protected final boolean safeRegister(Class type,
                                     Serializer serializer)

safeRegister

protected final boolean safeRegister(Class type,
                                     com.hazelcast.internal.serialization.impl.SerializerAdapter serializer)

registerConstant

protected final void registerConstant(Class type,
                                      Serializer serializer)

registerConstant

protected final void registerConstant(Class type,
                                      com.hazelcast.internal.serialization.impl.SerializerAdapter serializer)

serializerFor

protected final com.hazelcast.internal.serialization.impl.SerializerAdapter serializerFor(int typeId)

serializerFor

protected final com.hazelcast.internal.serialization.impl.SerializerAdapter serializerFor(Object object)