Class DefaultLoadBalancerCache

java.lang.Object

org.springframework.cache.support.AbstractValueAdaptingCache

org.springframework.cloud.loadbalancer.cache.DefaultLoadBalancerCache

All Implemented Interfaces:

org.springframework.cache.Cache

public class DefaultLoadBalancerCache
extends org.springframework.cache.support.AbstractValueAdaptingCache

A default Cache implementation used by Spring Cloud LoadBalancer. The current implementation uses ConcurrentMapWithTimedEviction underneath. Based on ConcurrentMapCache.

Since:

2.2.0

Author:

Olga Maciaszek-Sharma

See Also:

• Evictor
• ConcurrentMapWithTimedEviction
• ConcurrentMapCache

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.cache.Cache

org.springframework.cache.Cache.ValueRetrievalException, org.springframework.cache.Cache.ValueWrapper

Constructor Summary

Constructors

Constructor	Description
DefaultLoadBalancerCache(String name)	Create a new DefaultCache with the specified name.
DefaultLoadBalancerCache(String name, boolean allowNullValues)	Create a new EvictorCache with the specified name.
DefaultLoadBalancerCache(String name, long evictMs, boolean allowNullValues)	Create a new DefaultCache with the specified name.

Method Summary

Modifier and Type	Method	Description
void	clear()
void	evict(Object key)
boolean	evictIfPresent(Object key)
<T> @Nullable T	get(Object key, Callable<T> valueLoader)
String	getName()
ConcurrentMap<Object,Object>	getNativeCache()
boolean	invalidate()
protected Object	lookup(Object key)
void	put(Object key, @Nullable Object value)
void	put(Object key, @Nullable Object value, long evictMs)
@Nullable org.springframework.cache.Cache.ValueWrapper	putIfAbsent(Object key, @Nullable Object value)
@Nullable org.springframework.cache.Cache.ValueWrapper	putIfAbsent(Object key, @Nullable Object value, long evictMs)

Methods inherited from class org.springframework.cache.support.AbstractValueAdaptingCache

fromStoreValue, get, get, isAllowNullValues, toStoreValue, toValueWrapper

Methods inherited from class Object

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

Methods inherited from interface org.springframework.cache.Cache

retrieve, retrieve

Constructor Details

DefaultLoadBalancerCache

public DefaultLoadBalancerCache(String name)

Create a new DefaultCache with the specified name.

Parameters:

name - the name of the cache

DefaultLoadBalancerCache

public DefaultLoadBalancerCache(String name,
 long evictMs,
 boolean allowNullValues)

Create a new DefaultCache with the specified name.

Parameters:

name - the name of the cache

evictMs - default time to evict the entries ConcurrentMapWithTimedEviction

allowNullValues - whether to accept and convert null values for this cache

DefaultLoadBalancerCache

public DefaultLoadBalancerCache(String name,
 boolean allowNullValues)

Create a new EvictorCache with the specified name.

Parameters:

name - the name of the cache

allowNullValues - whether to accept and convert null values for this cache

Method Details

lookup

protected Object lookup(Object key)

Specified by:

lookup in class org.springframework.cache.support.AbstractValueAdaptingCache

getName

public String getName()

getNativeCache

public ConcurrentMap<Object,Object> getNativeCache()

get

public <T> @Nullable T get(Object key,
 Callable<T> valueLoader)

put

public void put(Object key,
 @Nullable Object value,
 long evictMs)

putIfAbsent

public @Nullable org.springframework.cache.Cache.ValueWrapper putIfAbsent(Object key,
 @Nullable Object value)

putIfAbsent

public @Nullable org.springframework.cache.Cache.ValueWrapper putIfAbsent(Object key,
 @Nullable Object value,
 long evictMs)

put

public void put(Object key,
 @Nullable Object value)

evict

public void evict(Object key)

evictIfPresent

public boolean evictIfPresent(Object key)

clear

public void clear()

invalidate

public boolean invalidate()