Module io.ebean.core

Package io.ebeaninternal.server.cache

Class DefaultServerCacheManager

java.lang.Object

io.ebeaninternal.server.cache.DefaultServerCacheManager

All Implemented Interfaces:

SpiCacheManager

public final class DefaultServerCacheManager
extends Object
implements SpiCacheManager

Manages the bean and query caches.

Constructor Summary

Constructors

Constructor	Description
DefaultServerCacheManager()	Construct when l2 cache is disabled.
DefaultServerCacheManager(CacheManagerOptions builder)	Create with a cache factory and default cache options.

Method Summary

Modifier and Type	Method	Description
List<ServerCacheRegion>	allRegions()	Return all the regions.
void	clear(Class<?> beanType)	Clear the caches for the given bean type.
void	clearAll()	Clear all caches.
void	clearAllLocal()	Clear all local caches.
void	clearLocal(Class<?> beanType)	Clear local caches for the given bean type.
ServerCache	getBeanCache(Class<?> beanType)	Return the bean cache for a given bean type.
ServerCache	getCollectionIdsCache(Class<?> beanType, String collectionProperty)	Return the cache for associated many properties of a bean type.
ServerCache	getNaturalKeyCache(Class<?> beanType)	Return the cache for mapping natural keys to id values.
ServerCache	getQueryCache(Class<?> beanType)	Return the query cache for a given bean type.
SpiCacheRegion	getRegion(String region)	Return the cache region.
boolean	isLocalL2Caching()	Return true if the L2 caching is local.
void	setAllRegionsEnabled(boolean enabled)	Enable or disable all cache regions.
void	setEnabledRegions(String regions)	Set the regions that are enabled.
void	visitMetrics(MetricVisitor visitor)	Visit and collect the metrics.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultServerCacheManager

public DefaultServerCacheManager(CacheManagerOptions builder)

Create with a cache factory and default cache options.

DefaultServerCacheManager

public DefaultServerCacheManager()

Construct when l2 cache is disabled.

Method Details

isLocalL2Caching

public boolean isLocalL2Caching()

Description copied from interface: SpiCacheManager

Return true if the L2 caching is local.

Local L2 caching means that the cache updates should occur in foreground rather than background processing.

Specified by:

isLocalL2Caching in interface SpiCacheManager

allRegions

public List<ServerCacheRegion> allRegions()

Description copied from interface: SpiCacheManager

Return all the regions.

Specified by:

allRegions in interface SpiCacheManager

setEnabledRegions

public void setEnabledRegions(String regions)

Description copied from interface: SpiCacheManager

Set the regions that are enabled.

Specified by:

setEnabledRegions in interface SpiCacheManager

Parameters:

regions - A single region name or a comma delimited list of region names.

setAllRegionsEnabled

public void setAllRegionsEnabled(boolean enabled)

Description copied from interface: SpiCacheManager

Enable or disable all cache regions.

Specified by:

setAllRegionsEnabled in interface SpiCacheManager

getRegion

public SpiCacheRegion getRegion(String region)

Description copied from interface: SpiCacheManager

Return the cache region. We can enable L2 caching by region.

Specified by:

getRegion in interface SpiCacheManager

visitMetrics

public void visitMetrics(MetricVisitor visitor)

Description copied from interface: SpiCacheManager

Visit and collect the metrics.

Specified by:

visitMetrics in interface SpiCacheManager

clearAll

public void clearAll()

Clear all caches.

Specified by:

clearAll in interface SpiCacheManager

clearAllLocal

public void clearAllLocal()

Description copied from interface: SpiCacheManager

Clear all local caches.

Specified by:

clearAllLocal in interface SpiCacheManager

clear

public void clear(Class<?> beanType)

Description copied from interface: SpiCacheManager

Clear the caches for the given bean type.

Specified by:

clear in interface SpiCacheManager

clearLocal

public void clearLocal(Class<?> beanType)

Description copied from interface: SpiCacheManager

Clear local caches for the given bean type.

Specified by:

clearLocal in interface SpiCacheManager

getCollectionIdsCache

public ServerCache getCollectionIdsCache(Class<?> beanType,
 String collectionProperty)

Description copied from interface: SpiCacheManager

Return the cache for associated many properties of a bean type.

Specified by:

getCollectionIdsCache in interface SpiCacheManager

getNaturalKeyCache

public ServerCache getNaturalKeyCache(Class<?> beanType)

Description copied from interface: SpiCacheManager

Return the cache for mapping natural keys to id values.

Specified by:

getNaturalKeyCache in interface SpiCacheManager

getQueryCache

public ServerCache getQueryCache(Class<?> beanType)

Return the query cache for a given bean type.

Specified by:

getQueryCache in interface SpiCacheManager

getBeanCache

public ServerCache getBeanCache(Class<?> beanType)

Return the bean cache for a given bean type.

Specified by:

getBeanCache in interface SpiCacheManager