Module io.ebean.core

Package io.ebeaninternal.server.cache

Class DefaultServerCache

java.lang.Object

io.ebeaninternal.server.cache.DefaultServerCache

All Implemented Interfaces:

ServerCache

Direct Known Subclasses:

DefaultServerQueryCache

public class DefaultServerCache
extends Object
implements ServerCache

The default cache implementation.

It is base on ConcurrentHashMap with periodic trimming using a TimerTask. The periodic trimming means that an LRU list does not have to be maintained.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultServerCache.CacheEntry	Wraps the value to additionally hold createTime and lastAccessTime and hit counter.
static final class	DefaultServerCache.CompareByLastAccess	Comparator for sorting by last access sort, a copy of last access time that should not mutate during trim processing.
final class	DefaultServerCache.EvictionRunnable	Runnable that calls the eviction routine.

Field Summary

Fields

Modifier and Type	Field	Description
static final DefaultServerCache.CompareByLastAccess	BY_LAST_ACCESS	Compare by last access time (for LRU eviction).
protected final CountMetric	clearCount
protected final CountMetric	evictCount
protected final CountMetric	gcCount
protected final CountMetric	hitCount
protected final CountMetric	idleCount
protected final ReentrantLock	lock
protected static final System.Logger	logger
protected final CountMetric	lruCount
protected final Map<Object,SoftReference<DefaultServerCache.CacheEntry>>	map	The underlying map (ConcurrentHashMap or similar)
protected final int	maxIdleSecs
protected final int	maxSecsToLive
protected final int	maxSize
protected final CountMetric	missCount
protected final AtomicLong	mutationCounter
protected final String	name
protected final CountMetric	putCount
protected final CountMetric	removeCount
protected final String	shortName
protected final int	trimFrequency
protected final long	trimOnPut
protected final CountMetric	ttlCount

Constructor Summary

Constructors

Constructor	Description
DefaultServerCache(DefaultServerCacheConfig config)

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the cache.
Object	get(Object key)	Return a value from the cache.
protected DefaultServerCache.CacheEntry	getCacheEntry(Object key)	Get the cache entry - override for query cache to validate dependent tables.
long	getHitCount()	Return the count of get hits.
long	getMissCount()	Return the count of get misses.
String	getName()	Return the name of the cache.
String	getShortName()
protected int	getTrimSize()	Return the size to trim to based on the max size.
int	hitRatio()
void	periodicTrim(BackgroundExecutor executor)
void	put(Object key, Object value)	Put a value into the cache.
void	putAll(Map<Object,Object> keyValues)
void	remove(Object key)	Remove an entry from the cache.
void	runEviction()	Run the eviction based on Idle time, Time to live and LRU last access.
int	size()	Return the number of elements in the cache.
ServerCacheStatistics	statistics(boolean reset)
protected Object	unwrapEntry(DefaultServerCache.CacheEntry entry)	Unwrap the cache entry - override for query cache to unwrap to the query result.
void	visit(MetricVisitor visitor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ebean.cache.ServerCache

getAll, removeAll, unwrap

Field Details

logger

protected static final System.Logger logger

BY_LAST_ACCESS

public static final DefaultServerCache.CompareByLastAccess BY_LAST_ACCESS

Compare by last access time (for LRU eviction).

map

protected final Map<Object,SoftReference<DefaultServerCache.CacheEntry>> map

The underlying map (ConcurrentHashMap or similar)

hitCount

protected final CountMetric hitCount

missCount

protected final CountMetric missCount

putCount

protected final CountMetric putCount

removeCount

protected final CountMetric removeCount

clearCount

protected final CountMetric clearCount

evictCount

protected final CountMetric evictCount

gcCount

protected final CountMetric gcCount

idleCount

protected final CountMetric idleCount

ttlCount

protected final CountMetric ttlCount

lruCount

protected final CountMetric lruCount

name

protected final String name

shortName

protected final String shortName

maxSize

protected final int maxSize

trimFrequency

protected final int trimFrequency

maxIdleSecs

protected final int maxIdleSecs

maxSecsToLive

protected final int maxSecsToLive

trimOnPut

protected final long trimOnPut

lock

protected final ReentrantLock lock

mutationCounter

protected final AtomicLong mutationCounter

Constructor Details

DefaultServerCache

public DefaultServerCache(DefaultServerCacheConfig config)

Method Details

periodicTrim

public void periodicTrim(BackgroundExecutor executor)

visit

public void visit(MetricVisitor visitor)

Specified by:

visit in interface ServerCache

statistics

public ServerCacheStatistics statistics(boolean reset)

Specified by:

statistics in interface ServerCache

getHitCount

public long getHitCount()

Return the count of get hits.

getMissCount

public long getMissCount()

Return the count of get misses.

hitRatio

public int hitRatio()

Specified by:

hitRatio in interface ServerCache

getName

public String getName()

Return the name of the cache.

getShortName

public String getShortName()

clear

public void clear()

Clear the cache.

Specified by:

clear in interface ServerCache

get

public Object get(Object key)

Return a value from the cache.

Specified by:

get in interface ServerCache

unwrapEntry

protected Object unwrapEntry(DefaultServerCache.CacheEntry entry)

Unwrap the cache entry - override for query cache to unwrap to the query result.

getCacheEntry

protected DefaultServerCache.CacheEntry getCacheEntry(Object key)

Get the cache entry - override for query cache to validate dependent tables.

putAll

public void putAll(Map<Object,Object> keyValues)

Specified by:

putAll in interface ServerCache

put

public void put(Object key,
 Object value)

Put a value into the cache.

Specified by:

put in interface ServerCache

remove

public void remove(Object key)

Remove an entry from the cache.

Specified by:

remove in interface ServerCache

size

public int size()

Return the number of elements in the cache.

Specified by:

size in interface ServerCache

getTrimSize

protected int getTrimSize()

Return the size to trim to based on the max size.

This returns 90% of the max size.

runEviction

public void runEviction()

Run the eviction based on Idle time, Time to live and LRU last access.