net.sf.ehcache.constructs
Class CacheDecoratorFactory

java.lang.Object
  net.sf.ehcache.constructs.CacheDecoratorFactory

Direct Known Subclasses:

ReadThroughCacheFactory, RefreshAheadCacheFactory

public abstract class CacheDecoratorFactory
extends Object

An abstract factory for creating decorated Ehcache instances. Implementing classes should provide their own concrete factory extending this factory.

Author:

Abhishek Sanoujam

Field Summary

static String

DASH Dash string : "-"

Constructor Summary

CacheDecoratorFactory()

Method Summary

abstract Ehcache	createDecoratedEhcache(Ehcache cache, Properties properties) Creates a decorated Ehcache using the properties specified for configuring the decorator.
abstract Ehcache	createDefaultDecoratedEhcache(Ehcache cache, Properties properties) This method is called when the factory is specified for the defaultCache in the config.
static String	generateDefaultDecoratedCacheName(Ehcache cache, String cacheNameSuffix) Utility method to generate name of decorated cache to be created using factory specified in defaultCache.

Methods inherited from class java.lang.Object

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

Field Detail

DASH

public static final String DASH

Dash string : "-"

See Also:

Constant Field Values

Constructor Detail

CacheDecoratorFactory

public CacheDecoratorFactory()

Method Detail

createDecoratedEhcache

public abstract Ehcache createDecoratedEhcache(Ehcache cache,
                                               Properties properties)

Creates a decorated Ehcache using the properties specified for configuring the decorator.

If the returned decorated cache has the same name as the underlying cache, then the original cache will be replaced by this new decorated cache in the CacheManager.

Parameters:

cache - a reference to the owning cache

properties - implementation specific properties configured as delimiter separated name value pairs in ehcache.xml

Returns:

a decorated Ehcache

createDefaultDecoratedEhcache

public abstract Ehcache createDefaultDecoratedEhcache(Ehcache cache,
                                                      Properties properties)

This method is called when the factory is specified for the defaultCache in the config. Create the decorated Ehcache using the properties specified.

If the returned decorated cache has the same name as the underlying cache, then the original cache will be replaced by this new decorated cache in the CacheManager.

Parameters:

cache - a reference to the owning cache

properties - implementation specific properties configured as delimiter separated name value pairs in ehcache.xml

Returns:

a decorated Ehcache

generateDefaultDecoratedCacheName

public static String generateDefaultDecoratedCacheName(Ehcache cache,
                                                       String cacheNameSuffix)

Utility method to generate name of decorated cache to be created using factory specified in defaultCache.

Parameters:

cache - the underlying cache

cacheNameSuffix - Name to be used as suffix. This is normally provided as a property in the decorator config properties. If this parameter is null or empty string, cache.getName() is returned

Returns:

Name to be used for the new decorated cache in the form of cache.getName() + "-" + cacheNameSuffix or cache.getName() if cacheNameSuffix is null