Class NearCacheConfig
- All Implemented Interfaces:
NamedConfig
,DataSerializable
,IdentifiedDataSerializable
,Serializable
public class NearCacheConfig extends Object implements IdentifiedDataSerializable, Serializable, NamedConfig
- See Also:
- Serialized Form
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
NearCacheConfig.LocalUpdatePolicy
Defines how to reflect local updates to the Near Cache. -
Field Summary
Fields Modifier and Type Field Description static boolean
DEFAULT_INVALIDATE_ON_CHANGE
static NearCacheConfig.LocalUpdatePolicy
DEFAULT_LOCAL_UPDATE_POLICY
static int
DEFAULT_MAX_IDLE_SECONDS
Default value of the maximum idle time for eviction in seconds.static InMemoryFormat
DEFAULT_MEMORY_FORMAT
Default value for the in-memory format.static boolean
DEFAULT_SERIALIZE_KEYS
Do not serialize by defaultstatic int
DEFAULT_TTL_SECONDS
Default value of the time to live in seconds. -
Constructor Summary
Constructors Constructor Description NearCacheConfig()
NearCacheConfig(NearCacheConfig config)
NearCacheConfig(String name)
-
Method Summary
Modifier and Type Method Description boolean
equals(Object o)
int
getClassId()
Returns type identifier for this class.EvictionConfig
getEvictionConfig()
Returns the eviction configuration for this Near Cache.int
getFactoryId()
Returns DataSerializableFactory factory ID for this class.InMemoryFormat
getInMemoryFormat()
Returns the data type used to store entries.NearCacheConfig.LocalUpdatePolicy
getLocalUpdatePolicy()
Returns theNearCacheConfig.LocalUpdatePolicy
of this Near Cache.int
getMaxIdleSeconds()
Returns the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).String
getName()
Returns the name of the Near Cache.NearCachePreloaderConfig
getPreloaderConfig()
Returns theNearCachePreloaderConfig
of this Near Cache.int
getTimeToLiveSeconds()
Returns the maximum number of seconds for each entry to stay in the Near Cache (time to live).int
hashCode()
boolean
isCacheLocalEntries()
Checks if local entries are also cached in the Near Cache.boolean
isInvalidateOnChange()
Checks if Near Cache entries are invalidated when the entries in the backing data structure are changed (updated or removed).boolean
isSerializeKeys()
Checks if the Near Cache key is stored in serialized format or by-reference.void
readData(ObjectDataInput in)
Reads fields from the input streamNearCacheConfig
setCacheLocalEntries(boolean cacheLocalEntries)
Sets if local entries are also cached in the Near Cache.NearCacheConfig
setEvictionConfig(EvictionConfig evictionConfig)
Sets the eviction configuration for this Near Cache.NearCacheConfig
setInMemoryFormat(InMemoryFormat inMemoryFormat)
Sets the data type used to store entries.NearCacheConfig
setInMemoryFormat(String inMemoryFormat)
NearCacheConfig
setInvalidateOnChange(boolean invalidateOnChange)
Sets if Near Cache entries are invalidated when the entries in the backing data structure are changed (updated or removed).NearCacheConfig
setLocalUpdatePolicy(NearCacheConfig.LocalUpdatePolicy localUpdatePolicy)
Sets theNearCacheConfig.LocalUpdatePolicy
of this Near Cache.NearCacheConfig
setMaxIdleSeconds(int maxIdleSeconds)
Set the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).NearCacheConfig
setName(String name)
Sets the name of the Near Cache.NearCacheConfig
setPreloaderConfig(NearCachePreloaderConfig preloaderConfig)
Sets theNearCachePreloaderConfig
of this Near Cache.NearCacheConfig
setSerializeKeys(boolean serializeKeys)
Sets if the Near Cache key is stored in serialized format or by-reference.NearCacheConfig
setTimeToLiveSeconds(int timeToLiveSeconds)
Returns the maximum number of seconds for each entry to stay in the Near Cache (time to live).String
toString()
void
writeData(ObjectDataOutput out)
Writes object fields to output stream
-
Field Details
-
DEFAULT_MEMORY_FORMAT
Default value for the in-memory format. -
DEFAULT_SERIALIZE_KEYS
public static final boolean DEFAULT_SERIALIZE_KEYSDo not serialize by default- See Also:
- Constant Field Values
-
DEFAULT_INVALIDATE_ON_CHANGE
public static final boolean DEFAULT_INVALIDATE_ON_CHANGE -
DEFAULT_LOCAL_UPDATE_POLICY
-
DEFAULT_TTL_SECONDS
public static final int DEFAULT_TTL_SECONDSDefault value of the time to live in seconds.- See Also:
- Constant Field Values
-
DEFAULT_MAX_IDLE_SECONDS
public static final int DEFAULT_MAX_IDLE_SECONDSDefault value of the maximum idle time for eviction in seconds.- See Also:
- Constant Field Values
-
-
Constructor Details
-
NearCacheConfig
public NearCacheConfig() -
NearCacheConfig
-
NearCacheConfig
-
-
Method Details
-
getName
Returns the name of the Near Cache.- Specified by:
getName
in interfaceNamedConfig
- Returns:
- the name of the Near Cache
-
setName
Sets the name of the Near Cache.- Specified by:
setName
in interfaceNamedConfig
- Parameters:
name
- the name of the Near Cache- Returns:
- this Near Cache config instance
-
getInMemoryFormat
Returns the data type used to store entries.Possible values:
BINARY
: keys and values are stored as binary dataOBJECT
: values are stored in their object formsNATIVE
: keys and values are stored in native memory
BINARY
.- Returns:
- the data type used to store entries
-
setInMemoryFormat
Sets the data type used to store entries.Possible values:
BINARY
: keys and values are stored as binary dataOBJECT
: values are stored in their object formsNATIVE
: keys and values are stored in native memory
BINARY
.- Parameters:
inMemoryFormat
- the data type used to store entries- Returns:
- this Near Cache config instance
-
setInMemoryFormat
-
isSerializeKeys
public boolean isSerializeKeys()Checks if the Near Cache key is stored in serialized format or by-reference. NOTE: When the in-memory-format isNATIVE
, this method will always returntrue
.- Returns:
true
if the key is stored in serialized format or in-memory-format isNATIVE
,false
if the key is stored by-reference and in-memory-format isBINARY
orOBJECT
-
setSerializeKeys
Sets if the Near Cache key is stored in serialized format or by-reference. NOTE: It's not supported to disable the key serialization when the in-memory-format isNATIVE
. You can still set this value tofalse
, but it will have no effect.- Parameters:
serializeKeys
-true
if the key is stored in serialized format,false
if stored by-reference- Returns:
- this Near Cache config instance
-
isInvalidateOnChange
public boolean isInvalidateOnChange()Checks if Near Cache entries are invalidated when the entries in the backing data structure are changed (updated or removed).When this setting is enabled, a Hazelcast instance with a Near Cache listens for cluster-wide changes on the entries of the backing data structure and invalidates its corresponding Near Cache entries. Changes done on the local Hazelcast instance always invalidate the Near Cache immediately.
- Returns:
true
if Near Cache invalidations are enabled on changes,false
otherwise
-
setInvalidateOnChange
Sets if Near Cache entries are invalidated when the entries in the backing data structure are changed (updated or removed).When this setting is enabled, a Hazelcast instance with a Near Cache listens for cluster-wide changes on the entries of the backing data structure and invalidates its corresponding Near Cache entries. Changes done on the local Hazelcast instance always invalidate the Near Cache immediately.
- Parameters:
invalidateOnChange
-true
to enable Near Cache invalidations,false
otherwise- Returns:
- this Near Cache config instance
-
getTimeToLiveSeconds
public int getTimeToLiveSeconds()Returns the maximum number of seconds for each entry to stay in the Near Cache (time to live).Entries that are older than
timeToLiveSeconds
will automatically be evicted from the Near Cache.- Returns:
- the maximum number of seconds for each entry to stay in the Near Cache
-
setTimeToLiveSeconds
Returns the maximum number of seconds for each entry to stay in the Near Cache (time to live).Entries that are older than
timeToLiveSeconds
will automatically be evicted from the Near Cache.Accepts any integer between
0
andInteger.MAX_VALUE
. The value0
meansInteger.MAX_VALUE
. The default is0
.- Parameters:
timeToLiveSeconds
- the maximum number of seconds for each entry to stay in the Near Cache- Returns:
- this Near Cache config instance
-
getMaxIdleSeconds
public int getMaxIdleSeconds()Returns the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).Entries that are not read (touched) more than
maxIdleSeconds
value will get removed from the Near Cache.- Returns:
- maximum number of seconds each entry can stay in the Near Cache as untouched (not-read)
-
setMaxIdleSeconds
Set the maximum number of seconds each entry can stay in the Near Cache as untouched (not-read).Entries that are not read (touched) more than
maxIdleSeconds
value will get removed from the Near Cache.Accepts any integer between
0
andInteger.MAX_VALUE
. The value0
meansInteger.MAX_VALUE
. The default is0
.- Parameters:
maxIdleSeconds
- maximum number of seconds each entry can stay in the Near Cache as untouched (not-read)- Returns:
- this Near Cache config instance
-
getEvictionConfig
Returns the eviction configuration for this Near Cache.- Returns:
- the eviction configuration
-
setEvictionConfig
Sets the eviction configuration for this Near Cache.- Parameters:
evictionConfig
- the eviction configuration- Returns:
- this Near Cache config instance
-
isCacheLocalEntries
public boolean isCacheLocalEntries()Checks if local entries are also cached in the Near Cache.This is useful when the in-memory format of the Near Cache is different from the backing data structure. This setting has no meaning on Hazelcast clients, since they have no local entries.
- Returns:
true
if local entries are also cached,false
otherwise
-
setCacheLocalEntries
Sets if local entries are also cached in the Near Cache.This is useful when the in-memory format of the Near Cache is different from the backing data structure. This setting has no meaning on Hazelcast clients, since they have no local entries.
- Parameters:
cacheLocalEntries
-true
if local entries are also cached,false
otherwise- Returns:
- this Near Cache config instance
-
getLocalUpdatePolicy
Returns theNearCacheConfig.LocalUpdatePolicy
of this Near Cache.- Returns:
- the
NearCacheConfig.LocalUpdatePolicy
of this Near Cache
-
setLocalUpdatePolicy
Sets theNearCacheConfig.LocalUpdatePolicy
of this Near Cache.This is only implemented for
JCache
data structures.- Parameters:
localUpdatePolicy
- theNearCacheConfig.LocalUpdatePolicy
of this Near Cache- Returns:
- this Near Cache config instance
-
getPreloaderConfig
Returns theNearCachePreloaderConfig
of this Near Cache.- Returns:
- the
NearCachePreloaderConfig
of this Near Cache
-
setPreloaderConfig
Sets theNearCachePreloaderConfig
of this Near Cache.- Parameters:
preloaderConfig
- theNearCachePreloaderConfig
of this Near Cache- Returns:
- this Near Cache config instance
-
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.
-
toString
-
equals
-
hashCode
public int hashCode()
-