org.apache.commons.jcs3.engine.control

Class CompositeCacheManager

java.lang.Object

org.apache.commons.jcs3.engine.control.CompositeCacheManager

All Implemented Interfaces:

IRemoteCacheConstants, ICompositeCacheManager, IProvideScheduler, IShutdownObservable

public class CompositeCacheManager
extends Object
implements IRemoteCacheConstants, ICompositeCacheManager, IProvideScheduler

Manages a composite cache. This provides access to caches and is the primary way to shutdown the caching system as a whole.

The composite cache manager is responsible for creating / configuring cache regions. It serves as a factory for the ComositeCache class. The CompositeCache is the core of JCS, the hub for various auxiliaries.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JMX_OBJECT_NAME JMX object name

Fields inherited from interface org.apache.commons.jcs3.auxiliary.remote.behavior.IRemoteCacheConstants

CACHE_SERVER_ATTRIBUTES_PROPERTY_PREFIX, CACHE_SERVER_PREFIX, CUSTOM_RMI_SOCKET_FACTORY_PROPERTY_PREFIX, PROPERTY_PREFIX, REMOTE_ALLOW_CLUSTER_GET, REMOTE_CACHE_SERVICE_NAME, REMOTE_CACHE_SERVICE_PORT, REMOTE_CACHE_SERVICE_VAL, REMOTE_LOCAL_CLUSTER_CONSISTENCY, SOCKET_TIMEOUT_MILLIS, TOMCAT_ON, TOMCAT_XML

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompositeCacheManager() Default constructor

Method Summary

Modifier and Type	Method and Description
void	addAuxiliaryCache(String auxName, String cacheName, AuxiliaryCache<?,?> cache) Add a cache to the map of registered auxiliary caches
void	addCache(String cacheName, ICache<?,?> cache) Add a cache to the map of registered caches
void	configure() Configure with default properties file
void	configure(Properties props) Configure from properties object.
void	configure(Properties props, boolean useSystemProperties) Configure from properties object, overriding with values from the system properties if instructed.
void	configure(Properties props, boolean useSystemProperties, boolean forceReconfiguration) Configure from properties object, overriding with values from the system properties if instructed.
void	configure(String propFile) Configure from specific properties file.
protected static CompositeCacheManager	createInstance() Simple factory method, must override in subclasses so getInstance creates / returns the correct object.
void	deregisterShutdownObserver(IShutdownObserver observer) Deregister the observer with the observable.
void	freeAuxiliaryCache(String key) Dispose a cache and remove it from the map of registered auxiliary caches
void	freeAuxiliaryCache(String auxName, String cacheName) Dispose a cache and remove it from the map of registered auxiliary caches
void	freeCache(String name)
void	freeCache(String name, boolean fromRemote)
<K,V> AuxiliaryCache<K,V>	getAuxiliaryCache(String auxName, String cacheName) Get a cache from the map of registered auxiliary caches
<K,V> CompositeCache<K,V>	getCache(ICompositeCacheAttributes cattr) Gets the cache attribute of the CacheHub object
<K,V> CompositeCache<K,V>	getCache(ICompositeCacheAttributes cattr, IElementAttributes attr) If the cache has already been created, then the CacheAttributes and the element Attributes will be ignored.
<K,V> CompositeCache<K,V>	getCache(String cacheName) Gets the cache attribute of the CacheHub object
<K,V> CompositeCache<K,V>	getCache(String cacheName, ICompositeCacheAttributes cattr) Gets the cache attribute of the CacheHub object
<K,V> CompositeCache<K,V>	getCache(String cacheName, ICompositeCacheAttributes cattr, IElementAttributes attr) Gets the cache attribute of the CacheHub object
Set<String>	getCacheNames() Returns a list of the current cache names.
ICacheType.CacheType	getCacheType()
Properties	getConfigurationProperties() This is exposed so other manager can get access to the props.
ICompositeCacheAttributes	getDefaultCacheAttributes() Gets the defaultCacheAttributes attribute of the CacheHub object
IElementAttributes	getDefaultElementAttributes() Gets the defaultElementAttributes attribute of the CacheHub object
IElementEventQueue	getElementEventQueue() Get the element event queue
static CompositeCacheManager	getInstance() Gets the CacheHub instance.
static CompositeCacheManager	getInstance(String propsFilename) Initializes the cache manager using the props file for the given name.
ScheduledExecutorService	getScheduledExecutorService() Get the scheduler service
ICacheStats[]	getStatistics() This returns data gathered for all regions and all the auxiliaries they currently uses.
String	getStats() Gets stats for debugging.
static CompositeCacheManager	getUnconfiguredInstance() Get a CacheHub instance which is not configured.
protected void	initialize() Creates a shutdown hook and starts the scheduler service
boolean	isConfigured()
boolean	isInitialized()
protected CompositeCacheConfigurator	newConfigurator()
void	registerShutdownObserver(IShutdownObserver observer) Perhaps the composite cache itself should be the observable object.
AuxiliaryCacheAttributes	registryAttrGet(String name)
void	registryAttrPut(AuxiliaryCacheAttributes auxAttr)
AuxiliaryCacheFactory	registryFacGet(String name)
void	registryFacPut(AuxiliaryCacheFactory auxFac)
void	release()
void	setJmxName(String name)
void	shutDown() Calls freeCache on all regions

Methods inherited from class java.lang.Object

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

Field Detail

JMX_OBJECT_NAME

public static final String JMX_OBJECT_NAME

JMX object name

See Also:

Constant Field Values

Constructor Detail

CompositeCacheManager

protected CompositeCacheManager()

Default constructor

Method Detail

getInstance

public static CompositeCacheManager getInstance()
                                         throws CacheException

Gets the CacheHub instance. For backward compatibility, if this creates the instance it will attempt to configure it with the default configuration. If you want to configure from your own source, use getUnconfiguredInstance()and then call configure()

Returns:

CompositeCacheManager

Throws:

CacheException - if the configuration cannot be loaded

getInstance

public static CompositeCacheManager getInstance(String propsFilename)
                                         throws CacheException

Initializes the cache manager using the props file for the given name.

Parameters:

propsFilename -

Returns:

CompositeCacheManager configured from the give propsFileName

Throws:

CacheException - if the configuration cannot be loaded

getUnconfiguredInstance

public static CompositeCacheManager getUnconfiguredInstance()

Get a CacheHub instance which is not configured. If an instance already exists, it will be returned.

Returns:

CompositeCacheManager

createInstance

protected static CompositeCacheManager createInstance()

Simple factory method, must override in subclasses so getInstance creates / returns the correct object.

Returns:

CompositeCacheManager

initialize

protected void initialize()

Creates a shutdown hook and starts the scheduler service

getElementEventQueue

public IElementEventQueue getElementEventQueue()

Get the element event queue

Returns:

the elementEventQueue

getScheduledExecutorService

public ScheduledExecutorService getScheduledExecutorService()

Get the scheduler service

Specified by:

getScheduledExecutorService in interface IProvideScheduler

Returns:

the scheduledExecutor

configure

public void configure()
               throws CacheException

Configure with default properties file

Throws:

CacheException - if the configuration cannot be loaded

configure

public void configure(String propFile)
               throws CacheException

Configure from specific properties file.

Parameters:

propFile - Path within classpath to load configuration from

Throws:

CacheException - if the configuration cannot be loaded

configure

public void configure(Properties props)

Configure from properties object.

This method will call configure, instructing it to use system properties as a default.

Parameters:

props -

configure

public void configure(Properties props,
                      boolean useSystemProperties)

Configure from properties object, overriding with values from the system properties if instructed.

You can override a specific value by passing in a system property:

For example, you could override this value in the cache.ccf file by starting up your program with the argument: -Djcs.auxiliary.LTCP.attributes.TcpListenerPort=1111

Parameters:

props -

useSystemProperties - -- if true, values starting with jcs will be put into the props file prior to configuring the cache.

configure

public void configure(Properties props,
                      boolean useSystemProperties,
                      boolean forceReconfiguration)

Configure from properties object, overriding with values from the system properties if instructed.

You can override a specific value by passing in a system property:

For example, you could override this value in the cache.ccf file by starting up your program with the argument: -Djcs.auxiliary.LTCP.attributes.TcpListenerPort=1111

Parameters:

props -

useSystemProperties - -- if true, values starting with jcs will be put into the props file prior to configuring the cache.

forceReconfiguration - - if the manager is already configured, we will try again. This may not work properly.

getDefaultCacheAttributes

public ICompositeCacheAttributes getDefaultCacheAttributes()

Gets the defaultCacheAttributes attribute of the CacheHub object

Returns:

The defaultCacheAttributes value

getDefaultElementAttributes

public IElementAttributes getDefaultElementAttributes()

Gets the defaultElementAttributes attribute of the CacheHub object

Returns:

The defaultElementAttributes value

getCache

public <K,V> CompositeCache<K,V> getCache(String cacheName)

Gets the cache attribute of the CacheHub object

Specified by:

getCache in interface ICompositeCacheManager

Parameters:

cacheName -

Returns:

CompositeCache -- the cache region controller

getCache

public <K,V> CompositeCache<K,V> getCache(String cacheName,
                                          ICompositeCacheAttributes cattr)

Gets the cache attribute of the CacheHub object

Parameters:

cacheName -

cattr -

Returns:

CompositeCache

getCache

public <K,V> CompositeCache<K,V> getCache(String cacheName,
                                          ICompositeCacheAttributes cattr,
                                          IElementAttributes attr)

Gets the cache attribute of the CacheHub object

Parameters:

cacheName -

cattr -

attr -

Returns:

CompositeCache

getCache

public <K,V> CompositeCache<K,V> getCache(ICompositeCacheAttributes cattr)

Gets the cache attribute of the CacheHub object

Parameters:

cattr -

Returns:

CompositeCache

getCache

public <K,V> CompositeCache<K,V> getCache(ICompositeCacheAttributes cattr,
                                          IElementAttributes attr)

If the cache has already been created, then the CacheAttributes and the element Attributes will be ignored. Currently there is no overriding the CacheAttributes once it is set up. You can change the default ElementAttributes for a region later.

Overriding the default elemental attributes will require changing the way the attributes are assigned to elements. Get cache creates a cache with defaults if none are specified. We might want to create separate method for creating/getting. . .

Parameters:

cattr -

attr -

Returns:

CompositeCache

newConfigurator

protected CompositeCacheConfigurator newConfigurator()

freeCache

public void freeCache(String name)

Parameters:

name -

freeCache

public void freeCache(String name,
                      boolean fromRemote)

Parameters:

name -

fromRemote -

shutDown

public void shutDown()

Calls freeCache on all regions

release

public void release()

getCacheNames

public Set<String> getCacheNames()

Returns a list of the current cache names.

Returns:

Set

getCacheType

public ICacheType.CacheType getCacheType()

Returns:

ICacheType.CACHE_HUB

registryFacPut

public void registryFacPut(AuxiliaryCacheFactory auxFac)

Parameters:

auxFac -

registryFacGet

public AuxiliaryCacheFactory registryFacGet(String name)

Parameters:

name -

Returns:

AuxiliaryCacheFactory

registryAttrPut

public void registryAttrPut(AuxiliaryCacheAttributes auxAttr)

Parameters:

auxAttr -

registryAttrGet

public AuxiliaryCacheAttributes registryAttrGet(String name)

Parameters:

name -

Returns:

AuxiliaryCacheAttributes

addCache

public void addCache(String cacheName,
                     ICache<?,?> cache)

Add a cache to the map of registered caches

Parameters:

cacheName - the region name

cache - the cache instance

addAuxiliaryCache

public void addAuxiliaryCache(String auxName,
                              String cacheName,
                              AuxiliaryCache<?,?> cache)

Add a cache to the map of registered auxiliary caches

Parameters:

auxName - the auxiliary name

cacheName - the region name

cache - the cache instance

getAuxiliaryCache

public <K,V> AuxiliaryCache<K,V> getAuxiliaryCache(String auxName,
                                                   String cacheName)

Get a cache from the map of registered auxiliary caches

Specified by:

getAuxiliaryCache in interface ICompositeCacheManager

Parameters:

auxName - the auxiliary name

cacheName - the region name

Returns:

the cache instance

freeAuxiliaryCache

public void freeAuxiliaryCache(String auxName,
                               String cacheName)
                        throws IOException

Dispose a cache and remove it from the map of registered auxiliary caches

Parameters:

auxName - the auxiliary name

cacheName - the region name

Throws:

IOException - if disposing of the cache fails

freeAuxiliaryCache

public void freeAuxiliaryCache(String key)
                        throws IOException

Dispose a cache and remove it from the map of registered auxiliary caches

Parameters:

key - the key into the map of auxiliaries

Throws:

IOException - if disposing of the cache fails

getStats

public String getStats()

Gets stats for debugging. This calls gets statistics and then puts all the results in a string. This returns data for all regions.

Specified by:

getStats in interface ICompositeCacheManager

Returns:

String

getStatistics

public ICacheStats[] getStatistics()

This returns data gathered for all regions and all the auxiliaries they currently uses.

Returns:

ICacheStats[]

registerShutdownObserver

public void registerShutdownObserver(IShutdownObserver observer)

Perhaps the composite cache itself should be the observable object. It doesn't make much of a difference. There are some problems with region by region shutdown. Some auxiliaries are global. They will need to track when every region has shutdown before doing things like closing the socket with a lateral.

Specified by:

registerShutdownObserver in interface IShutdownObservable

Parameters:

observer -

deregisterShutdownObserver

public void deregisterShutdownObserver(IShutdownObserver observer)

Description copied from interface: IShutdownObservable

Deregister the observer with the observable.

Specified by:

deregisterShutdownObserver in interface IShutdownObservable

Parameters:

observer -

getConfigurationProperties

public Properties getConfigurationProperties()

This is exposed so other manager can get access to the props.

Specified by:

getConfigurationProperties in interface ICompositeCacheManager

Returns:

the configurationProperties

isInitialized

public boolean isInitialized()

Returns:

the isInitialized

isConfigured

public boolean isConfigured()

Returns:

the isConfigured

setJmxName

public void setJmxName(String name)