org.apache.shindig.common.cache.ehcache

Class EhCacheCacheProvider

java.lang.Object

org.apache.shindig.common.cache.ehcache.EhCacheCacheProvider

All Implemented Interfaces:

CacheProvider, GuiceServletContextListener.CleanupCapable

public class EhCacheCacheProvider
extends Object
implements CacheProvider, GuiceServletContextListener.CleanupCapable

Cache interface based on ehcache.

See Also:

http://www.ehcache.org

Constructor Summary

Constructors

Constructor and Description
EhCacheCacheProvider(String configPath, String filterPath, boolean jmxEnabled, boolean withCacheStats, GuiceServletContextListener.CleanupHandler cleanupHandler)

Method Summary

Methods

Modifier and Type	Method and Description
void	cleanup() Perform a shutdown of the underlying cache manager.
<K,V> Cache<K,V>	createCache(String name) Create a named single instance cache in this cache manager, if the cache already exists, return it if the name is null, a new anonymous cache is created
protected net.sf.ehcache.config.Configuration	getConfiguration(String configPath) Read the cache configuration from the specified resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCacheCacheProvider

@Inject
public EhCacheCacheProvider(String configPath,
                           String filterPath,
                           boolean jmxEnabled,
                           boolean withCacheStats,
                           GuiceServletContextListener.CleanupHandler cleanupHandler)
                     throws IOException

Parameters:

configPath - the path to the EhCache configuration file

filterPath - the path to the EhCache SizeOf engine filter file

jmxEnabled - true if JMX should be enabled for EhCache, false otherwise

withCacheStats - true if cache statistics should be enabled globally, false otherwise

cleanupHandler - cleanup handler with which to register to ensure proper cache shutdown via cleanup()

Throws:

IOException - if there was an issue parsing the given configuration

Method Detail

getConfiguration

protected net.sf.ehcache.config.Configuration getConfiguration(String configPath)
                                                        throws IOException

Read the cache configuration from the specified resource. This function is intended to be overrideable to allow for programmatic cache configuration.

Parameters:

configPath - the path to the configuration file

Returns:

Configuration the configuration object parsed from the configuration file

Throws:

IOException - if there was an error parsing the given configuration

cleanup

public void cleanup()

Perform a shutdown of the underlying cache manager.

Specified by:

cleanup in interface GuiceServletContextListener.CleanupCapable

createCache

public <K,V> Cache<K,V> createCache(String name)

Create a named single instance cache in this cache manager, if the cache already exists, return it if the name is null, a new anonymous cache is created

Specified by:

createCache in interface CacheProvider

Type Parameters:

K - The Key type for the cache

V - The pay-load type

Parameters:

name - The non-null name of the cache.

Returns:

A Cache configured to the required specification.