com.tangosol.coherence.jcache.passthroughcache

Class PassThroughCache<K,V>

java.lang.Object

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

com.tangosol.coherence.jcache.passthroughcache.PassThroughCache<K,V>

Type Parameters:

K - the type of the Cache keys

V - the type of the Cache values

All Implemented Interfaces:

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

public class PassThroughCache<K,V>
extends AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

A Cache that delegates (ie: passed-through) requests directly onto an existing Coherence NamedCache.

Since:

Coherence 12.1.3

Author:

bo 2013.10.23

Nested Class Summary

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

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

Field Summary

Fields inherited from class com.tangosol.coherence.jcache.AbstractCoherenceBasedCache

m_configuration, m_manager, m_namedCache, m_sJCacheName

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 and Description
PassThroughCache(CoherenceBasedCacheManager manager, String sJCacheName, PassThroughCacheConfiguration<K,V> configuration) Constructs a PassThroughCache

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(K key)
void	deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> configuration)
void	destroy() Destroys a CoherenceBasedCache due to a request from a CoherenceBasedCacheManager.
V	get(K key)
Map<K,V>	getAll(Set<? extends K> keys)
V	getAndPut(K key, V value)
V	getAndRemove(K key)
V	getAndReplace(K key, V value)
JCacheIdentifier	getIdentifier() Obtain the internal identifier used for JCache caches.
javax.cache.management.CacheMXBean	getMBean() Get JMX Bean associated with Cache.
JCacheStatistics	getStatistics() Get JCache Statistics associated with Cache.
<T> T	invoke(K key, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments)
<T> Map<K,javax.cache.processor.EntryProcessorResult<T>>	invokeAll(Set<? extends K> keys, javax.cache.processor.EntryProcessor<K,V,T> entryProcessor, Object... arguments)
boolean	isStatisticsEnabled() Get JCache Statistics status
Iterator<javax.cache.Cache.Entry<K,V>>	iterator()
void	loadAll(Set<? extends K> keys, boolean replaceExistingValues, javax.cache.integration.CompletionListener completionListener)
void	onBeforeClosing() Closes a CoherenceBasedCache at the request of a call to Cache.close().
void	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
boolean	putIfAbsent(K key, V value)
void	registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> configuration)
boolean	remove(K key)
boolean	remove(K key, V oldValue)
void	removeAll()
void	removeAll(Set<? extends K> keys)
boolean	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)
void	setManagementEnabled(boolean fEnabled) Set JCache Management status.
void	setStatisticsEnabled(boolean fEnabled) Set JCache statistics status

Methods inherited from class com.tangosol.coherence.jcache.AbstractCoherenceBasedCache

close, ensureOpen, getCacheManager, getClassLoader, getConfiguration, getName, isClosed, unwrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PassThroughCache

public PassThroughCache(CoherenceBasedCacheManager manager,
                        String sJCacheName,
                        PassThroughCacheConfiguration<K,V> configuration)

Constructs a PassThroughCache

Parameters:

manager - the CoherenceBasedCacheManager that owns the Cache

sJCacheName - the name of the JCache Cache

configuration - the PassThroughCacheConfiguration for the Cache

Method Detail

get

public V get(K key)

getAll

public Map<K,V> getAll(Set<? extends K> keys)

containsKey

public boolean containsKey(K key)

loadAll

public void loadAll(Set<? extends K> keys,
                    boolean replaceExistingValues,
                    javax.cache.integration.CompletionListener completionListener)

put

public void put(K key,
                V value)

getAndPut

public V getAndPut(K key,
                   V value)

putAll

public void putAll(Map<? extends K,? extends V> map)

putIfAbsent

public boolean putIfAbsent(K key,
                           V value)

remove

public boolean remove(K key)

remove

public boolean remove(K key,
                      V oldValue)

getAndRemove

public V getAndRemove(K key)

replace

public boolean replace(K key,
                       V oldValue,
                       V newValue)

replace

public boolean replace(K key,
                       V value)

getAndReplace

public V getAndReplace(K key,
                       V value)

removeAll

public void removeAll(Set<? extends K> keys)

removeAll

public void removeAll()

clear

public void clear()

invoke

public <T> T invoke(K key,
                    javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
                    Object... arguments)
             throws javax.cache.processor.EntryProcessorException

Throws:

javax.cache.processor.EntryProcessorException

invokeAll

public <T> Map<K,javax.cache.processor.EntryProcessorResult<T>> invokeAll(Set<? extends K> keys,
                                                                          javax.cache.processor.EntryProcessor<K,V,T> entryProcessor,
                                                                          Object... arguments)

registerCacheEntryListener

public void registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> configuration)

deregisterCacheEntryListener

public void deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> configuration)

iterator

public Iterator<javax.cache.Cache.Entry<K,V>> iterator()

destroy

public void destroy()

Description copied from interface: CoherenceBasedCache

Destroys a CoherenceBasedCache due to a request from a CoherenceBasedCacheManager.

onBeforeClosing

public void onBeforeClosing()

Description copied from class: AbstractCoherenceBasedCache

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

Specified by:

onBeforeClosing in class AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

getMBean

public javax.cache.management.CacheMXBean getMBean()

Description copied from class: AbstractCoherenceBasedCache

Get JMX Bean associated with Cache.

Specified by:

getMBean in class AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

Returns:

JMX Bean

getStatistics

public JCacheStatistics getStatistics()

Description copied from class: AbstractCoherenceBasedCache

Get JCache Statistics associated with Cache.

Specified by:

getStatistics in class AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

Returns:

JCache Statistics if exist or null.

setManagementEnabled

public void setManagementEnabled(boolean fEnabled)

Description copied from class: AbstractCoherenceBasedCache

Set JCache Management status.

Specified by:

setManagementEnabled in class AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

Parameters:

fEnabled - true to enable

setStatisticsEnabled

public void setStatisticsEnabled(boolean fEnabled)

Description copied from class: AbstractCoherenceBasedCache

Set JCache statistics status

Specified by:

setStatisticsEnabled in class AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

Parameters:

fEnabled - true to enable

isStatisticsEnabled

public boolean isStatisticsEnabled()

Description copied from class: AbstractCoherenceBasedCache

Get JCache Statistics status

Specified by:

isStatisticsEnabled in class AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

Returns:

true if enabled, otherwise false

getIdentifier

public JCacheIdentifier getIdentifier()

Description copied from interface: CoherenceBasedCache

Obtain the internal identifier used for JCache caches.

Specified by:

getIdentifier in interface CoherenceBasedCache<K,V>

Specified by:

getIdentifier in class AbstractCoherenceBasedCache<K,V,PassThroughCacheConfiguration<K,V>>

Returns:

the internal JCacheIdentifier