info.magnolia.module.cache
Class CacheModule

java.lang.Object
  extended by info.magnolia.module.cache.CacheModule
All Implemented Interfaces:
ModuleLifecycle

public class CacheModule
extends Object
implements ModuleLifecycle

The CacheModule holds several named CacheConfiguration instances and a CacheFactory.

Version:
$Revision: $ ($Author: $)
Author:
gjoseph
See Also:
CacheConfiguration, CacheFactory

Constructor Summary
CacheModule(ModuleManager moduleManager, CacheMonitor cacheMonitor)
          Deprecated. TODO since 4.5 - find another, cleaner, mechanism to provide the information this module needs instead of using ModuleManager.
 
Method Summary
 void addConfiguration(String name, CacheConfiguration config)
           
 CacheFactory getCacheFactory()
           
 ContentCompression getCompression()
           
 CacheConfiguration getConfiguration(String name)
           
 Map<String,CacheConfiguration> getConfigurations()
           
static CacheModule getInstance()
          Deprecated. since 4.5, use IoC/CDI
 void register(CacheModuleLifecycleListener listener)
           
 void setCacheFactory(CacheFactory cacheFactory)
           
 void setCompression(ContentCompression compression)
           
 void setConfigurations(Map<String,CacheConfiguration> configurations)
           
 void start(ModuleLifecycleContext moduleLifecycleContext)
           
 void stop(ModuleLifecycleContext moduleLifecycleContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CacheModule

@Inject
public CacheModule(ModuleManager moduleManager,
                          CacheMonitor cacheMonitor)
Deprecated. TODO since 4.5 - find another, cleaner, mechanism to provide the information this module needs instead of using ModuleManager.

Method Detail

getCacheFactory

public CacheFactory getCacheFactory()

setCacheFactory

public void setCacheFactory(CacheFactory cacheFactory)

getConfigurations

public Map<String,CacheConfiguration> getConfigurations()

setConfigurations

public void setConfigurations(Map<String,CacheConfiguration> configurations)

addConfiguration

public void addConfiguration(String name,
                             CacheConfiguration config)

getConfiguration

public CacheConfiguration getConfiguration(String name)

setCompression

public void setCompression(ContentCompression compression)

getCompression

public ContentCompression getCompression()

register

public void register(CacheModuleLifecycleListener listener)

start

public void start(ModuleLifecycleContext moduleLifecycleContext)
Specified by:
start in interface ModuleLifecycle

stop

public void stop(ModuleLifecycleContext moduleLifecycleContext)
Specified by:
stop in interface ModuleLifecycle

getInstance

public static CacheModule getInstance()
Deprecated. since 4.5, use IoC/CDI



Copyright © 2003-2012 Magnolia International Ltd.. All Rights Reserved.