com.github.bordertech.taskmaster.cache.impl

Class CachingHelperProviderXmlConfig

java.lang.Object

com.github.bordertech.taskmaster.cache.impl.CachingHelperProviderXmlConfig

All Implemented Interfaces:

CachingHelperProvider

@Singleton
public class CachingHelperProviderXmlConfig
extends Object
implements CachingHelperProvider

CachingHelperProvider that relies on the cache config in a xml file.

Constructor Summary

Constructors

Constructor and Description
CachingHelperProviderXmlConfig()

Method Summary

Modifier and Type	Method and Description
void	closeCacheManager() Close and release the cache resources.
protected javax.cache.CacheManager	getManager()
<K,V> javax.cache.Cache<K,V>	getOrCreateCache(String name, Class<K> keyClass, Class<V> valueClass, javax.cache.configuration.Configuration<K,V> config) Create a cache with the specified configuration.
<K,V> javax.cache.Cache<K,V>	getOrCreateCache(String name, Class<K> keyClass, Class<V> valueClass, javax.cache.expiry.Duration duration) Create a cache with the specified duration.
protected <K,V> javax.cache.Cache<K,V>	handleGetCache(String name, Class<K> keyClass, Class<V> valueClass) Get the pre-configured cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingHelperProviderXmlConfig

public CachingHelperProviderXmlConfig()

Method Detail

closeCacheManager

public void closeCacheManager()

Description copied from interface: CachingHelperProvider

Close and release the cache resources.

Specified by:

closeCacheManager in interface CachingHelperProvider

getOrCreateCache

public <K,V> javax.cache.Cache<K,V> getOrCreateCache(String name,
                                                     Class<K> keyClass,
                                                     Class<V> valueClass,
                                                     javax.cache.expiry.Duration duration)

Description copied from interface: CachingHelperProvider

Create a cache with the specified duration.

Specified by:

getOrCreateCache in interface CachingHelperProvider

Type Parameters:

K - the cache entry key type

V - the cache entry value value

Parameters:

name - the cache name

keyClass - the key class type

valueClass - the value class type

duration - the cache entry duration

Returns:

the cache instance

getOrCreateCache

public <K,V> javax.cache.Cache<K,V> getOrCreateCache(String name,
                                                     Class<K> keyClass,
                                                     Class<V> valueClass,
                                                     javax.cache.configuration.Configuration<K,V> config)

Description copied from interface: CachingHelperProvider

Create a cache with the specified configuration.

Specified by:

getOrCreateCache in interface CachingHelperProvider

Type Parameters:

K - the cache entry key type

V - the cache entry value value

Parameters:

name - the cache name

keyClass - the key class type

valueClass - the value class type

config - the cache configuration

Returns:

the cache instance

handleGetCache

protected <K,V> javax.cache.Cache<K,V> handleGetCache(String name,
                                                      Class<K> keyClass,
                                                      Class<V> valueClass)

Get the pre-configured cache.

Type Parameters:

K - the cache key type

V - the cache entry type

Parameters:

name - the cache name

keyClass - the cache key class

valueClass - the cache entry class

Returns:

the cache instance

getManager

protected final javax.cache.CacheManager getManager()

Returns:

the XML Configured cache manager