Package com.hazelcast.config
Class MapConfig
java.lang.Object
com.hazelcast.config.MapConfig
- All Implemented Interfaces:
NamedConfig
,DataSerializable
,IdentifiedDataSerializable
public class MapConfig extends Object implements IdentifiedDataSerializable, NamedConfig
Contains the configuration for an
IMap
.-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_BACKUP_COUNT
The default number of backupsstatic CacheDeserializedValues
DEFAULT_CACHED_DESERIALIZED_VALUES
We want to cache values only when an index is defined.static EvictionPolicy
DEFAULT_EVICTION_POLICY
Default eviction policystatic InMemoryFormat
DEFAULT_IN_MEMORY_FORMAT
Default In-Memory format is binary.static int
DEFAULT_MAX_IDLE_SECONDS
The number of default time to wait eviction in seconds.static int
DEFAULT_MAX_SIZE
Default max size.static MaxSizePolicy
DEFAULT_MAX_SIZE_POLICY
Default max size policystatic MetadataPolicy
DEFAULT_METADATA_POLICY
Default metadata policystatic boolean
DEFAULT_STATISTICS_ENABLED
Default value of whether statistics are enabled or notstatic int
DEFAULT_TTL_SECONDS
The number of default Time to Live in seconds.static int
MAX_BACKUP_COUNT
The maximum number of backupsstatic int
MIN_BACKUP_COUNT
The minimum number of backups -
Constructor Summary
-
Method Summary
Modifier and Type Method Description MapConfig
addAttributeConfig(AttributeConfig attributeConfig)
MapConfig
addEntryListenerConfig(EntryListenerConfig listenerConfig)
MapConfig
addIndexConfig(IndexConfig indexConfig)
MapConfig
addMapPartitionLostListenerConfig(MapPartitionLostListenerConfig listenerConfig)
MapConfig
addQueryCacheConfig(QueryCacheConfig queryCacheConfig)
Adds a newQueryCacheConfig
to thisMapConfig
.boolean
equals(Object o)
int
getAsyncBackupCount()
Returns the asynchronous backup count for thisIMap
.List<AttributeConfig>
getAttributeConfigs()
int
getBackupCount()
Returns the backupCount for thisIMap
CacheDeserializedValues
getCacheDeserializedValues()
Get current value cache settingsint
getClassId()
Returns type identifier for this class.List<EntryListenerConfig>
getEntryListenerConfigs()
EventJournalConfig
getEventJournalConfig()
Gets theEventJournalConfig
for thisMapConfig
EvictionConfig
getEvictionConfig()
Gets theEvictionConfig
instance of the eviction configuration for thisIMap
.int
getFactoryId()
Returns DataSerializableFactory factory ID for this class.HotRestartConfig
getHotRestartConfig()
Gets theHotRestartConfig
for thisMapConfig
List<IndexConfig>
getIndexConfigs()
InMemoryFormat
getInMemoryFormat()
Returns the data type that will be used for storing records.MapStoreConfig
getMapStoreConfig()
Returns the map store configurationint
getMaxIdleSeconds()
Returns the maximum number of seconds for each entry to stay idle in the map.MergePolicyConfig
getMergePolicyConfig()
Gets theMergePolicyConfig
for this map.MerkleTreeConfig
getMerkleTreeConfig()
Gets theMerkleTreeConfig
for thisMapConfig
MetadataPolicy
getMetadataPolicy()
ReturnsMetadataPolicy
for this map.String
getName()
Returns the name of thisIMap
NearCacheConfig
getNearCacheConfig()
Returns the Near Cache configurationPartitioningStrategyConfig
getPartitioningStrategyConfig()
List<MapPartitionLostListenerConfig>
getPartitionLostListenerConfigs()
List<QueryCacheConfig>
getQueryCacheConfigs()
Returns allQueryCacheConfig
instances defined on thisMapConfig
.String
getSplitBrainProtectionName()
int
getTimeToLiveSeconds()
Returns the maximum number of seconds for each entry to stay in the map.int
getTotalBackupCount()
Returns the total number of backups: backupCount plus asyncBackupCount.WanReplicationRef
getWanReplicationRef()
Gets the WAN target replication reference.int
hashCode()
boolean
isNearCacheEnabled()
Checks if Near Cache is enabled.boolean
isReadBackupData()
Checks if read-backup-data (reading local backup entries) is enabled for this map.boolean
isStatisticsEnabled()
Checks if statistics are enabled for this map.void
readData(ObjectDataInput in)
Reads fields from the input streamMapConfig
setAsyncBackupCount(int asyncBackupCount)
Sets the number of asynchronous backups.MapConfig
setAttributeConfigs(List<AttributeConfig> attributeConfigs)
MapConfig
setBackupCount(int backupCount)
Number of synchronous backups.MapConfig
setCacheDeserializedValues(CacheDeserializedValues cacheDeserializedValues)
Configure de-serialized value caching.MapConfig
setEntryListenerConfigs(List<EntryListenerConfig> listenerConfigs)
MapConfig
setEventJournalConfig(EventJournalConfig eventJournalConfig)
Sets theEventJournalConfig
for thisMapConfig
MapConfig
setEvictionConfig(EvictionConfig evictionConfig)
Sets theEvictionConfig
instance for eviction configuration for thisIMap
.MapConfig
setHotRestartConfig(HotRestartConfig hotRestartConfig)
Sets theHotRestartConfig
for thisMapConfig
MapConfig
setIndexConfigs(List<IndexConfig> indexConfigs)
MapConfig
setInMemoryFormat(InMemoryFormat inMemoryFormat)
Binary type that will be used for storing records.MapConfig
setMapStoreConfig(MapStoreConfig mapStoreConfig)
Sets the map store configurationMapConfig
setMaxIdleSeconds(int maxIdleSeconds)
Maximum number of seconds for each entry to stay idle in the map.MapConfig
setMergePolicyConfig(MergePolicyConfig mergePolicyConfig)
Sets theMergePolicyConfig
for this map.MapConfig
setMerkleTreeConfig(MerkleTreeConfig merkleTreeConfig)
Sets theMerkleTreeConfig
for thisMapConfig
MapConfig
setMetadataPolicy(MetadataPolicy metadataPolicy)
Sets the metadata policy.MapConfig
setName(String name)
Sets the name of theIMap
MapConfig
setNearCacheConfig(NearCacheConfig nearCacheConfig)
Sets the Near Cache configurationMapConfig
setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig)
MapConfig
setPartitionLostListenerConfigs(List<MapPartitionLostListenerConfig> listenerConfigs)
MapConfig
setQueryCacheConfigs(List<QueryCacheConfig> queryCacheConfigs)
SetsQueryCacheConfig
instances to thisMapConfig
.MapConfig
setReadBackupData(boolean readBackupData)
Sets read-backup-data (reading local backup entries) for this map.MapConfig
setSplitBrainProtectionName(String splitBrainProtectionName)
MapConfig
setStatisticsEnabled(boolean statisticsEnabled)
Sets statistics to enabled or disabled for this map.MapConfig
setTimeToLiveSeconds(int timeToLiveSeconds)
The maximum number of seconds for each entry to stay in the map.MapConfig
setWanReplicationRef(WanReplicationRef wanReplicationRef)
Sets the WAN target replication reference.String
toString()
void
writeData(ObjectDataOutput out)
Writes object fields to output stream
-
Field Details
-
MIN_BACKUP_COUNT
public static final int MIN_BACKUP_COUNTThe minimum number of backups- See Also:
- Constant Field Values
-
DEFAULT_BACKUP_COUNT
public static final int DEFAULT_BACKUP_COUNTThe default number of backups- See Also:
- Constant Field Values
-
MAX_BACKUP_COUNT
public static final int MAX_BACKUP_COUNTThe maximum number of backups- See Also:
- Constant Field Values
-
DEFAULT_TTL_SECONDS
public static final int DEFAULT_TTL_SECONDSThe number of default Time to Live in seconds.- See Also:
- Constant Field Values
-
DEFAULT_MAX_IDLE_SECONDS
public static final int DEFAULT_MAX_IDLE_SECONDSThe number of default time to wait eviction in seconds.- See Also:
- Constant Field Values
-
DEFAULT_IN_MEMORY_FORMAT
Default In-Memory format is binary. -
DEFAULT_CACHED_DESERIALIZED_VALUES
We want to cache values only when an index is defined. -
DEFAULT_METADATA_POLICY
Default metadata policy -
DEFAULT_STATISTICS_ENABLED
public static final boolean DEFAULT_STATISTICS_ENABLEDDefault value of whether statistics are enabled or not- See Also:
- Constant Field Values
-
DEFAULT_MAX_SIZE
public static final int DEFAULT_MAX_SIZEDefault max size.- See Also:
- Constant Field Values
-
DEFAULT_MAX_SIZE_POLICY
Default max size policy -
DEFAULT_EVICTION_POLICY
Default eviction policy
-
-
Constructor Details
-
Method Details
-
getName
Returns the name of thisIMap
- Specified by:
getName
in interfaceNamedConfig
- Returns:
- the name of the
IMap
-
setName
Sets the name of theIMap
- Specified by:
setName
in interfaceNamedConfig
- Parameters:
name
- the name to set for thisIMap
-
getInMemoryFormat
Returns the data type that will be used for storing records.- Returns:
- data type that will be used for storing records
-
setInMemoryFormat
Binary type that will be used for storing records. Possible values:- BINARY (default): keys and values will be stored as binary data
- OBJECT: values will be stored in their object forms
- NATIVE: values will be stored in non-heap region of JVM (Hazelcast Enterprise only)
- Parameters:
inMemoryFormat
- the record type to set for thisIMap
- Throws:
IllegalArgumentException
- if inMemoryFormat isnull
-
getEvictionConfig
Gets theEvictionConfig
instance of the eviction configuration for thisIMap
.- Returns:
- the
EvictionConfig
instance of the eviction configuration
-
setEvictionConfig
Sets theEvictionConfig
instance for eviction configuration for thisIMap
.- Parameters:
evictionConfig
- theEvictionConfig
instance to set for the eviction configuration- Returns:
- current map config instance
-
getBackupCount
public int getBackupCount()Returns the backupCount for thisIMap
- Returns:
- the backupCount for this
IMap
- See Also:
getAsyncBackupCount()
-
setBackupCount
Number of synchronous backups. For example, if 1 is set as the backup count, then all entries of the map will be copied to another JVM for fail-safety. 0 means no sync backup.- Parameters:
backupCount
- the number of synchronous backups to set for thisIMap
- See Also:
setAsyncBackupCount(int)
-
getAsyncBackupCount
public int getAsyncBackupCount()Returns the asynchronous backup count for thisIMap
.- Returns:
- the asynchronous backup count
- See Also:
setBackupCount(int)
-
setAsyncBackupCount
Sets the number of asynchronous backups. 0 means no backups.- Parameters:
asyncBackupCount
- the number of asynchronous synchronous backups to set- Returns:
- the updated CacheConfig
- Throws:
IllegalArgumentException
- if asyncBackupCount smaller than 0, or larger than the maximum number of backup or the sum of the backups and async backups is larger than the maximum number of backups- See Also:
setBackupCount(int)
,getAsyncBackupCount()
-
getTotalBackupCount
public int getTotalBackupCount()Returns the total number of backups: backupCount plus asyncBackupCount.- Returns:
- the total number of backups: synchronous + asynchronous
-
getTimeToLiveSeconds
public int getTimeToLiveSeconds()Returns the maximum number of seconds for each entry to stay in the map.- Returns:
- the maximum number of seconds for each entry to stay in the map
-
setTimeToLiveSeconds
The maximum number of seconds for each entry to stay in the map. Entries that are older than timeToLiveSeconds will be automatically evicted from the map. Updates on the entry will change the eviction time. Any integer between 0 and Integer.MAX_VALUE. 0 means infinite. Default is 0.- Parameters:
timeToLiveSeconds
- the timeToLiveSeconds to set
-
getMaxIdleSeconds
public int getMaxIdleSeconds()Returns the maximum number of seconds for each entry to stay idle in the map.- Returns:
- the maximum number of seconds for each entry to stay idle in the map
-
setMaxIdleSeconds
Maximum number of seconds for each entry to stay idle in the map. Entries that are idle (not touched) for more thanmaxIdleSeconds
will get automatically evicted from the map. Entry is touched ifget()
,getAll()
,put()
orcontainsKey()
is called. Any integer between0
andInteger.MAX_VALUE
.0
means infinite. Default is0
. The time precision is limited by 1 second. The MaxIdle that less than 1 second can lead to unexpected behaviour.- Parameters:
maxIdleSeconds
- the maxIdleSeconds (the maximum number of seconds for each entry to stay idle in the map) to set
-
getMapStoreConfig
Returns the map store configuration- Returns:
- the mapStoreConfig (map store configuration)
-
setMapStoreConfig
Sets the map store configuration- Parameters:
mapStoreConfig
- the mapStoreConfig (map store configuration) to set
-
getNearCacheConfig
Returns the Near Cache configuration- Returns:
- the Near Cache configuration
-
setNearCacheConfig
Sets the Near Cache configuration- Parameters:
nearCacheConfig
- the Near Cache configuration- Returns:
- the updated map configuration
-
getMergePolicyConfig
Gets theMergePolicyConfig
for this map.- Returns:
- the
MergePolicyConfig
for this map
-
setMergePolicyConfig
Sets theMergePolicyConfig
for this map.- Returns:
- the updated map configuration
-
isStatisticsEnabled
public boolean isStatisticsEnabled()Checks if statistics are enabled for this map.- Returns:
true
if statistics are enabled,false
otherwise
-
setStatisticsEnabled
Sets statistics to enabled or disabled for this map.- Parameters:
statisticsEnabled
-true
to enable map statistics,false
to disable- Returns:
- the current map config instance
-
isReadBackupData
public boolean isReadBackupData()Checks if read-backup-data (reading local backup entries) is enabled for this map.- Returns:
true
if read-backup-data is enabled,false
otherwise
-
setReadBackupData
Sets read-backup-data (reading local backup entries) for this map.- Parameters:
readBackupData
-true
to enable read-backup-data,false
to disable- Returns:
- the current map config instance
-
getWanReplicationRef
Gets the WAN target replication reference.- Returns:
- the WAN target replication reference
-
setWanReplicationRef
Sets the WAN target replication reference.- Parameters:
wanReplicationRef
- the WAN target replication reference- Returns:
- the current map config instance
-
addEntryListenerConfig
-
getEntryListenerConfigs
-
setEntryListenerConfigs
-
addMapPartitionLostListenerConfig
-
getPartitionLostListenerConfigs
-
setPartitionLostListenerConfigs
public MapConfig setPartitionLostListenerConfigs(List<MapPartitionLostListenerConfig> listenerConfigs) -
addIndexConfig
-
getIndexConfigs
-
setIndexConfigs
-
addAttributeConfig
-
getAttributeConfigs
-
setAttributeConfigs
-
getMetadataPolicy
ReturnsMetadataPolicy
for this map.- Returns:
MetadataPolicy
for this map
-
setMetadataPolicy
Sets the metadata policy. SeeMetadataPolicy
for more information.- Parameters:
metadataPolicy
- the metadata policy
-
addQueryCacheConfig
Adds a newQueryCacheConfig
to thisMapConfig
.- Parameters:
queryCacheConfig
- the config to be added- Returns:
- this
MapConfig
instance - Throws:
IllegalArgumentException
- if there is already aQueryCache
with the sameQueryCacheConfig#name
-
getQueryCacheConfigs
Returns allQueryCacheConfig
instances defined on thisMapConfig
.- Returns:
- all
QueryCacheConfig
instances defined on thisMapConfig
-
setQueryCacheConfigs
SetsQueryCacheConfig
instances to thisMapConfig
.- Returns:
- this configuration
-
getPartitioningStrategyConfig
-
setPartitioningStrategyConfig
public MapConfig setPartitioningStrategyConfig(PartitioningStrategyConfig partitioningStrategyConfig) -
isNearCacheEnabled
public boolean isNearCacheEnabled()Checks if Near Cache is enabled.- Returns:
true
if Near Cache is enabled,false
otherwise
-
setCacheDeserializedValues
Configure de-serialized value caching. Default:CacheDeserializedValues.INDEX_ONLY
- Returns:
- this
MapConfig
instance - Since:
- 3.6
- See Also:
CacheDeserializedValues
-
getHotRestartConfig
Gets theHotRestartConfig
for thisMapConfig
- Returns:
- hot restart config
-
setHotRestartConfig
Sets theHotRestartConfig
for thisMapConfig
- Parameters:
hotRestartConfig
- hot restart config- Returns:
- this
MapConfig
instance
-
getMerkleTreeConfig
Gets theMerkleTreeConfig
for thisMapConfig
- Returns:
- merkle tree config
-
setMerkleTreeConfig
Sets theMerkleTreeConfig
for thisMapConfig
- Parameters:
merkleTreeConfig
- merkle tree config- Returns:
- this
MapConfig
instance
-
getEventJournalConfig
Gets theEventJournalConfig
for thisMapConfig
- Returns:
- event journal config
-
setEventJournalConfig
Sets theEventJournalConfig
for thisMapConfig
- Parameters:
eventJournalConfig
- event journal config- Returns:
- this
MapConfig
instance
-
getCacheDeserializedValues
Get current value cache settings- Returns:
- current value cache settings
- Since:
- 3.6
-
getSplitBrainProtectionName
-
setSplitBrainProtectionName
-
equals
-
hashCode
public final int hashCode() -
toString
-
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.
-