Package org.redisson.api.options

Class LocalCachedMapParams<K,V>

java.lang.Object

org.redisson.api.options.LocalCachedMapParams<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

CodecOptions<LocalCachedMapOptions<K,V>,Codec>, ExMapOptions<LocalCachedMapOptions<K,V>,K,V>, InvocationOptions<LocalCachedMapOptions<K,V>>, LocalCachedMapOptions<K,V>, ObjectParams

public final class LocalCachedMapParams<K,V>
extends Object
implements LocalCachedMapOptions<K,V>

Configuration for LocalCachedMap object.

Author:

Nikita Koksharov

Nested Class Summary

Nested classes/interfaces inherited from interface org.redisson.api.options.LocalCachedMapOptions

LocalCachedMapOptions.CacheProvider, LocalCachedMapOptions.EvictionPolicy, LocalCachedMapOptions.ExpirationEventPolicy, LocalCachedMapOptions.ReconnectionStrategy, LocalCachedMapOptions.StoreMode, LocalCachedMapOptions.SyncStrategy

Method Summary

Modifier and Type	Method	Description
LocalCachedMapParams<K,V>	cacheProvider(LocalCachedMapOptions.CacheProvider cacheProvider)	Defines Cache provider used as local cache store.
LocalCachedMapParams<K,V>	cacheSize(int cacheSize)	Defines local cache size.
LocalCachedMapOptions<K,V>	codec(Codec codec)	Defines codec used for data stored in Redis
LocalCachedMapParams<K,V>	evictionPolicy(LocalCachedMapOptions.EvictionPolicy evictionPolicy)	Defines local cache eviction policy.
LocalCachedMapOptions<K,V>	expirationEventPolicy(LocalCachedMapOptions.ExpirationEventPolicy expirationEventPolicy)	Defines how to listen expired event sent by Redis upon this instance deletion.
LocalCachedMapOptions.CacheProvider	getCacheProvider()
int	getCacheSize()
Codec	getCodec()
LocalCachedMapOptions.EvictionPolicy	getEvictionPolicy()
LocalCachedMapOptions.ExpirationEventPolicy	getExpirationEventPolicy()
MapLoader<K,V>	getLoader()
MapLoaderAsync<K,V>	getLoaderAsync()
long	getMaxIdleInMillis()
String	getName()
LocalCachedMapOptions.ReconnectionStrategy	getReconnectionStrategy()
int	getRetryAttempts()
int	getRetryInterval()
LocalCachedMapOptions.StoreMode	getStoreMode()
LocalCachedMapOptions.SyncStrategy	getSyncStrategy()
int	getTimeout()
long	getTimeToLiveInMillis()
int	getWriteBehindBatchSize()
int	getWriteBehindDelay()
WriteMode	getWriteMode()
MapWriter<K,V>	getWriter()
MapWriterAsync<K,V>	getWriterAsync()
int	getWriteRetryAttempts()
long	getWriteRetryInterval()
boolean	isStoreCacheMiss()
LocalCachedMapOptions<K,V>	loader(MapLoader<K,V> loader)	Sets MapLoader object.
LocalCachedMapOptions<K,V>	loaderAsync(MapLoaderAsync<K,V> loaderAsync)	Sets MapLoaderAsync object.
LocalCachedMapParams<K,V>	maxIdle(Duration idleTime)	Defines max idle time in milliseconds of each map entry in local cache.
LocalCachedMapParams<K,V>	reconnectionStrategy(LocalCachedMapOptions.ReconnectionStrategy reconnectionStrategy)	Defines strategy for load missed local cache updates after Redis connection failure.
LocalCachedMapOptions<K,V>	retryAttempts(int retryAttempts)	Defines command retry attempts.
LocalCachedMapOptions<K,V>	retryInterval(Duration interval)	Defines time interval for another one attempt to send a Redis command if it hasn't already been sent.
LocalCachedMapParams<K,V>	storeCacheMiss(boolean storeCacheMiss)	Defines whether to store a cache miss into the local cache.
LocalCachedMapParams<K,V>	storeMode(LocalCachedMapOptions.StoreMode storeMode)	Defines store mode of cache data.
LocalCachedMapParams<K,V>	syncStrategy(LocalCachedMapOptions.SyncStrategy syncStrategy)	Defines local cache synchronization strategy.
LocalCachedMapOptions<K,V>	timeout(Duration timeout)	Defines Redis server response timeout.
LocalCachedMapParams<K,V>	timeToLive(Duration ttl)	Defines time to live in milliseconds of each map entry in local cache.
LocalCachedMapParams<K,V>	useKeyEventsPattern(boolean useKeyEventsPattern)	Defines whether to use __keyevent pattern topic to listen for expired events.
LocalCachedMapOptions<K,V>	writeBehindBatchSize(int writeBehindBatchSize)	Sets write behind tasks batch size.
LocalCachedMapOptions<K,V>	writeBehindDelay(int writeBehindDelay)	Sets write behind tasks execution delay.
LocalCachedMapOptions<K,V>	writeMode(WriteMode writeMode)	Sets write mode.
LocalCachedMapOptions<K,V>	writer(MapWriter<K,V> writer)	Defines MapWriter object which is invoked during write operation.
LocalCachedMapOptions<K,V>	writerAsync(MapWriterAsync<K,V> writer)	Defines MapWriterAsync object which is invoked during write operation.
LocalCachedMapOptions<K,V>	writeRetryAttempts(int writerRetryAttempts)	Sets max retry attempts for RetryableMapWriter or RetryableMapWriterAsync
LocalCachedMapOptions<K,V>	writeRetryInterval(Duration writerRetryInterval)	Sets write retry interval

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.options.CodecOptions

codec

Methods inherited from interface org.redisson.api.options.ExMapOptions

loader, loaderAsync, writeBehindBatchSize, writeBehindDelay, writeMode, writer, writerAsync, writeRetryAttempts, writeRetryInterval

Methods inherited from interface org.redisson.api.options.InvocationOptions

retryAttempts, retryInterval, timeout

Method Details

getCacheProvider

public LocalCachedMapOptions.CacheProvider getCacheProvider()

getEvictionPolicy

public LocalCachedMapOptions.EvictionPolicy getEvictionPolicy()

getCacheSize

public int getCacheSize()

getTimeToLiveInMillis

public long getTimeToLiveInMillis()

getMaxIdleInMillis

public long getMaxIdleInMillis()

cacheSize

public LocalCachedMapParams<K,V> cacheSize(int cacheSize)

Defines local cache size.

If size is 0 then local cache is unbounded.

If size is -1 then local cache is always empty and doesn't store data.

Specified by:

cacheSize in interface LocalCachedMapOptions<K,V>

Parameters:

cacheSize - size of cache

Returns:

LocalCachedMapOptions instance

getReconnectionStrategy

public LocalCachedMapOptions.ReconnectionStrategy getReconnectionStrategy()

getSyncStrategy

public LocalCachedMapOptions.SyncStrategy getSyncStrategy()

reconnectionStrategy

public LocalCachedMapParams<K,V> reconnectionStrategy(LocalCachedMapOptions.ReconnectionStrategy reconnectionStrategy)

Defines strategy for load missed local cache updates after Redis connection failure.

Specified by:

reconnectionStrategy in interface LocalCachedMapOptions<K,V>

Parameters:

reconnectionStrategy -

CLEAR - clear local cache if map instance has been disconnected for a while.

LOAD - store invalidated entry hash in invalidation log for 10 minutes. Cache keys for stored invalidated entry hashes will be removed if LocalCachedMap instance has been disconnected less than 10 minutes or whole cache will be cleaned otherwise

NONE - Default. No reconnection handling

Returns:

LocalCachedMapOptions instance

syncStrategy

public LocalCachedMapParams<K,V> syncStrategy(LocalCachedMapOptions.SyncStrategy syncStrategy)

Defines local cache synchronization strategy.

Specified by:

syncStrategy in interface LocalCachedMapOptions<K,V>

Parameters:

syncStrategy -

INVALIDATE - Default. Invalidate cache entry across all LocalCachedMap instances on map entry change

UPDATE - Insert/update cache entry across all LocalCachedMap instances on map entry change

NONE - No synchronizations on map changes

Returns:

LocalCachedMapOptions instance

evictionPolicy

public LocalCachedMapParams<K,V> evictionPolicy(LocalCachedMapOptions.EvictionPolicy evictionPolicy)

Defines local cache eviction policy.

Specified by:

evictionPolicy in interface LocalCachedMapOptions<K,V>

Parameters:

evictionPolicy -

LRU - uses local cache with LRU (least recently used) eviction policy.

LFU - uses local cache with LFU (least frequently used) eviction policy.

SOFT - uses local cache with soft references. The garbage collector will evict items from the local cache when the JVM is running out of memory.

WEAK - uses local cache with weak references. The garbage collector will evict items from the local cache when it became weakly reachable.

NONE - doesn't use eviction policy, but timeToLive and maxIdleTime params are still working.

Returns:

LocalCachedMapOptions instance

timeToLive

public LocalCachedMapParams<K,V> timeToLive(Duration ttl)

Defines time to live in milliseconds of each map entry in local cache. If value equals to 0 then timeout is not applied

Specified by:

timeToLive in interface LocalCachedMapOptions<K,V>

Parameters:

ttl - time to live in milliseconds

Returns:

LocalCachedMapOptions instance

maxIdle

public LocalCachedMapParams<K,V> maxIdle(Duration idleTime)

Defines max idle time in milliseconds of each map entry in local cache. If value equals to 0 then timeout is not applied

Specified by:

maxIdle in interface LocalCachedMapOptions<K,V>

Parameters:

idleTime - time to live in milliseconds

Returns:

LocalCachedMapOptions instance

getStoreMode

public LocalCachedMapOptions.StoreMode getStoreMode()

storeMode

public LocalCachedMapParams<K,V> storeMode(LocalCachedMapOptions.StoreMode storeMode)

Defines store mode of cache data.

Specified by:

storeMode in interface LocalCachedMapOptions<K,V>

Parameters:

storeMode -

LOCALCACHE - store data in local cache only.

LOCALCACHE_REDIS - store data in both Redis and local cache.

Returns:

LocalCachedMapOptions instance

cacheProvider

public LocalCachedMapParams<K,V> cacheProvider(LocalCachedMapOptions.CacheProvider cacheProvider)

Defines Cache provider used as local cache store.

Specified by:

cacheProvider in interface LocalCachedMapOptions<K,V>

Parameters:

cacheProvider -

REDISSON - uses Redisson own implementation.

CAFFEINE - uses Caffeine implementation.

Returns:

LocalCachedMapOptions instance

isStoreCacheMiss

public boolean isStoreCacheMiss()

storeCacheMiss

public LocalCachedMapParams<K,V> storeCacheMiss(boolean storeCacheMiss)

Defines whether to store a cache miss into the local cache.

Specified by:

storeCacheMiss in interface LocalCachedMapOptions<K,V>

Parameters:

storeCacheMiss - - whether to store a cache miss into the local cache

Returns:

LocalCachedMapOptions instance

useKeyEventsPattern

public LocalCachedMapParams<K,V> useKeyEventsPattern(boolean useKeyEventsPattern)

Defines whether to use __keyevent pattern topic to listen for expired events.

Specified by:

useKeyEventsPattern in interface LocalCachedMapOptions<K,V>

Parameters:

useKeyEventsPattern - - whether to use __keyevent pattern topic

Returns:

LocalCachedMapOptions instance

expirationEventPolicy

public LocalCachedMapOptions<K,V> expirationEventPolicy(LocalCachedMapOptions.ExpirationEventPolicy expirationEventPolicy)

Description copied from interface: LocalCachedMapOptions

Defines how to listen expired event sent by Redis upon this instance deletion.

Specified by:

expirationEventPolicy in interface LocalCachedMapOptions<K,V>

Parameters:

expirationEventPolicy - expiration policy value

Returns:

LocalCachedMapOptions instance

getExpirationEventPolicy

public LocalCachedMapOptions.ExpirationEventPolicy getExpirationEventPolicy()

getName

public String getName()

writer

public LocalCachedMapOptions<K,V> writer(MapWriter<K,V> writer)

Description copied from interface: ExMapOptions

Defines MapWriter object which is invoked during write operation.

Specified by:

writer in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writer - object

Returns:

MapOptions instance

getWriter

public MapWriter<K,V> getWriter()

writerAsync

public LocalCachedMapOptions<K,V> writerAsync(MapWriterAsync<K,V> writer)

Description copied from interface: ExMapOptions

Defines MapWriterAsync object which is invoked during write operation.

Specified by:

writerAsync in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writer - object

Returns:

MapOptions instance

getWriterAsync

public MapWriterAsync<K,V> getWriterAsync()

writeBehindBatchSize

public LocalCachedMapOptions<K,V> writeBehindBatchSize(int writeBehindBatchSize)

Description copied from interface: ExMapOptions

Sets write behind tasks batch size. All updates accumulated into a batch of specified size and written with MapWriter.

Default is 50

Specified by:

writeBehindBatchSize in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writeBehindBatchSize - size of batch

Returns:

MapOptions instance

getWriteBehindBatchSize

public int getWriteBehindBatchSize()

writeBehindDelay

public LocalCachedMapOptions<K,V> writeBehindDelay(int writeBehindDelay)

Description copied from interface: ExMapOptions

Sets write behind tasks execution delay. All updates written with MapWriter and lag not more than specified delay.

Default is 1000 milliseconds

Specified by:

writeBehindDelay in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writeBehindDelay - delay in milliseconds

Returns:

MapOptions instance

getWriteBehindDelay

public int getWriteBehindDelay()

writeMode

public LocalCachedMapOptions<K,V> writeMode(WriteMode writeMode)

Description copied from interface: ExMapOptions

Sets write mode.

Default is WriteMode.WRITE_THROUGH

Specified by:

writeMode in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writeMode - write mode

Returns:

MapOptions instance

getWriteMode

public WriteMode getWriteMode()

getWriteRetryAttempts

public int getWriteRetryAttempts()

writeRetryAttempts

public LocalCachedMapOptions<K,V> writeRetryAttempts(int writerRetryAttempts)

Sets max retry attempts for RetryableMapWriter or RetryableMapWriterAsync

Specified by:

writeRetryAttempts in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writerRetryAttempts - object

Returns:

MapOptions instance

getWriteRetryInterval

public long getWriteRetryInterval()

writeRetryInterval

public LocalCachedMapOptions<K,V> writeRetryInterval(Duration writerRetryInterval)

Description copied from interface: ExMapOptions

Sets write retry interval

Specified by:

writeRetryInterval in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

writerRetryInterval - Duration

Returns:

MapOptions instance

loader

public LocalCachedMapOptions<K,V> loader(MapLoader<K,V> loader)

Sets MapLoader object.

Specified by:

loader in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

loader - object

Returns:

MapOptions instance

getLoader

public MapLoader<K,V> getLoader()

loaderAsync

public LocalCachedMapOptions<K,V> loaderAsync(MapLoaderAsync<K,V> loaderAsync)

Description copied from interface: ExMapOptions

Sets MapLoaderAsync object.

Specified by:

loaderAsync in interface ExMapOptions<T extends ExMapOptions<T,K,V>,K,V>

Parameters:

loaderAsync - object

Returns:

MapOptions instance

getLoaderAsync

public MapLoaderAsync<K,V> getLoaderAsync()

codec

public LocalCachedMapOptions<K,V> codec(Codec codec)

Description copied from interface: CodecOptions

Defines codec used for data stored in Redis

Specified by:

codec in interface CodecOptions<T extends InvocationOptions<T>,C>

Parameters:

codec - applied to object instance

Returns:

options object

timeout

public LocalCachedMapOptions<K,V> timeout(Duration timeout)

Description copied from interface: InvocationOptions

Defines Redis server response timeout. Starts to countdown when a Redis command was successfully sent.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

timeout in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

timeout - Redis server response timeout

Returns:

options instance

retryAttempts

public LocalCachedMapOptions<K,V> retryAttempts(int retryAttempts)

Description copied from interface: InvocationOptions

Defines command retry attempts. Error is thrown if the Redis command can't be sent to Redis server after retryAttempts. But if it sent successfully then responseTimeout is started.

Default is the value specified for the same parameter in Redisson configuration

Specified by:

retryAttempts in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

retryAttempts - command retry attempts

Returns:

options instance

retryInterval

public LocalCachedMapOptions<K,V> retryInterval(Duration interval)

Description copied from interface: InvocationOptions

Defines time interval for another one attempt to send a Redis command if it hasn't already been sent.

Specified by:

retryInterval in interface InvocationOptions<T extends InvocationOptions<T>>

Parameters:

interval - retry time interval

Returns:

options instance

getTimeout

public int getTimeout()

Specified by:

getTimeout in interface ObjectParams

getRetryAttempts

public int getRetryAttempts()

Specified by:

getRetryAttempts in interface ObjectParams

getRetryInterval

public int getRetryInterval()

Specified by:

getRetryInterval in interface ObjectParams

getCodec

public Codec getCodec()