Package com.hazelcast.config
Class SerializationConfig
java.lang.Object
com.hazelcast.config.SerializationConfig
public class SerializationConfig extends Object
Contains the serialization configuration of
HazelcastInstance
.-
Constructor Summary
Constructors Constructor Description SerializationConfig()
SerializationConfig(SerializationConfig serializationConfig)
-
Method Summary
Modifier and Type Method Description SerializationConfig
addClassDefinition(ClassDefinition classDefinition)
SerializationConfig
addDataSerializableFactory(int factoryId, DataSerializableFactory dataSerializableFactory)
SerializationConfig
addDataSerializableFactoryClass(int factoryId, Class<? extends DataSerializableFactory> dataSerializableFactoryClass)
SerializationConfig
addDataSerializableFactoryClass(int factoryId, String dataSerializableFactoryClass)
SerializationConfig
addPortableFactory(int factoryId, PortableFactory portableFactory)
SerializationConfig
addPortableFactoryClass(int factoryId, Class<? extends PortableFactory> portableFactoryClass)
SerializationConfig
addPortableFactoryClass(int factoryId, String portableFactoryClass)
SerializationConfig
addSerializerConfig(SerializerConfig serializerConfig)
boolean
equals(Object o)
ByteOrder
getByteOrder()
Note that result of useNativeByteOrder is not reflected to return value of this method.Set<ClassDefinition>
getClassDefinitions()
Map<Integer,DataSerializableFactory>
getDataSerializableFactories()
Map<Integer,String>
getDataSerializableFactoryClasses()
GlobalSerializerConfig
getGlobalSerializerConfig()
JavaSerializationFilterConfig
getJavaSerializationFilterConfig()
Map<Integer,PortableFactory>
getPortableFactories()
Map<Integer,String>
getPortableFactoryClasses()
int
getPortableVersion()
Portable version will be used to differentiate two versions of the same class that have changes on the class, like adding/removing a field or changing a type of a field.Collection<SerializerConfig>
getSerializerConfigs()
int
hashCode()
boolean
isAllowUnsafe()
Unsafe, it is not public api of java.boolean
isCheckClassDefErrors()
Default value istrue
(enabled).boolean
isEnableCompression()
Enables compression when default java serialization is used.boolean
isEnableSharedObject()
Enables shared object when default java serialization is used.boolean
isUseNativeByteOrder()
SerializationConfig
setAllowUnsafe(boolean allowUnsafe)
Unsafe, it is not public api of java.SerializationConfig
setByteOrder(ByteOrder byteOrder)
Note that configuring use native byte order as enabled will override the byte order set by this method.SerializationConfig
setCheckClassDefErrors(boolean checkClassDefErrors)
When enabled, serialization system will check for class definitions error at start and throw an Serialization Exception with error definition.SerializationConfig
setClassDefinitions(Set<ClassDefinition> classDefinitions)
SerializationConfig
setDataSerializableFactories(Map<Integer,DataSerializableFactory> dataSerializableFactories)
SerializationConfig
setDataSerializableFactoryClasses(Map<Integer,String> dataSerializableFactoryClasses)
SerializationConfig
setEnableCompression(boolean enableCompression)
Enables compression when default java serialization is used.SerializationConfig
setEnableSharedObject(boolean enableSharedObject)
Enables shared object when default java serialization is used.SerializationConfig
setGlobalSerializerConfig(GlobalSerializerConfig globalSerializerConfig)
SerializationConfig
setJavaSerializationFilterConfig(JavaSerializationFilterConfig javaSerializationFilterConfig)
Allows to configure deserialization protection filter.SerializationConfig
setPortableFactories(Map<Integer,PortableFactory> portableFactories)
SerializationConfig
setPortableFactoryClasses(Map<Integer,String> portableFactoryClasses)
SerializationConfig
setPortableVersion(int portableVersion)
SerializationConfig
setSerializerConfigs(Collection<SerializerConfig> serializerConfigs)
SerializationConfig
setUseNativeByteOrder(boolean useNativeByteOrder)
String
toString()
-
Constructor Details
-
SerializationConfig
public SerializationConfig() -
SerializationConfig
-
-
Method Details
-
getGlobalSerializerConfig
- Returns:
- the global serializer configuration
- See Also:
GlobalSerializerConfig
-
setGlobalSerializerConfig
public SerializationConfig setGlobalSerializerConfig(GlobalSerializerConfig globalSerializerConfig)- Parameters:
globalSerializerConfig
- configuration of serializer that will be used if no other serializer is applicable- Returns:
- GlobalSerializerConfig
-
getSerializerConfigs
- Returns:
- list of
SerializerConfig
s
-
addSerializerConfig
- Parameters:
serializerConfig
- serializer configuration of a class type- Returns:
- configured
SerializerConfig
for chaining
-
setSerializerConfigs
- Parameters:
serializerConfigs
- lists of serializer configs that will be registered- Returns:
- configured
SerializerConfig
for chaining
-
getPortableVersion
public int getPortableVersion()Portable version will be used to differentiate two versions of the same class that have changes on the class, like adding/removing a field or changing a type of a field.- Returns:
- version of portable classes
-
setPortableVersion
- Parameters:
portableVersion
- int value for the version of portable classes- Returns:
- configured
SerializerConfig
for chaining
-
getDataSerializableFactoryClasses
- Returns:
- map of factory ID and corresponding factory class names
- See Also:
DataSerializableFactory
-
setDataSerializableFactoryClasses
public SerializationConfig setDataSerializableFactoryClasses(Map<Integer,String> dataSerializableFactoryClasses)- Parameters:
dataSerializableFactoryClasses
- map of factory ID and corresponding factory class names- Returns:
- configured
SerializerConfig
for chaining - See Also:
DataSerializableFactory
-
addDataSerializableFactoryClass
public SerializationConfig addDataSerializableFactoryClass(int factoryId, String dataSerializableFactoryClass)- Parameters:
factoryId
- factory ID of dataSerializableFactory to be registereddataSerializableFactoryClass
- name of dataSerializableFactory class to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
DataSerializableFactory
-
addDataSerializableFactoryClass
public SerializationConfig addDataSerializableFactoryClass(int factoryId, Class<? extends DataSerializableFactory> dataSerializableFactoryClass)- Parameters:
factoryId
- factory ID of dataSerializableFactory to be registereddataSerializableFactoryClass
- dataSerializableFactory class to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
DataSerializableFactory
-
getDataSerializableFactories
- Returns:
- map of factory ID and corresponding dataSerializable factories
- See Also:
DataSerializableFactory
-
setDataSerializableFactories
public SerializationConfig setDataSerializableFactories(Map<Integer,DataSerializableFactory> dataSerializableFactories)- Parameters:
dataSerializableFactories
- map of factory ID and corresponding dataSerializable objects- Returns:
- configured
SerializerConfig
for chaining - See Also:
DataSerializableFactory
-
addDataSerializableFactory
public SerializationConfig addDataSerializableFactory(int factoryId, DataSerializableFactory dataSerializableFactory)- Parameters:
factoryId
- factory ID of DataSerializableFactory to be registereddataSerializableFactory
- DataSerializableFactory object to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
DataSerializableFactory
-
getPortableFactoryClasses
- Returns:
- map of factory ID and corresponding portable factory names
- See Also:
PortableFactory
-
setPortableFactoryClasses
- Parameters:
portableFactoryClasses
- map of factory ID and corresponding factory class names- Returns:
- configured
SerializerConfig
for chaining - See Also:
PortableFactory
-
addPortableFactoryClass
public SerializationConfig addPortableFactoryClass(int factoryId, Class<? extends PortableFactory> portableFactoryClass)- Parameters:
factoryId
- factory ID of portableFactory to be registeredportableFactoryClass
- portableFactory class to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
PortableFactory
-
addPortableFactoryClass
- Parameters:
factoryId
- factory ID of portableFactory to be registeredportableFactoryClass
- name of the portableFactory class to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
PortableFactory
-
getPortableFactories
- Returns:
- map of factory ID and corresponding portable factories
- See Also:
PortableFactory
-
setPortableFactories
- Parameters:
portableFactories
- map of factory ID and corresponding factory objects- Returns:
- configured
SerializerConfig
for chaining - See Also:
PortableFactory
-
addPortableFactory
- Parameters:
factoryId
- factory ID of portableFactory to be registeredportableFactory
- portableFactory object to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
PortableFactory
-
getClassDefinitions
- Returns:
- registered class definitions of portable classes
- See Also:
ClassDefinition
-
addClassDefinition
- Parameters:
classDefinition
- the class definition to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
ClassDefinition
-
setClassDefinitions
- Parameters:
classDefinitions
- set of class definitions to be registered- Returns:
- configured
SerializerConfig
for chaining - See Also:
ClassDefinition
-
isCheckClassDefErrors
public boolean isCheckClassDefErrors()Default value istrue
(enabled). When enabled, serialization system will check for class definitions error at start and throw an Serialization Exception with error definition.- Returns:
true
if enabled,false
otherwise
-
setCheckClassDefErrors
When enabled, serialization system will check for class definitions error at start and throw an Serialization Exception with error definition.- Parameters:
checkClassDefErrors
- set tofalse
to disable- Returns:
- configured
SerializerConfig
for chaining
-
isUseNativeByteOrder
public boolean isUseNativeByteOrder()- Returns:
true
if serialization is configured to use native byte order of the underlying platform
-
setUseNativeByteOrder
- Parameters:
useNativeByteOrder
- set totrue
to use native byte order of the underlying platform- Returns:
- configured
SerializerConfig
for chaining
-
getByteOrder
Note that result of useNativeByteOrder is not reflected to return value of this method.- Returns:
- configured byte order
-
setByteOrder
Note that configuring use native byte order as enabled will override the byte order set by this method.- Parameters:
byteOrder
- that serialization will use- Returns:
- configured
SerializerConfig
for chaining
-
isEnableCompression
public boolean isEnableCompression()Enables compression when default java serialization is used.- Returns:
true
if compression enabled
-
setEnableCompression
Enables compression when default java serialization is used.- Parameters:
enableCompression
- set totrue
to enable compression- Returns:
- configured
SerializerConfig
for chaining
-
isEnableSharedObject
public boolean isEnableSharedObject()Enables shared object when default java serialization is used.Default value is
true
.- Returns:
true
if enabled
-
setEnableSharedObject
Enables shared object when default java serialization is used.- Parameters:
enableSharedObject
- set tofalse
to disable- Returns:
- configured
SerializerConfig
for chaining
-
isAllowUnsafe
public boolean isAllowUnsafe()Unsafe, it is not public api of java. Use with caution!Default value is
false
.- Returns:
true
if using unsafe is allowed,false
otherwise
-
setAllowUnsafe
Unsafe, it is not public api of java. Use with caution!- Parameters:
allowUnsafe
- set totrue
to allow usage of unsafe- Returns:
- configured
SerializerConfig
for chaining
-
getJavaSerializationFilterConfig
- Returns:
- the javaSerializationFilterConfig
-
setJavaSerializationFilterConfig
public SerializationConfig setJavaSerializationFilterConfig(JavaSerializationFilterConfig javaSerializationFilterConfig)Allows to configure deserialization protection filter.- Parameters:
javaSerializationFilterConfig
- the javaSerializationFilterConfig to set (may benull
)
-
toString
-
equals
-
hashCode
public int hashCode()
-