public class CacheSimpleConfig extends Object implements IdentifiedDataSerializable, NamedConfig, com.hazelcast.nio.serialization.impl.Versioned
Modifier and Type | Class and Description |
---|---|
static class |
CacheSimpleConfig.ExpiryPolicyFactoryConfig
Represents configuration for "ExpiryPolicyFactory".
|
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_BACKUP_COUNT
The default number of backups.
|
static InMemoryFormat |
DEFAULT_IN_MEMORY_FORMAT
Default InMemory Format.
|
static int |
MAX_BACKUP_COUNT
The maximum number of backups.
|
static int |
MIN_BACKUP_COUNT
The minimum number of backups.
|
Constructor and Description |
---|
CacheSimpleConfig() |
CacheSimpleConfig(CacheSimpleConfig cacheSimpleConfig) |
CacheSimpleConfig(String name)
Create a Cache Simple Config for a cache with a specific name.
|
Modifier and Type | Method and Description |
---|---|
CacheSimpleConfig |
addCachePartitionLostListenerConfig(CachePartitionLostListenerConfig listenerConfig)
Adds the CachePartitionLostListenerConfig to partitionLostListenerConfigs.
|
CacheSimpleConfig |
addEntryListenerConfig(CacheSimpleEntryListenerConfig listenerConfig)
Adds
CacheSimpleEntryListenerConfig to this ICache . |
boolean |
equals(Object o) |
int |
getAsyncBackupCount()
Gets the number of asynchronous backups for this
ICache . |
int |
getBackupCount()
Gets the number of synchronous backups for this
ICache . |
List<CacheSimpleEntryListenerConfig> |
getCacheEntryListeners()
Gets a list of
CacheSimpleEntryListenerConfig from this ICache . |
String |
getCacheLoader()
Get classname of a class to be used as
CacheLoader . |
String |
getCacheLoaderFactory()
Gets the factory for the
CacheLoader . |
String |
getCacheWriter()
Get classname of a class to be used as
CacheWriter . |
String |
getCacheWriterFactory()
Gets the factory for the
CacheWriter . |
int |
getClassId()
Returns type identifier for this class.
|
DataPersistenceConfig |
getDataPersistenceConfig()
Gets the
DataPersistenceConfig for this CacheSimpleConfig |
EventJournalConfig |
getEventJournalConfig()
Gets the
EventJournalConfig for this CacheSimpleConfig |
EvictionConfig |
getEvictionConfig()
Gets the eviction configuration for this
ICache . |
CacheSimpleConfig.ExpiryPolicyFactoryConfig |
getExpiryPolicyFactoryConfig()
Gets the factory configuration for the
ExpiryPolicy . |
int |
getFactoryId()
Returns DataSerializableFactory factory ID for this class.
|
HotRestartConfig |
getHotRestartConfig()
Gets the
HotRestartConfig for this CacheSimpleConfig |
InMemoryFormat |
getInMemoryFormat()
Gets the InMemory Format for this
ICache . |
String |
getKeyType()
Gets the key type for this
ICache . |
MergePolicyConfig |
getMergePolicyConfig()
Gets the
MergePolicyConfig for this map. |
MerkleTreeConfig |
getMerkleTreeConfig()
Gets the
MerkleTreeConfig for this CacheSimpleConfig |
String |
getName()
Gets the name of this
ICache . |
List<CachePartitionLostListenerConfig> |
getPartitionLostListenerConfigs()
Gets the partition lost listener references added to cache configuration.
|
String |
getSplitBrainProtectionName()
Gets the name of the associated split brain protection if any.
|
String |
getValueType()
Gets the value type for this
ICache . |
WanReplicationRef |
getWanReplicationRef()
Gets the WAN target replication reference.
|
int |
hashCode() |
boolean |
isDisablePerEntryInvalidationEvents()
Returns invalidation events disabled status for per entry.
|
boolean |
isManagementEnabled()
Checks if management is enabled for this
ICache . |
boolean |
isReadThrough()
Checks if this
ICache is read-through: a read loads the entry from the data store
if it is not already in the cache. |
boolean |
isStatisticsEnabled()
Checks if statistics are enabled for this
ICache . |
boolean |
isWriteThrough()
Checks if the
ICache is write-through: a write to the queue also loads the entry
into the data store. |
void |
readData(ObjectDataInput in)
Reads fields from the input stream
|
CacheSimpleConfig |
setAsyncBackupCount(int asyncBackupCount)
Sets the number of asynchronous backups for this
ICache . |
CacheSimpleConfig |
setBackupCount(int backupCount)
Sets the number of synchronous backups for this
ICache . |
CacheSimpleConfig |
setCacheEntryListeners(List<CacheSimpleEntryListenerConfig> cacheEntryListeners)
Sets a list of
CacheSimpleEntryListenerConfig for this ICache . |
CacheSimpleConfig |
setCacheLoader(String cacheLoader)
Set classname of a class to be used as
CacheLoader . |
CacheSimpleConfig |
setCacheLoaderFactory(String cacheLoaderFactory)
Sets the factory for this
CacheLoader . |
CacheSimpleConfig |
setCacheWriter(String cacheWriter)
Set classname of a class to be used as
CacheWriter . |
CacheSimpleConfig |
setCacheWriterFactory(String cacheWriterFactory)
Sets the factory for this
CacheWriter . |
CacheSimpleConfig |
setDataPersistenceConfig(DataPersistenceConfig dataPersistenceConfig)
Sets the
DataPersistenceConfig for this CacheSimpleConfig |
CacheSimpleConfig |
setDisablePerEntryInvalidationEvents(boolean disablePerEntryInvalidationEvents)
Sets invalidation events disabled status for per entry.
|
CacheSimpleConfig |
setEventJournalConfig(EventJournalConfig eventJournalConfig)
Sets the
EventJournalConfig for this CacheSimpleConfig |
CacheSimpleConfig |
setEvictionConfig(EvictionConfig evictionConfig)
Sets the eviction configuration for this
ICache . |
CacheSimpleConfig |
setExpiryPolicyFactory(String className)
Sets the factory for this
ExpiryPolicy . |
CacheSimpleConfig |
setExpiryPolicyFactoryConfig(CacheSimpleConfig.ExpiryPolicyFactoryConfig expiryPolicyFactoryConfig)
Sets the factory configuration for this
ExpiryPolicy . |
CacheSimpleConfig |
setHotRestartConfig(HotRestartConfig hotRestartConfig)
Deprecated.
since 5.0 use
setDataPersistenceConfig(DataPersistenceConfig) |
CacheSimpleConfig |
setInMemoryFormat(InMemoryFormat inMemoryFormat)
Sets the InMemory Format for this
ICache . |
CacheSimpleConfig |
setKeyType(String keyType)
Sets the key type for this
ICache . |
CacheSimpleConfig |
setManagementEnabled(boolean managementEnabled)
Sets management to enabled or disabled for this
ICache . |
CacheSimpleConfig |
setMergePolicyConfig(MergePolicyConfig mergePolicyConfig)
Sets the
MergePolicyConfig for this map. |
CacheSimpleConfig |
setMerkleTreeConfig(MerkleTreeConfig merkleTreeConfig)
Sets the
MerkleTreeConfig for this CacheSimpleConfig |
CacheSimpleConfig |
setName(String name)
Sets the name of this
ICache . |
CacheSimpleConfig |
setPartitionLostListenerConfigs(List<CachePartitionLostListenerConfig> partitionLostListenerConfigs)
Sets the PartitionLostListenerConfigs.
|
CacheSimpleConfig |
setReadThrough(boolean readThrough)
Enables or disables read-through: a read loads the entry from the data store if it is not already in the cache.
|
CacheSimpleConfig |
setSplitBrainProtectionName(String splitBrainProtectionName)
Associates this cache configuration to a split brain protection.
|
CacheSimpleConfig |
setStatisticsEnabled(boolean statisticsEnabled)
Sets statistics to enabled or disabled for this
ICache . |
CacheSimpleConfig |
setValueType(String valueType)
Sets the value type for this
ICache . |
CacheSimpleConfig |
setWanReplicationRef(WanReplicationRef wanReplicationRef)
Sets the WAN target replication reference.
|
CacheSimpleConfig |
setWriteThrough(boolean writeThrough)
Enables or disables write-through for this
ICache : a write to the queue also loads
the entry into the data store. |
String |
toString() |
void |
writeData(ObjectDataOutput out)
Writes object fields to output stream
|
public static final int MIN_BACKUP_COUNT
public static final int MAX_BACKUP_COUNT
public static final int DEFAULT_BACKUP_COUNT
public static final InMemoryFormat DEFAULT_IN_MEMORY_FORMAT
public CacheSimpleConfig(CacheSimpleConfig cacheSimpleConfig)
public CacheSimpleConfig(String name)
name
- cache namepublic CacheSimpleConfig()
public String getName()
ICache
.getName
in interface NamedConfig
ICache
public CacheSimpleConfig setName(String name)
ICache
.setName
in interface NamedConfig
name
- the name to set for this ICache
public CacheSimpleConfig setKeyType(String keyType)
ICache
.keyType
- the key type to set for this ICache
public String getValueType()
ICache
.ICache
public CacheSimpleConfig setValueType(String valueType)
ICache
.valueType
- the value type to set for this ICache
public boolean isStatisticsEnabled()
ICache
.true
if statistics are enabled, false
otherwisepublic CacheSimpleConfig setStatisticsEnabled(boolean statisticsEnabled)
ICache
.statisticsEnabled
- true
to enable cache statistics, false
to disablepublic boolean isManagementEnabled()
ICache
.true
if cache management is enabled, false
otherwisepublic CacheSimpleConfig setManagementEnabled(boolean managementEnabled)
ICache
.managementEnabled
- true
to enable cache management, false
to disablepublic boolean isReadThrough()
ICache
is read-through: a read loads the entry from the data store
if it is not already in the cache.true
if the cache is read-through, false
otherwisepublic CacheSimpleConfig setReadThrough(boolean readThrough)
readThrough
- true
to enable read-through for this ICache
,
false
to disablepublic boolean isWriteThrough()
ICache
is write-through: a write to the queue also loads the entry
into the data store.true
if the cache is write-through, false
otherwisepublic CacheSimpleConfig setWriteThrough(boolean writeThrough)
ICache
: a write to the queue also loads
the entry into the data store.writeThrough
- true
to enable write-through, false
to disablepublic String getCacheLoaderFactory()
CacheLoader
.CacheLoader
public CacheSimpleConfig setCacheLoaderFactory(String cacheLoaderFactory)
CacheLoader
.cacheLoaderFactory
- the factory to set for this CacheLoader
public String getCacheLoader()
CacheLoader
.CacheLoader
public CacheSimpleConfig setCacheLoader(String cacheLoader)
CacheLoader
.cacheLoader
- classname to be used as CacheLoader
public String getCacheWriterFactory()
CacheWriter
.CacheWriter
public CacheSimpleConfig setCacheWriterFactory(String cacheWriterFactory)
CacheWriter
.cacheWriterFactory
- the factory to set for this CacheWriter
public String getCacheWriter()
CacheWriter
.CacheWriter
public CacheSimpleConfig setCacheWriter(String cacheWriter)
CacheWriter
.cacheWriter
- classname to be used as CacheWriter
public CacheSimpleConfig.ExpiryPolicyFactoryConfig getExpiryPolicyFactoryConfig()
ExpiryPolicy
.ExpiryPolicy
public CacheSimpleConfig setExpiryPolicyFactoryConfig(CacheSimpleConfig.ExpiryPolicyFactoryConfig expiryPolicyFactoryConfig)
ExpiryPolicy
.expiryPolicyFactoryConfig
- the factory configuration to set for this ExpiryPolicy
public CacheSimpleConfig setExpiryPolicyFactory(String className)
ExpiryPolicy
.className
- the factory to set for this ExpiryPolicy
public CacheSimpleConfig addEntryListenerConfig(CacheSimpleEntryListenerConfig listenerConfig)
CacheSimpleEntryListenerConfig
to this ICache
.CacheSimpleConfig
instancepublic List<CacheSimpleEntryListenerConfig> getCacheEntryListeners()
CacheSimpleEntryListenerConfig
from this ICache
.CacheSimpleEntryListenerConfig
public CacheSimpleConfig setCacheEntryListeners(List<CacheSimpleEntryListenerConfig> cacheEntryListeners)
CacheSimpleEntryListenerConfig
for this ICache
.cacheEntryListeners
- list of CacheSimpleEntryListenerConfig
CacheSimpleConfig
instancepublic int getAsyncBackupCount()
ICache
.ICache
public CacheSimpleConfig setAsyncBackupCount(int asyncBackupCount)
ICache
.asyncBackupCount
- the number of asynchronous synchronous backups to setIllegalArgumentException
- if asyncBackupCount smaller than 0,
or larger than the maximum number of backups,
or the sum of the backups and async backups is larger than the maximum number of backupssetBackupCount(int)
,
getAsyncBackupCount()
public int getBackupCount()
ICache
.public CacheSimpleConfig setBackupCount(int backupCount)
ICache
.backupCount
- the new backupCountIllegalArgumentException
- if backupCount 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 backupspublic InMemoryFormat getInMemoryFormat()
ICache
.public CacheSimpleConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)
ICache
.inMemoryFormat
- the InMemory Formatpublic EvictionConfig getEvictionConfig()
ICache
.public CacheSimpleConfig setEvictionConfig(EvictionConfig evictionConfig)
ICache
.evictionConfig
- the eviction configuration to setpublic WanReplicationRef getWanReplicationRef()
public CacheSimpleConfig setWanReplicationRef(WanReplicationRef wanReplicationRef)
wanReplicationRef
- the WAN target replication referencepublic List<CachePartitionLostListenerConfig> getPartitionLostListenerConfigs()
public CacheSimpleConfig setPartitionLostListenerConfigs(List<CachePartitionLostListenerConfig> partitionLostListenerConfigs)
partitionLostListenerConfigs
- CachePartitionLostListenerConfig listpublic CacheSimpleConfig addCachePartitionLostListenerConfig(CachePartitionLostListenerConfig listenerConfig)
listenerConfig
- CachePartitionLostListenerConfig to be addedpublic String getSplitBrainProtectionName()
public CacheSimpleConfig setSplitBrainProtectionName(String splitBrainProtectionName)
splitBrainProtectionName
- name of the desired split brain protectionpublic MergePolicyConfig getMergePolicyConfig()
MergePolicyConfig
for this map.MergePolicyConfig
for this mappublic CacheSimpleConfig setMergePolicyConfig(MergePolicyConfig mergePolicyConfig)
MergePolicyConfig
for this map.public HotRestartConfig getHotRestartConfig()
HotRestartConfig
for this CacheSimpleConfig
public DataPersistenceConfig getDataPersistenceConfig()
DataPersistenceConfig
for this CacheSimpleConfig
@Deprecated public CacheSimpleConfig setHotRestartConfig(HotRestartConfig hotRestartConfig)
setDataPersistenceConfig(DataPersistenceConfig)
HotRestartConfig
for this CacheSimpleConfig
hotRestartConfig
- hot restart configCacheSimpleConfig
instancepublic CacheSimpleConfig setDataPersistenceConfig(DataPersistenceConfig dataPersistenceConfig)
DataPersistenceConfig
for this CacheSimpleConfig
dataPersistenceConfig
- dataPersistenceConfig configCacheSimpleConfig
instancepublic EventJournalConfig getEventJournalConfig()
EventJournalConfig
for this CacheSimpleConfig
public CacheSimpleConfig setEventJournalConfig(@Nonnull EventJournalConfig eventJournalConfig)
EventJournalConfig
for this CacheSimpleConfig
eventJournalConfig
- event journal configCacheSimpleConfig
instancepublic boolean isDisablePerEntryInvalidationEvents()
true
if invalidation events are disabled for per entry, false
otherwisepublic CacheSimpleConfig setDisablePerEntryInvalidationEvents(boolean disablePerEntryInvalidationEvents)
disablePerEntryInvalidationEvents
- Disables invalidation event sending behaviour if it is true
,
otherwise enables it@Nonnull public MerkleTreeConfig getMerkleTreeConfig()
MerkleTreeConfig
for this CacheSimpleConfig
public CacheSimpleConfig setMerkleTreeConfig(@Nonnull MerkleTreeConfig merkleTreeConfig)
MerkleTreeConfig
for this CacheSimpleConfig
merkleTreeConfig
- merkle tree configCacheSimpleConfig
instancepublic int getFactoryId()
IdentifiedDataSerializable
getFactoryId
in interface IdentifiedDataSerializable
public int getClassId()
IdentifiedDataSerializable
getClassId
in interface IdentifiedDataSerializable
public void writeData(ObjectDataOutput out) throws IOException
DataSerializable
writeData
in interface DataSerializable
out
- outputIOException
- if an I/O error occurs. In particular,
an IOException
may be thrown if the
output stream has been closed.public void readData(ObjectDataInput in) throws IOException
DataSerializable
readData
in interface DataSerializable
in
- inputIOException
- if an I/O error occurs. In particular,
an IOException
may be thrown if the
input stream has been closed.Copyright © 2023 Hazelcast, Inc.. All rights reserved.