Package com.hazelcast.config
Class MapStoreConfig
java.lang.Object
com.hazelcast.config.MapStoreConfig
- All Implemented Interfaces:
DataSerializable
,IdentifiedDataSerializable
public class MapStoreConfig extends Object implements IdentifiedDataSerializable
Contains the configuration for a Map Store.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MapStoreConfig.InitialLoadMode
Initial load module -
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_WRITE_BATCH_SIZE
Default batch size for writingstatic boolean
DEFAULT_WRITE_COALESCING
Default write coalescing behaviorstatic int
DEFAULT_WRITE_DELAY_SECONDS
Default delay seconds for writing -
Constructor Summary
Constructors Constructor Description MapStoreConfig()
MapStoreConfig(MapStoreConfig config)
-
Method Summary
Modifier and Type Method Description boolean
equals(Object o)
int
getClassId()
Returns type identifier for this class.String
getClassName()
Returns the name of the MapStore implementation classString
getFactoryClassName()
Returns the name of the MapStoreFactory implementation classint
getFactoryId()
Returns DataSerializableFactory factory ID for this class.Object
getFactoryImplementation()
Returns the map store factory implementation object.Object
getImplementation()
Returns the map store implementation object.MapStoreConfig.InitialLoadMode
getInitialLoadMode()
Returns the initial load mode.Properties
getProperties()
Returns all the propertiesString
getProperty(String name)
Returns the given propertyint
getWriteBatchSize()
Returns the number of operations to be included in each batch processing round.int
getWriteDelaySeconds()
Returns the number of seconds to delay the store writes.int
hashCode()
boolean
isEnabled()
Returns if this configuration is enabledboolean
isWriteCoalescing()
Returnstrue
if write-coalescing is enabled.void
readData(ObjectDataInput in)
Reads fields from the input streamMapStoreConfig
setClassName(String className)
Sets the name for the MapStore implementation classMapStoreConfig
setEnabled(boolean enabled)
Enables and disables this configurationMapStoreConfig
setFactoryClassName(String factoryClassName)
Sets the name for the MapStoreFactory implementation classMapStoreConfig
setFactoryImplementation(Object factoryImplementation)
Sets the map store factory implementation object.MapStoreConfig
setImplementation(Object implementation)
Sets the map store implementation objectMapStoreConfig
setInitialLoadMode(MapStoreConfig.InitialLoadMode initialLoadMode)
Sets the initial load mode.MapStoreConfig
setProperties(Properties properties)
Sets the propertiesMapStoreConfig
setProperty(String name, String value)
MapStoreConfig
setWriteBatchSize(int writeBatchSize)
Sets the number of operations to be included in each batch processing round.MapStoreConfig
setWriteCoalescing(boolean writeCoalescing)
SettingwriteCoalescing
is meaningful if you are using write-behindMapStore
.MapStoreConfig
setWriteDelaySeconds(int writeDelaySeconds)
Sets the number of seconds to delay before writing (storing) the dirty recordsString
toString()
void
writeData(ObjectDataOutput out)
Writes object fields to output stream
-
Field Details
-
DEFAULT_WRITE_DELAY_SECONDS
public static final int DEFAULT_WRITE_DELAY_SECONDSDefault delay seconds for writing- See Also:
- Constant Field Values
-
DEFAULT_WRITE_BATCH_SIZE
public static final int DEFAULT_WRITE_BATCH_SIZEDefault batch size for writing- See Also:
- Constant Field Values
-
DEFAULT_WRITE_COALESCING
public static final boolean DEFAULT_WRITE_COALESCINGDefault write coalescing behavior- See Also:
- Constant Field Values
-
-
Constructor Details
-
MapStoreConfig
public MapStoreConfig() -
MapStoreConfig
-
-
Method Details
-
getClassName
Returns the name of the MapStore implementation class- Returns:
- the name of the MapStore implementation class
-
setClassName
Sets the name for the MapStore implementation class- Parameters:
className
- the name to set for the MapStore implementation class
-
getFactoryClassName
Returns the name of the MapStoreFactory implementation class- Returns:
- the name of the MapStoreFactory implementation class
-
setFactoryClassName
Sets the name for the MapStoreFactory implementation class- Parameters:
factoryClassName
- the name to set for the MapStoreFactory implementation class
-
getWriteDelaySeconds
public int getWriteDelaySeconds()Returns the number of seconds to delay the store writes.- Returns:
- the number of seconds to delay the store writes
-
setWriteDelaySeconds
Sets the number of seconds to delay before writing (storing) the dirty recordsDefault value is 0.
- Parameters:
writeDelaySeconds
- the number of seconds to delay before writing the dirty records
-
getWriteBatchSize
public int getWriteBatchSize()Returns the number of operations to be included in each batch processing round.- Returns:
- write batch size: the number of operations to be included in each batch processing round
-
setWriteBatchSize
Sets the number of operations to be included in each batch processing round.Default value is 1.
- Parameters:
writeBatchSize
- the number of operations to be included in each batch processing round
-
isEnabled
public boolean isEnabled()Returns if this configuration is enabled- Returns:
true
if this configuration is enabled,false
otherwise
-
setEnabled
Enables and disables this configuration- Parameters:
enabled
-true
to enables this configuration,false
to disable
-
setImplementation
Sets the map store implementation object- Parameters:
implementation
- the map store implementation object to set- Returns:
- this MapStoreConfig instance
-
getImplementation
Returns the map store implementation object.- Returns:
- the map store implementation object
-
setFactoryImplementation
Sets the map store factory implementation object.- Parameters:
factoryImplementation
- the factory implementation object- Returns:
- this MapStoreConfig instance
-
getFactoryImplementation
Returns the map store factory implementation object.- Returns:
- the map store factory implementation object
-
setProperty
-
getProperty
Returns the given property- Returns:
- the given property
-
getProperties
Returns all the properties- Returns:
- all the properties
-
setProperties
Sets the properties- Parameters:
properties
- the properties to be set- Returns:
- this MapStoreConfig
-
getInitialLoadMode
Returns the initial load mode.- Returns:
- the initial load mode object
-
setInitialLoadMode
Sets the initial load mode.- LAZY: Default load mode where load is async
- EAGER: load mode where load is blocked till all partitions are loaded
- Parameters:
initialLoadMode
- the initial load mode object
-
isWriteCoalescing
public boolean isWriteCoalescing()Returnstrue
if write-coalescing is enabled.- Returns:
true
if coalescing enabled,false
otherwise- See Also:
setWriteCoalescing(boolean)
-
setWriteCoalescing
SettingwriteCoalescing
is meaningful if you are using write-behindMapStore
.When
writeCoalescing
istrue
, only the latest store operation on a key in thewriteDelaySeconds
time-window will be reflected toMapStore
.Default value is true.
- Parameters:
writeCoalescing
-true
to enable write-coalescing, otherwisefalse
.- See Also:
ClusterProperty.MAP_WRITE_BEHIND_QUEUE_CAPACITY
-
toString
-
equals
-
hashCode
public final int hashCode() -
getFactoryId
public int getFactoryId()Description copied from interface:IdentifiedDataSerializable
Returns DataSerializableFactory factory ID for this class.- Specified by:
getFactoryId
in interfaceIdentifiedDataSerializable
- Returns:
- factory ID
-
getClassId
public int getClassId()Description copied from interface:IdentifiedDataSerializable
Returns type identifier for this class. It should be unique per DataSerializableFactory.- Specified by:
getClassId
in interfaceIdentifiedDataSerializable
- Returns:
- type ID
-
writeData
Description copied from interface:DataSerializable
Writes object fields to output stream- Specified by:
writeData
in interfaceDataSerializable
- Parameters:
out
- output- Throws:
IOException
- if an I/O error occurs. In particular, anIOException
may be thrown if the output stream has been closed.
-
readData
Description copied from interface:DataSerializable
Reads fields from the input stream- Specified by:
readData
in interfaceDataSerializable
- Parameters:
in
- input- Throws:
IOException
- if an I/O error occurs. In particular, anIOException
may be thrown if the input stream has been closed.
-