Module spring.retry

Package org.springframework.retry.policy

Class AbstractMapRetryContextCache<V>

java.lang.Object

org.springframework.retry.policy.AbstractMapRetryContextCache<V>

All Implemented Interfaces:

RetryContextCache

Direct Known Subclasses:

MapRetryContextCache, SoftReferenceMapRetryContextCache

public abstract class AbstractMapRetryContextCache<V>
extends Object
implements RetryContextCache

Base RetryContextCache implementation that stores entries in memory, with a configurable maximum capacity and LRU eviction policy. For a cache used in a global state, any attempt to increase its capacity should result in an exception. However, a regular cache should not have permanent entries, and removing the eldest entries is sensible.

Since:

1.3.5

Author:

Stephane Nicoll

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CAPACITY	Default value for maximum capacity of the cache.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMapRetryContextCache(int capacity, boolean removeEldestEntries)	Create an instance with the given capacity and the policy to apply when the cache is full.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object key)
protected abstract RetryContext	fromValue(V value)	Get the RetryContext from the cache value.
RetryContext	get(Object key)
protected final Map<Object,V>	getMap()
void	put(Object key, RetryContext context)
void	remove(Object key)
protected void	setCapacity(int capacity)	Update the capacity of the cache.
protected abstract V	toValue(RetryContext context)	Compute the value to store in the cache.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

Default value for maximum capacity of the cache. This is set to a reasonably low value (4096) to avoid users inadvertently filling the cache with item keys that are inconsistent.

See Also:

• Constant Field Values

Constructor Details

AbstractMapRetryContextCache

protected AbstractMapRetryContextCache(int capacity,
 boolean removeEldestEntries)

Create an instance with the given capacity and the policy to apply when the cache is full.

Parameters:

capacity - the size of the cache

removeEldestEntries - whether to remove the eldest entries when the cache is full

Method Details

getMap

protected final Map<Object,V> getMap()

setCapacity

protected void setCapacity(int capacity)

Update the capacity of the cache.

Parameters:

capacity - the new capacity

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface RetryContextCache

get

public RetryContext get(Object key)

Specified by:

get in interface RetryContextCache

put

public void put(Object key,
 RetryContext context)

Specified by:

put in interface RetryContextCache

remove

public void remove(Object key)

Specified by:

remove in interface RetryContextCache

toValue

protected abstract V toValue(RetryContext context)

Compute the value to store in the cache.

Parameters:

context - the RetryContext to store

Returns:

the cache value

fromValue

protected abstract RetryContext fromValue(V value)

Get the RetryContext from the cache value.

Parameters:

value - the cache value

Returns:

the retry context