info.magnolia.module.cache.ehcache

Class EhCacheFactory

java.lang.Object

info.magnolia.module.cache.ehcache.EhCacheFactory

All Implemented Interfaces:

CacheFactory

public class EhCacheFactory
extends Object
implements CacheFactory

A CacheFactory based on ehcache and which wraps BlockingCache instances.

Field Summary

Fields inherited from interface info.magnolia.module.cache.CacheFactory

DEFAULT_CACHE_NAME

Constructor Summary

Constructors

Constructor and Description
EhCacheFactory(CacheMonitor cacheMonitor) Deprecated. since 5.4. Use EhCacheFactory(info.magnolia.module.cache.mbean.CacheMonitor, info.magnolia.module.cache.CacheModule, info.magnolia.init.MagnoliaInitPaths) instead.
EhCacheFactory(CacheMonitor cacheMonitor, CacheModule cacheModule, info.magnolia.init.MagnoliaInitPaths magnoliaInitPaths)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createCache(String name)
protected net.sf.ehcache.constructs.blocking.BlockingCache	decorateAndSubstitute(net.sf.ehcache.Ehcache ehcache)
int	getBlockingTimeout()
Cache	getCache(String name) Retrieves a named cache.
List	getCacheNames() Caches currently known by the underlying CacheManager (which includes all configured caches as well as those created on-demand based on the default config).
Map<String,EhCacheConfiguration>	getCaches() These are cache configurations.
EhCacheConfiguration	getDefaultCacheConfiguration() Deprecated.
String	getDiskStorePath()
net.sf.ehcache.CacheManager	getWrappedCacheManager()
void	setBlockingTimeout(int blockingTimeout)
void	setCaches(Map<String,EhCacheConfiguration> caches)
void	setDefaultCacheConfiguration(EhCacheConfiguration defaultCacheConfiguration) Deprecated.
void	setDiskStorePath(String diskStorePath)
void	start(boolean isRestart)
void	stop(boolean isRestart)
protected EhCacheWrapper	wrap(String name, net.sf.ehcache.Ehcache ehcache)

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheFactory

@Inject
public EhCacheFactory(CacheMonitor cacheMonitor,
                     CacheModule cacheModule,
                     info.magnolia.init.MagnoliaInitPaths magnoliaInitPaths)

EhCacheFactory

public EhCacheFactory(CacheMonitor cacheMonitor)

Deprecated. since 5.4. Use EhCacheFactory(info.magnolia.module.cache.mbean.CacheMonitor, info.magnolia.module.cache.CacheModule, info.magnolia.init.MagnoliaInitPaths) instead.

Method Detail

getDefaultCacheConfiguration

@Deprecated
public EhCacheConfiguration getDefaultCacheConfiguration()

Deprecated.

setDefaultCacheConfiguration

@Deprecated
public void setDefaultCacheConfiguration(EhCacheConfiguration defaultCacheConfiguration)

Deprecated.

getCaches

public Map<String,EhCacheConfiguration> getCaches()

These are cache configurations. We call this method getCaches() to make it nicer to configure than if it was called getCacheConfigurations().

setCaches

public void setCaches(Map<String,EhCacheConfiguration> caches)

getDiskStorePath

public String getDiskStorePath()

setDiskStorePath

public void setDiskStorePath(String diskStorePath)

getBlockingTimeout

public int getBlockingTimeout()

setBlockingTimeout

public void setBlockingTimeout(int blockingTimeout)

getCacheNames

public List getCacheNames()

Caches currently known by the underlying CacheManager (which includes all configured caches as well as those created on-demand based on the default config).

Specified by:

getCacheNames in interface CacheFactory

getCache

public Cache getCache(String name)

Description copied from interface: CacheFactory

Retrieves a named cache. Implementations should take care of initializing the cache properly on first call or whenever necessary.

Specified by:

getCache in interface CacheFactory

createCache

protected void createCache(String name)

decorateAndSubstitute

protected net.sf.ehcache.constructs.blocking.BlockingCache decorateAndSubstitute(net.sf.ehcache.Ehcache ehcache)

wrap

protected EhCacheWrapper wrap(String name,
                  net.sf.ehcache.Ehcache ehcache)

start

public void start(boolean isRestart)

Specified by:

start in interface CacheFactory

stop

public void stop(boolean isRestart)

Specified by:

stop in interface CacheFactory

getWrappedCacheManager

public net.sf.ehcache.CacheManager getWrappedCacheManager()