org.redisson.api.options.LocalCachedMapParams Maven / Gradle / Ivy
Show all versions of redisson-all Show documentation
/**
* Copyright (c) 2013-2024 Nikita Koksharov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.redisson.api.options;
import java.time.Duration;
/**
* Configuration for LocalCachedMap object.
*
* @author Nikita Koksharov
*
* @param key type
* @param value type
*/
public final class LocalCachedMapParams extends BaseMapOptions, K, V> implements LocalCachedMapOptions {
private final String name;
private ReconnectionStrategy reconnectionStrategy = ReconnectionStrategy.NONE;
private SyncStrategy syncStrategy = SyncStrategy.INVALIDATE;
private EvictionPolicy evictionPolicy = EvictionPolicy.NONE;
private int cacheSize;
private long timeToLiveInMillis;
private long maxIdleInMillis;
private CacheProvider cacheProvider = CacheProvider.REDISSON;
private StoreMode storeMode = StoreMode.LOCALCACHE_REDIS;
private boolean storeCacheMiss;
private ExpirationEventPolicy expirationEventPolicy = ExpirationEventPolicy.SUBSCRIBE_WITH_KEYEVENT_PATTERN;
private boolean useObjectAsCacheKey;
private boolean useTopicPattern;
LocalCachedMapParams(String name) {
this.name = name;
}
public CacheProvider getCacheProvider() {
return cacheProvider;
}
public EvictionPolicy getEvictionPolicy() {
return evictionPolicy;
}
public int getCacheSize() {
return cacheSize;
}
public long getTimeToLiveInMillis() {
return timeToLiveInMillis;
}
public long getMaxIdleInMillis() {
return maxIdleInMillis;
}
/**
* 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.
*
* @param cacheSize size of cache
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams cacheSize(int cacheSize) {
this.cacheSize = cacheSize;
return this;
}
public ReconnectionStrategy getReconnectionStrategy() {
return reconnectionStrategy;
}
public SyncStrategy getSyncStrategy() {
return syncStrategy;
}
/**
* Defines strategy for load missed local cache updates after Redis connection failure.
*
* @param 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
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams reconnectionStrategy(ReconnectionStrategy reconnectionStrategy) {
if (reconnectionStrategy == null) {
throw new NullPointerException("reconnectionStrategy can't be null");
}
this.reconnectionStrategy = reconnectionStrategy;
return this;
}
/**
* Defines local cache synchronization strategy.
*
* @param 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
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams syncStrategy(SyncStrategy syncStrategy) {
if (syncStrategy == null) {
throw new NullPointerException("syncStrategy can't be null");
}
this.syncStrategy = syncStrategy;
return this;
}
/**
* Defines local cache eviction policy.
*
* @param 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.
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams evictionPolicy(EvictionPolicy evictionPolicy) {
if (evictionPolicy == null) {
throw new NullPointerException("evictionPolicy can't be null");
}
this.evictionPolicy = evictionPolicy;
return this;
}
/**
* Defines time to live in milliseconds of each map entry in local cache.
* If value equals to 0 then timeout is not applied
*
* @param ttl time to live in milliseconds
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams timeToLive(Duration ttl) {
this.timeToLiveInMillis = ttl.toMillis();
return this;
}
/**
* Defines max idle time in milliseconds of each map entry in local cache.
* If value equals to 0 then timeout is not applied
*
* @param idleTime time to live in milliseconds
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams maxIdle(Duration idleTime) {
this.maxIdleInMillis = idleTime.toMillis();
return this;
}
public StoreMode getStoreMode() {
return storeMode;
}
/**
* Defines store mode of cache data.
*
* @param storeMode
* LOCALCACHE - store data in local cache only.
*
LOCALCACHE_REDIS - store data in both Redis and local cache.
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams storeMode(StoreMode storeMode) {
this.storeMode = storeMode;
return this;
}
/**
* Defines Cache provider used as local cache store.
*
* @param cacheProvider
* REDISSON - uses Redisson own implementation.
*
CAFFEINE - uses Caffeine implementation.
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams cacheProvider(CacheProvider cacheProvider) {
this.cacheProvider = cacheProvider;
return this;
}
public boolean isStoreCacheMiss() {
return this.storeCacheMiss;
}
/**
* Defines whether to store a cache miss into the local cache.
*
* @param storeCacheMiss - whether to store a cache miss into the local cache
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams storeCacheMiss(boolean storeCacheMiss) {
this.storeCacheMiss = storeCacheMiss;
return this;
}
/**
* Defines whether to use __keyevent pattern topic to listen for expired events.
*
* @param useKeyEventsPattern - whether to use __keyevent pattern topic
* @return LocalCachedMapOptions instance
*/
public LocalCachedMapParams useKeyEventsPattern(boolean useKeyEventsPattern) {
if (useKeyEventsPattern) {
this.expirationEventPolicy = ExpirationEventPolicy.SUBSCRIBE_WITH_KEYEVENT_PATTERN;
} else {
this.expirationEventPolicy = ExpirationEventPolicy.SUBSCRIBE_WITH_KEYSPACE_CHANNEL;
}
return this;
}
@Override
public LocalCachedMapOptions expirationEventPolicy(ExpirationEventPolicy expirationEventPolicy) {
this.expirationEventPolicy = expirationEventPolicy;
return this;
}
@Override
public LocalCachedMapOptions useObjectAsCacheKey(boolean useObjectAsCacheKey) {
this.useObjectAsCacheKey = useObjectAsCacheKey;
return this;
}
@Override
public LocalCachedMapOptions useTopicPattern(boolean value) {
this.useTopicPattern = value;
return this;
}
public ExpirationEventPolicy getExpirationEventPolicy() {
return expirationEventPolicy;
}
public String getName() {
return name;
}
public boolean isUseObjectAsCacheKey() {
return useObjectAsCacheKey;
}
public boolean isUseTopicPattern() {
return useTopicPattern;
}
}