com.avaje.ebeaninternal.server.cache

Class DefaultServerCache

java.lang.Object

com.avaje.ebeaninternal.server.cache.DefaultServerCache

All Implemented Interfaces:

ServerCache

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 and Description
static class	DefaultServerCache.CacheEntry Wraps the values to additionally hold createTime and lastAccessTime.

Constructor Summary

Constructors

Constructor and Description
DefaultServerCache(String name, int maxSize, int maxIdleSecs, int maxSecsToLive)
DefaultServerCache(String name, ServerCacheOptions options)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear the cache.
Object	get(Object key) Return a value from the cache.
int	getHitRatio() Return the hit ratio the cache is currently getting.
long	getMaxIdleSecs() Return the max idle time.
long	getMaxSecsToLive() Return the maximum time to live.
int	getMaxSize() Return the max cache size.
String	getName() Return the name of the cache.
ServerCacheOptions	getOptions() Return the configuration options for this cache.
ServerCacheStatistics	getStatistics(boolean reset) Return statistics for the cache.
void	init(EbeanServer server) Just after a cache is created this init method is called.
Object	put(Object key, Object value) Put a value into the cache.
Object	putIfAbsent(Object key, Object value) Put a value into the cache but only if absent.
Object	remove(Object key) Remove an entry from the cache.
void	setMaxIdleSecs(int maxIdleSecs) Set the max idle time.
void	setMaxSecsToLive(int maxSecsToLive) Set the maximum time to live.
void	setMaxSize(int maxSize) Set the max cache size.
void	setOptions(ServerCacheOptions o) Update the configuration options for this cache.
int	size() Return the number of elements in the cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultServerCache

public DefaultServerCache(String name,
                  ServerCacheOptions options)

DefaultServerCache

public DefaultServerCache(String name,
                  int maxSize,
                  int maxIdleSecs,
                  int maxSecsToLive)

Method Detail

init

public void init(EbeanServer server)

Description copied from interface: ServerCache

Just after a cache is created this init method is called. This is so that a cache implementation can make use of the BackgroundExecutor service to trim/cleanup itself or use the EbeanServer to populate itself.

This method is called after the cache is constructed but before the cache is made available for use.

Specified by:

init in interface ServerCache

getStatistics

public ServerCacheStatistics getStatistics(boolean reset)

Description copied from interface: ServerCache

Return statistics for the cache.

Specified by:

getStatistics in interface ServerCache

Parameters:

reset - if true the statistics are reset.

getHitRatio

public int getHitRatio()

Description copied from interface: ServerCache

Return the hit ratio the cache is currently getting.

Specified by:

getHitRatio in interface ServerCache

getOptions

public ServerCacheOptions getOptions()

Description copied from interface: ServerCache

Return the configuration options for this cache.

Specified by:

getOptions in interface ServerCache

setOptions

public void setOptions(ServerCacheOptions o)

Description copied from interface: ServerCache

Update the configuration options for this cache.

Specified by:

setOptions in interface ServerCache

getMaxSize

public int getMaxSize()

Return the max cache size.

setMaxSize

public void setMaxSize(int maxSize)

Set the max cache size.

getMaxIdleSecs

public long getMaxIdleSecs()

Return the max idle time.

setMaxIdleSecs

public void setMaxIdleSecs(int maxIdleSecs)

Set the max idle time.

getMaxSecsToLive

public long getMaxSecsToLive()

Return the maximum time to live.

setMaxSecsToLive

public void setMaxSecsToLive(int maxSecsToLive)

Set the maximum time to live.

getName

public String getName()

Return the name of the cache.

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

put

public Object put(Object key,
         Object value)

Put a value into the cache.

Specified by:

put in interface ServerCache

putIfAbsent

public Object putIfAbsent(Object key,
                 Object value)

Put a value into the cache but only if absent.

Specified by:

putIfAbsent in interface ServerCache

remove

public Object 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