info.magnolia.module.cache

Class CacheModule

java.lang.Object

info.magnolia.module.cache.AbstractCacheModule

info.magnolia.module.cache.CacheModule

All Implemented Interfaces:

info.magnolia.module.ModuleLifecycle

public class CacheModule
extends AbstractCacheModule

The CacheModule holds several named ContentCachingConfiguration instances and a CacheFactory.

See Also:

ContentCachingConfiguration, CacheFactory

Field Summary

Fields inherited from class info.magnolia.module.cache.AbstractCacheModule

DEFAULT_CACHE_CONFIG

Constructor Summary

Constructors

Constructor and Description
CacheModule(CacheMonitor cacheMonitor)
CacheModule(info.magnolia.module.ModuleManager moduleManager, CacheMonitor cacheMonitor) Deprecated. since 5.4. Use CacheModule(info.magnolia.module.cache.mbean.CacheMonitor) intead.

Method Summary

Methods

Modifier and Type	Method and Description
ContentCachingConfiguration	addConfiguration(String name, CacheConfiguration cacheConfiguration) Deprecated. since 5.4 use setContentCaching(java.util.Map)}
CacheFactory	getCacheFactory() Inject CacheFactoryProvider} instead.
ContentCompression	getCompression()
ContentCachingConfiguration	getConfiguration(String name) Deprecated. since 5.4 use getContentCaching(String)
Map<String,ContentCachingConfiguration>	getContentCaching()
ContentCachingConfiguration	getContentCaching(String name)
void	register(CacheModuleLifecycleListener listener)
void	setCacheFactory(CacheFactory cacheFactory)
void	setCompression(ContentCompression compression)
void	setContentCaching(Map<String,ContentCachingConfiguration> contentCaching)
void	start(info.magnolia.module.ModuleLifecycleContext moduleLifecycleContext)
void	stop(info.magnolia.module.ModuleLifecycleContext moduleLifecycleContext)

Methods inherited from class info.magnolia.module.cache.AbstractCacheModule

getCacheMonitor, startCache, stopCache

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheModule

@Inject
public CacheModule(CacheMonitor cacheMonitor)

CacheModule

@Deprecated
public CacheModule(info.magnolia.module.ModuleManager moduleManager,
                      CacheMonitor cacheMonitor)

Deprecated. since 5.4. Use CacheModule(info.magnolia.module.cache.mbean.CacheMonitor) intead.

Method Detail

getCacheFactory

public CacheFactory getCacheFactory()

Inject CacheFactoryProvider} instead.

Specified by:

getCacheFactory in class AbstractCacheModule

setCacheFactory

public void setCacheFactory(CacheFactory cacheFactory)

getContentCaching

public Map<String,ContentCachingConfiguration> getContentCaching()

addConfiguration

@Deprecated
public ContentCachingConfiguration addConfiguration(String name,
                                                      CacheConfiguration cacheConfiguration)

Deprecated. since 5.4 use setContentCaching(java.util.Map)}

setContentCaching

public void setContentCaching(Map<String,ContentCachingConfiguration> contentCaching)

setCompression

public void setCompression(ContentCompression compression)

getCompression

public ContentCompression getCompression()

register

public void register(CacheModuleLifecycleListener listener)

getConfiguration

@Deprecated
public ContentCachingConfiguration getConfiguration(String name)

Deprecated. since 5.4 use getContentCaching(String)

getContentCaching

public ContentCachingConfiguration getContentCaching(String name)

Specified by:

getContentCaching in class AbstractCacheModule

start

public void start(info.magnolia.module.ModuleLifecycleContext moduleLifecycleContext)

stop

public void stop(info.magnolia.module.ModuleLifecycleContext moduleLifecycleContext)