com.hazelcast.config

Class CacheSimpleConfig

java.lang.Object

com.hazelcast.config.CacheSimpleConfig

Direct Known Subclasses:

CacheSimpleConfigReadOnly

public class CacheSimpleConfig
extends Object

Simple configuration to hold parsed XML configuration. CacheConfig depends on the JCache API. If the JCache API is not in the classpath, you can use CacheSimpleConfig as a communicator between the code and CacheConfig.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CacheSimpleConfig.ExpiryPolicyFactoryConfig Represents configuration for "ExpiryPolicyFactory".

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BACKUP_COUNT The default number of backups.
static String	DEFAULT_CACHE_MERGE_POLICY Default policy for merging
static EvictionPolicy	DEFAULT_EVICTION_POLICY Default Eviction Policy.
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 Summary

Constructors

Constructor and Description
CacheSimpleConfig()
CacheSimpleConfig(CacheSimpleConfig cacheSimpleConfig)

Method Summary

Methods

Modifier and Type	Method and Description
CacheSimpleConfig	addCachePartitionLostListenerConfig(CachePartitionLostListenerConfig listenerConfig) Adds the CachePartitionLostListenerConfig to partitionLostListenerConfigs.
CacheSimpleConfig	addEntryListenerConfig(CacheSimpleEntryListenerConfig listenerConfig) Adds CacheSimpleEntryListenerConfig to this ICache.
CacheSimpleConfig	getAsReadOnly() Gets the immutable version of this simple cache config.
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	getCacheLoaderFactory() Gets the factory for the CacheLoader.
String	getCacheWriterFactory() Gets the factory for the CacheWriter.
EvictionConfig	getEvictionConfig() Gets the eviction configuration for this ICache.
CacheSimpleConfig.ExpiryPolicyFactoryConfig	getExpiryPolicyFactoryConfig() Gets the factory configuration for the ExpiryPolicy.
InMemoryFormat	getInMemoryFormat() Gets the InMemory Format for this ICache.
String	getKeyType() Gets the key type for this ICache.
String	getMergePolicy() Gets the class name of CacheMergePolicy implementation of this cache config.
String	getName() Gets the name of this ICache.
List<CachePartitionLostListenerConfig>	getPartitionLostListenerConfigs() Gets the partition lost listener references added to cache configuration.
String	getQuorumName() Gets the name of the associated quorum if any.
String	getValueType() Gets the value type for this ICache.
WanReplicationRef	getWanReplicationRef() Gets the WAN target replication reference.
boolean	isHotRestartEnabled() Returns whether hot restart enabled on this cache.
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.
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	setCacheLoaderFactory(String cacheLoaderFactory) Sets the factory for this CacheLoader.
CacheSimpleConfig	setCacheWriterFactory(String cacheWriterFactory) Sets the factory for this CacheWriter.
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	setHotRestartEnabled(boolean hotRestart) Sets whether hot restart is enabled on this cache.
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.
void	setMergePolicy(String mergePolicy) Sets the class name of CacheMergePolicy implementation to this cache config.
CacheSimpleConfig	setName(String name) Sets the name of this ICache.
CacheSimpleConfig	setPartitionLostListenerConfigs(List<CachePartitionLostListenerConfig> partitionLostListenerConfigs) Sets the PartitionLostListenerConfigs.
CacheSimpleConfig	setQuorumName(String quorumName) Associates this cache configuration to a quorum.
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	setStatisticsEnabled(boolean statisticsEnabled) Sets statistics to enabled or disabled for this ICache.
CacheSimpleConfig	setValueType(String valueType) Sets the value type for this ICache.
void	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.

Methods inherited from class java.lang.Object

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

Field Detail

MIN_BACKUP_COUNT

public static final int MIN_BACKUP_COUNT

The minimum number of backups.

See Also:

Constant Field Values

MAX_BACKUP_COUNT

public static final int MAX_BACKUP_COUNT

The maximum number of backups.

See Also:

Constant Field Values

DEFAULT_BACKUP_COUNT

public static final int DEFAULT_BACKUP_COUNT

The default number of backups.

See Also:

Constant Field Values

DEFAULT_IN_MEMORY_FORMAT

public static final InMemoryFormat DEFAULT_IN_MEMORY_FORMAT

Default InMemory Format.

DEFAULT_EVICTION_POLICY

public static final EvictionPolicy DEFAULT_EVICTION_POLICY

Default Eviction Policy.

DEFAULT_CACHE_MERGE_POLICY

public static final String DEFAULT_CACHE_MERGE_POLICY

Default policy for merging

Constructor Detail

CacheSimpleConfig

public CacheSimpleConfig(CacheSimpleConfig cacheSimpleConfig)

CacheSimpleConfig

public CacheSimpleConfig()

Method Detail

getAsReadOnly

public CacheSimpleConfig getAsReadOnly()

Gets the immutable version of this simple cache config.

Returns:

Immutable version of this simple cache config.

getName

public String getName()

Gets the name of this ICache.

Returns:

the name of the ICache.

setName

public CacheSimpleConfig setName(String name)

Sets the name of this ICache.

Parameters:

name - The name to set for this ICache.

Returns:

The current cache config instance.

getKeyType

public String getKeyType()

Gets the key type for this ICache.

Returns:

The key type.

setKeyType

public CacheSimpleConfig setKeyType(String keyType)

Sets the key type for this ICache.

Parameters:

keyType - The key type to set for this ICache.

Returns:

The current cache config instance.

getValueType

public String getValueType()

Gets the value type for this ICache.

Returns:

The value type for this ICache.

setValueType

public CacheSimpleConfig setValueType(String valueType)

Sets the value type for this ICache.

Parameters:

valueType - The value type to set for this ICache.

Returns:

The current cache config instance.

isStatisticsEnabled

public boolean isStatisticsEnabled()

Checks if statistics are enabled for this ICache.

Returns:

True if statistics are enabled, false otherwise.

setStatisticsEnabled

public CacheSimpleConfig setStatisticsEnabled(boolean statisticsEnabled)

Sets statistics to enabled or disabled for this ICache.

Parameters:

statisticsEnabled - True to enable cache statistics, false to disable.

Returns:

The current cache config instance.

isManagementEnabled

public boolean isManagementEnabled()

Checks if management is enabled for this ICache.

Returns:

True if cache management is enabled, false otherwise.

setManagementEnabled

public CacheSimpleConfig setManagementEnabled(boolean managementEnabled)

Sets management to enabled or disabled for this ICache.

Parameters:

managementEnabled - True to enable cache management, false to disable.

Returns:

The current cache config instance.

isReadThrough

public 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.

Returns:

True if the cache is read-through, false otherwise.

setReadThrough

public 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.

Parameters:

readThrough - True to enable read-through for this ICache, false to disable.

Returns:

The current cache config instance.

isWriteThrough

public boolean isWriteThrough()

Checks if the ICache is write-through: a write to the queue also loads the entry into the data store.

Returns:

True if the cache is write-through, false otherwise.

setWriteThrough

public 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.

Parameters:

writeThrough - True to enable write-through, false to disable.

Returns:

The current cache config instance.

getCacheLoaderFactory

public String getCacheLoaderFactory()

Gets the factory for the CacheLoader.

Returns:

The factory for the CacheLoader.

setCacheLoaderFactory

public CacheSimpleConfig setCacheLoaderFactory(String cacheLoaderFactory)

Sets the factory for this CacheLoader.

Parameters:

cacheLoaderFactory - The factory to set for this CacheLoader.

Returns:

The current cache config instance.

getCacheWriterFactory

public String getCacheWriterFactory()

Gets the factory for the CacheWriter.

Returns:

The factory for the CacheWriter.

setCacheWriterFactory

public CacheSimpleConfig setCacheWriterFactory(String cacheWriterFactory)

Sets the factory for this CacheWriter.

Parameters:

cacheWriterFactory - The factory to set for this CacheWriter.

Returns:

The current cache config instance.

getExpiryPolicyFactoryConfig

public CacheSimpleConfig.ExpiryPolicyFactoryConfig getExpiryPolicyFactoryConfig()

Gets the factory configuration for the ExpiryPolicy.

Returns:

The factory configuration for the ExpiryPolicy.

setExpiryPolicyFactoryConfig

public CacheSimpleConfig setExpiryPolicyFactoryConfig(CacheSimpleConfig.ExpiryPolicyFactoryConfig expiryPolicyFactoryConfig)

Sets the factory configuration for this ExpiryPolicy.

Parameters:

expiryPolicyFactoryConfig - The factory configuration to set for this ExpiryPolicy.

Returns:

The current cache config instance.

setExpiryPolicyFactory

public CacheSimpleConfig setExpiryPolicyFactory(String className)

Sets the factory for this ExpiryPolicy.

Parameters:

className - The factory to set for this ExpiryPolicy.

Returns:

The current cache config instance.

addEntryListenerConfig

public CacheSimpleConfig addEntryListenerConfig(CacheSimpleEntryListenerConfig listenerConfig)

Adds CacheSimpleEntryListenerConfig to this ICache.

Parameters:

listenerConfig -

Returns:

this CacheSimpleConfig instance.

getCacheEntryListeners

public List<CacheSimpleEntryListenerConfig> getCacheEntryListeners()

Gets a list of CacheSimpleEntryListenerConfig from this ICache.

Returns:

list of CacheSimpleEntryListenerConfig.

setCacheEntryListeners

public CacheSimpleConfig setCacheEntryListeners(List<CacheSimpleEntryListenerConfig> cacheEntryListeners)

Sets a list of CacheSimpleEntryListenerConfig for this ICache.

Parameters:

cacheEntryListeners - list of CacheSimpleEntryListenerConfig.

Returns:

this CacheSimpleConfig instance.

getAsyncBackupCount

public int getAsyncBackupCount()

Gets the number of asynchronous backups for this ICache.

Returns:

The number of asynchronous backups for this ICache.

setAsyncBackupCount

public CacheSimpleConfig setAsyncBackupCount(int asyncBackupCount)

Sets the number of asynchronous backups for this ICache.

Parameters:

asyncBackupCount - the number of asynchronous synchronous backups to set.

Returns:

the updated CacheSimpleConfig

Throws:

IllegalArgumentException - 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 backups.

See Also:

setBackupCount(int), getAsyncBackupCount()

getBackupCount

public int getBackupCount()

Gets the number of synchronous backups for this ICache.

Returns:

The number of synchronous backups.

setBackupCount

public CacheSimpleConfig setBackupCount(int backupCount)

Sets the number of synchronous backups for this ICache.

Parameters:

backupCount - the new backupCount

Returns:

the updated CacheSimpleConfig

Throws:

new - IllegalArgumentException 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 backups

getInMemoryFormat

public InMemoryFormat getInMemoryFormat()

Gets the InMemory Format for this ICache.

Returns:

The InMemory Format.

setInMemoryFormat

public CacheSimpleConfig setInMemoryFormat(InMemoryFormat inMemoryFormat)

Sets the InMemory Format for this ICache.

Parameters:

inMemoryFormat - The InMemory Format.

Returns:

the updated CacheSimpleConfig.

getEvictionConfig

public EvictionConfig getEvictionConfig()

Gets the eviction configuration for this ICache.

Returns:

The eviction configuration.

setEvictionConfig

public CacheSimpleConfig setEvictionConfig(EvictionConfig evictionConfig)

Sets the eviction configuration for this ICache.

Parameters:

evictionConfig - The eviction configuration to set.

Returns:

the updated CacheSimpleConfig.

getWanReplicationRef

public WanReplicationRef getWanReplicationRef()

Gets the WAN target replication reference.

Returns:

The WAN target replication reference.

setWanReplicationRef

public void setWanReplicationRef(WanReplicationRef wanReplicationRef)

Sets the WAN target replication reference.

Parameters:

wanReplicationRef - the WAN target replication reference.

getPartitionLostListenerConfigs

public List<CachePartitionLostListenerConfig> getPartitionLostListenerConfigs()

Gets the partition lost listener references added to cache configuration.

Returns:

List of CachePartitionLostListenerConfig.

setPartitionLostListenerConfigs

public CacheSimpleConfig setPartitionLostListenerConfigs(List<CachePartitionLostListenerConfig> partitionLostListenerConfigs)

Sets the PartitionLostListenerConfigs.

Parameters:

partitionLostListenerConfigs - CachePartitionLostListenerConfig list.

addCachePartitionLostListenerConfig

public CacheSimpleConfig addCachePartitionLostListenerConfig(CachePartitionLostListenerConfig listenerConfig)

Adds the CachePartitionLostListenerConfig to partitionLostListenerConfigs.

Parameters:

listenerConfig - CachePartitionLostListenerConfig to be added.

getQuorumName

public String getQuorumName()

Gets the name of the associated quorum if any.

Returns:

the name of the associated quorum if any

setQuorumName

public CacheSimpleConfig setQuorumName(String quorumName)

Associates this cache configuration to a quorum.

Parameters:

quorumName - name of the desired quorum.

Returns:

the updated CacheSimpleConfig.

setHotRestartEnabled

public CacheSimpleConfig setHotRestartEnabled(boolean hotRestart)

Sets whether hot restart is enabled on this cache.

Returns:

this

isHotRestartEnabled

public boolean isHotRestartEnabled()

Returns whether hot restart enabled on this cache.

Returns:

true if hot restart enabled, false otherwise

getMergePolicy

public String getMergePolicy()

Gets the class name of CacheMergePolicy implementation of this cache config.

Returns:

the class name of CacheMergePolicy implementation of this cache config

setMergePolicy

public void setMergePolicy(String mergePolicy)

Sets the class name of CacheMergePolicy implementation to this cache config.

Parameters:

mergePolicy - the class name of CacheMergePolicy implementation to be set to this cache config