org.jboss.dashboard.database.cache
Class CacheConfigurationGenerator

java.lang.Object
  org.jboss.dashboard.factory.BasicFactoryElement
      org.jboss.dashboard.database.cache.CacheConfigurationGenerator

All Implemented Interfaces:

Serializable, FactoryLifecycle

Direct Known Subclasses:

CustomCacheConfigurationGenerator

public abstract class CacheConfigurationGenerator
extends BasicFactoryElement

This component creates the xml cache configuration for a given type of cache provider. Some managers may configure the cache programmatically, some others may generate an xml and place it in a path to be read.

See Also:

Serialized Form

Constructor Summary

CacheConfigurationGenerator()

Method Summary

boolean	createCustomCacheRegion(String cacheRegionName)
boolean	freeAllCache()
abstract String	getCacheUsage() Determine the type of cache usage to use
abstract void	initializeCacheConfig(CacheConfigurationManager cacheConfigurationManager) Create the cache configuration, either by generating an XML and placing it in the correct place or by programmatically configuring whatever is needed.

Methods inherited from class org.jboss.dashboard.factory.BasicFactoryElement

addPeriodicTask, addPeriodicTask, factoryLookup, getComponentAlias, getComponentDescription, getComponentName, getComponentScope, init, setComponentAlias, shutdown, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheConfigurationGenerator

public CacheConfigurationGenerator()

Method Detail

initializeCacheConfig

public abstract void initializeCacheConfig(CacheConfigurationManager cacheConfigurationManager)

Create the cache configuration, either by generating an XML and placing it in the correct place or by programmatically configuring whatever is needed.

Parameters:

cacheConfigurationManager - The generic configuration manager where detailed cache options might be configured.

getCacheUsage

public abstract String getCacheUsage()

Determine the type of cache usage to use

Returns:

createCustomCacheRegion

public boolean createCustomCacheRegion(String cacheRegionName)

freeAllCache

public boolean freeAllCache()