Package com.tangosol.coherence.jcache

Class AbstractCoherenceBasedCache<K,V,C extends CoherenceBasedConfiguration<K,V>>

java.lang.Object

com.tangosol.coherence.jcache.AbstractCoherenceBasedCache<K,V,C>

Type Parameters:

K - the type of the Cache keys

V - the type of the Cache values

C - the type of the Cache configuration

All Implemented Interfaces:

CoherenceBasedCache<K,V>, Closeable, AutoCloseable, Iterable<javax.cache.Cache.Entry<K,V>>, javax.cache.Cache<K,V>

Direct Known Subclasses:

LocalCache, PartitionedCache, PassThroughCache, RemoteCache

public abstract class AbstractCoherenceBasedCache<K,V,C extends CoherenceBasedConfiguration<K,V>>
extends Object
implements CoherenceBasedCache<K,V>

The base implementation of a CoherenceBasedCache.

Since:

Coherence 12.1.3

Author:

bo 2013.11.04

Nested Class Summary

Nested classes/interfaces inherited from interface javax.cache.Cache

javax.cache.Cache.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected C	m_configuration	The Configuration for the CoherenceBasedCache.
protected CoherenceBasedCacheManager	m_manager	The CoherenceBasedCacheManager that owns the Cache.
protected NamedCache	m_namedCache	The underlying NamedCache that holds then entries for the CoherenceBasedCache.
protected String	m_sJCacheName	The Cache name of the CoherenceBasedCache.

Fields inherited from interface com.tangosol.coherence.jcache.CoherenceBasedCache

JCACHE_CONFIG_BACK_SCHEME_NAME, JCACHE_CONFIG_BACK_SCHEME_SERVICE_NAME, JCACHE_CONFIG_CACHE_NAME, JCACHE_CONFIG_SCHEME_NAME, JCACHE_CONFIG_SERVICE_NAME, JCACHE_EXTEND_PROXY_SERVICE_NAME, JCACHE_EXTEND_SCHEME_NAME, JCACHE_EXTEND_SERVICE_NAME, JCACHE_LOCAL_CACHE_NAME_PATTERN, JCACHE_LOCAL_CACHE_NAME_PREFIX, JCACHE_LOCAL_SCHEME_NAME, JCACHE_LOCAL_SERVICE_NAME, JCACHE_PARTITIONED_CACHE_NAME_PATTERN, JCACHE_PARTITIONED_CACHE_NAME_PREFIX, JCACHE_PARTITIONED_SCHEME_NAME, JCACHE_PARTITIONED_SERVICE_NAME, JCACHE_REMOTE_SCHEME

Constructor Summary

Constructors

Constructor	Description
AbstractCoherenceBasedCache(CoherenceBasedCacheManager manager, String sJCacheName, C configuration)	Constructs an AbstractCoherenceBasedCache.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	ensureOpen()	Ensures that the CoherenceBasedCache is open (not closed).
javax.cache.CacheManager	getCacheManager()
protected ClassLoader	getClassLoader()	Determine the ClassLoader to use for the CoherenceBasedCache.
<T extends javax.cache.configuration.Configuration<K, V>> T	getConfiguration(Class<T> clz)
abstract JCacheIdentifier	getIdentifier()	Obtain the internal identifier used for JCache caches.
abstract javax.cache.management.CacheMXBean	getMBean()	Get JMX Bean associated with Cache.
String	getName()
abstract JCacheStatistics	getStatistics()	Get JCache Statistics associated with Cache.
boolean	isClosed()
abstract boolean	isStatisticsEnabled()	Get JCache Statistics status
abstract void	onBeforeClosing()	Closes a CoherenceBasedCache at the request of a call to Cache.close().
abstract void	setManagementEnabled(boolean fEnabled)	Set JCache Management status.
abstract void	setStatisticsEnabled(boolean fEnabled)	Set JCache statistics status
<T> T	unwrap(Class<T> clz)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.cache.Cache

clear, containsKey, deregisterCacheEntryListener, get, getAll, getAndPut, getAndRemove, getAndReplace, invoke, invokeAll, iterator, loadAll, put, putAll, putIfAbsent, registerCacheEntryListener, remove, remove, removeAll, removeAll, replace, replace

Methods inherited from interface com.tangosol.coherence.jcache.CoherenceBasedCache

destroy

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

m_manager

protected CoherenceBasedCacheManager m_manager

The CoherenceBasedCacheManager that owns the Cache.

m_sJCacheName

protected String m_sJCacheName

The Cache name of the CoherenceBasedCache.

m_namedCache

protected NamedCache m_namedCache

The underlying NamedCache that holds then entries for the CoherenceBasedCache.

m_configuration

protected C extends CoherenceBasedConfiguration<K,V> m_configuration

The Configuration for the CoherenceBasedCache.

Constructor Details

AbstractCoherenceBasedCache

public AbstractCoherenceBasedCache(CoherenceBasedCacheManager manager,
 String sJCacheName,
 C configuration)

Constructs an AbstractCoherenceBasedCache.

Parameters:

manager - the CoherenceBasedCacheManager that owns the CoherenceBasedCache

sJCacheName - the name of the Cache

configuration - the CoherenceBasedConfiguration for the Cache

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.cache.Cache<K,V>

Specified by:

close in interface Closeable

getConfiguration

public <T extends javax.cache.configuration.Configuration<K,
V>>
T getConfiguration(Class<T> clz)

Specified by:

getConfiguration in interface javax.cache.Cache<K,V>

getName

public String getName()

Specified by:

getName in interface javax.cache.Cache<K,V>

getCacheManager

public javax.cache.CacheManager getCacheManager()

Specified by:

getCacheManager in interface javax.cache.Cache<K,V>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface javax.cache.Cache<K,V>

unwrap

public <T> T unwrap(Class<T> clz)

Specified by:

unwrap in interface javax.cache.Cache<K,V>

ensureOpen

protected void ensureOpen()
                   throws IllegalStateException

Ensures that the CoherenceBasedCache is open (not closed).

Throws:

IllegalStateException - if the CoherenceBasedCache is closed

onBeforeClosing

public abstract void onBeforeClosing()

Closes a CoherenceBasedCache at the request of a call to Cache.close().

getClassLoader

protected ClassLoader getClassLoader()

Determine the ClassLoader to use for the CoherenceBasedCache.

Returns:

the ClassLoader

getMBean

public abstract javax.cache.management.CacheMXBean getMBean()

Get JMX Bean associated with Cache.

Returns:

JMX Bean

getStatistics

public abstract JCacheStatistics getStatistics()

Get JCache Statistics associated with Cache.

Returns:

JCache Statistics if exist or null.

setManagementEnabled

public abstract void setManagementEnabled(boolean fEnabled)

Set JCache Management status.

Parameters:

fEnabled - true to enable

setStatisticsEnabled

public abstract void setStatisticsEnabled(boolean fEnabled)

Set JCache statistics status

Parameters:

fEnabled - true to enable

isStatisticsEnabled

public abstract boolean isStatisticsEnabled()

Get JCache Statistics status

Returns:

true if enabled, otherwise false

getIdentifier

public abstract JCacheIdentifier getIdentifier()

Description copied from interface: CoherenceBasedCache

Obtain the internal identifier used for JCache caches.

Specified by:

getIdentifier in interface CoherenceBasedCache<K,V>

Returns:

the internal JCacheIdentifier