net.oschina.j2cache.ehcache

Class EhCacheProvider

java.lang.Object

net.oschina.j2cache.ehcache.EhCacheProvider

All Implemented Interfaces:

CacheProvider

public class EhCacheProvider
extends Object
implements CacheProvider

EhCache 2.x 缓存管理器的封装，用来管理多个缓存区域

Author:

Winter Lau (javayou@gmail.com), wendal

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_EHCACHE_CONFIG_XML
static String	KEY_EHCACHE_NAME

Constructor Summary

Constructors

Constructor and Description
EhCacheProvider()

Method Summary

Modifier and Type	Method and Description
EhCache	buildCache(String regionName, CacheExpiredListener listener) Builds a Cache.
EhCache	buildCache(String region, long timeToLiveInSeconds, CacheExpiredListener listener) Configure the cache with timeToLiveInMills
int	level() 缓存的层级
String	name() 缓存的标识名称
Collection<CacheChannel.Region>	regions() Return all channels defined in first level cache
void	removeCache(String region) Remove a cache region
void	start(Properties props) init ehcache config
void	stop() Callback to perform any necessary cleanup of the underlying cache implementation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.oschina.j2cache.CacheProvider

isLevel

Field Detail

KEY_EHCACHE_NAME

public static final String KEY_EHCACHE_NAME

See Also:

Constant Field Values

KEY_EHCACHE_CONFIG_XML

public static final String KEY_EHCACHE_CONFIG_XML

See Also:

Constant Field Values

Constructor Detail

EhCacheProvider

public EhCacheProvider()

Method Detail

name

public String name()

Description copied from interface: CacheProvider

缓存的标识名称

Specified by:

name in interface CacheProvider

Returns:

return cache provider name

level

public int level()

Description copied from interface: CacheProvider

缓存的层级

Specified by:

level in interface CacheProvider

Returns:

current provider level

regions

public Collection<CacheChannel.Region> regions()

Description copied from interface: CacheProvider

Return all channels defined in first level cache

Specified by:

regions in interface CacheProvider

Returns:

all regions name

buildCache

public EhCache buildCache(String regionName,
                          CacheExpiredListener listener)

Builds a Cache.

Specified by:

buildCache in interface CacheProvider

Parameters:

regionName - the regionName of the cache. Must match a cache configured in ehcache.xml

listener - cache listener

Returns:

a newly built cache will be built and initialised

buildCache

public EhCache buildCache(String region,
                          long timeToLiveInSeconds,
                          CacheExpiredListener listener)

Description copied from interface: CacheProvider

Configure the cache with timeToLiveInMills

Specified by:

buildCache in interface CacheProvider

Parameters:

region - cache region name

timeToLiveInSeconds - time to live in second

listener - listener for expired elements

Returns:

return cache instance

removeCache

public void removeCache(String region)

Description copied from interface: CacheProvider

Remove a cache region

Specified by:

removeCache in interface CacheProvider

Parameters:

region - cache region name

start

public void start(Properties props)

init ehcache config

Specified by:

start in interface CacheProvider

Parameters:

props - current configuration settings.

stop

public void stop()

Callback to perform any necessary cleanup of the underlying cache implementation.

Specified by:

stop in interface CacheProvider