com.tangosol.coherence.jcache.partitionedcache

Class PartitionedCache<K,V>

java.lang.Object

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

com.tangosol.coherence.jcache.partitionedcache.PartitionedCache<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

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

public class PartitionedCache<K,V>
extends AbstractCoherenceBasedCache<K,V,PartitionedCacheConfiguration<K,V>>

JCache of Key, Value pairs implemented over distributed cache.

Since:

Coherence 12.1.3

Author:

jf 2013.07.07

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PartitionedCache.EntryIterator<K,V> JCache Entry iterator

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
PartitionedCache(CoherenceBasedCacheManager manager, String sJCacheName, PartitionedCacheConfiguration<K,V> configuration) Constructs a PartitionedCache configured by PartitionedCacheConfiguration in context of CoherenceBasedCacheManager with JCache name sJCacheName.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(K key)
void	deregisterCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> config)
void	destroy() Destroys a CoherenceBasedCache due to a request from a CoherenceBasedCacheManager.
static void	destroyCache(CoherenceBasedCacheManager mgr, JCacheIdentifier id) Destroy a partitioned cache when there is no PartitionedCache object.
static void	destroyCache(CoherenceBasedCacheManager mgr, JCacheIdentifier id, NamedCache namedCache) Destroy a partitioned cache.
V	get(K key)
Map<K,V>	getAll(Set<? extends K> setKey)
V	getAndPut(K key, V value)
V	getAndRemove(K key)
V	getAndReplace(K key, V value)
protected ClassLoader	getClassLoader() get class loader for this Cache
JCacheContext	getContext() Return current JCacheContext
JCacheIdentifier	getIdentifier() Obtain the internal identifier used for JCache caches.
javax.cache.management.CacheMXBean	getMBean() Get JMX Management Bean.
protected CopyOnWriteArraySet<CoherenceCacheEntryListenerRegistration<K,V>>	getRegisteredAsynchronousEventListeners() get asynchronous CacheEntryListenerRegistrations
protected CopyOnWriteArraySet<CoherenceCacheEntryListenerRegistration<K,V>>	getRegisteredSynchronousEventListeners() get synchronous CacheEntryListenerRegistrations
JCacheStatistics	getStatistics() Get JCache statistics
<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> setKey, javax.cache.processor.EntryProcessor<K,V,T> proc, Object... arguments)
boolean	isStatisticsEnabled() Get JCache Statistics status
Iterator<javax.cache.Cache.Entry<K,V>>	iterator()
void	loadAll(Set<? extends K> setKey, boolean fReplaceExistingValues, javax.cache.integration.CompletionListener listener)
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)
void	putAll(Map<? extends K,? extends V> map, boolean fReplaceExistingValues, boolean fUseWriteThrough)
boolean	putIfAbsent(K key, V value)
void	registerCacheEntryListener(javax.cache.configuration.CacheEntryListenerConfiguration<K,V> config)
boolean	remove(K key)
boolean	remove(K key, V value)
void	removeAll()
void	removeAll(Set<? extends K> keys)
boolean	replace(K key, V value)
boolean	replace(K key, V valueOrig, V value)
void	setManagementEnabled(boolean fEnabled) Sets management enablement
void	setStatisticsEnabled(boolean fEnabled) Sets m_stats
protected void	submit(Runnable task) Requests a FutureTask to be performed.
String	toString()

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PartitionedCache

public PartitionedCache(CoherenceBasedCacheManager manager,
                        String sJCacheName,
                        PartitionedCacheConfiguration<K,V> configuration)

Constructs a PartitionedCache configured by PartitionedCacheConfiguration in context of CoherenceBasedCacheManager with JCache name sJCacheName.

Parameters:

manager - CacheManager manages the created PartitionedCache.

sJCacheName - JCache cache name that must be unique within CoherenceBasedCacheManager context

configuration - JCache cache configuration

Method Detail

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,PartitionedCacheConfiguration<K,V>>

Returns:

the internal JCacheIdentifier

destroy

public void destroy()

Description copied from interface: CoherenceBasedCache

Destroys a CoherenceBasedCache due to a request from a CoherenceBasedCacheManager.

get

public V get(K key)

getAll

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

containsKey

public boolean containsKey(K key)

loadAll

public void loadAll(Set<? extends K> setKey,
                    boolean fReplaceExistingValues,
                    javax.cache.integration.CompletionListener listener)

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)

putAll

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

Parameters:

map - map

fReplaceExistingValues - if false, do not update existing values

fUseWriteThrough - is writer-through enabled

putIfAbsent

public boolean putIfAbsent(K key,
                           V value)

remove

public boolean remove(K key)

remove

public boolean remove(K key,
                      V value)

getAndRemove

public V getAndRemove(K key)

replace

public boolean replace(K key,
                       V valueOrig,
                       V value)

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)

invokeAll

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

registerCacheEntryListener

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

deregisterCacheEntryListener

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

iterator

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

getMBean

public javax.cache.management.CacheMXBean getMBean()

Get JMX Management Bean.

Specified by:

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

Returns:

JMX Management bean

getStatistics

public JCacheStatistics getStatistics()

Get JCache statistics

Specified by:

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

Returns:

JCache statistics when enabled, return null when not enabled.

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,PartitionedCacheConfiguration<K,V>>

isStatisticsEnabled

public boolean isStatisticsEnabled()

Description copied from class: AbstractCoherenceBasedCache

Get JCache Statistics status

Specified by:

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

Returns:

true if enabled, otherwise false

getClassLoader

protected ClassLoader getClassLoader()

get class loader for this Cache

Overrides:

getClassLoader in class AbstractCoherenceBasedCache<K,V,PartitionedCacheConfiguration<K,V>>

Returns:

a classloader

submit

protected void submit(Runnable task)

Requests a FutureTask to be performed.

Parameters:

task - the FutureTask to be performed

getRegisteredSynchronousEventListeners

protected CopyOnWriteArraySet<CoherenceCacheEntryListenerRegistration<K,V>> getRegisteredSynchronousEventListeners()

get synchronous CacheEntryListenerRegistrations

Returns:

a thread-safe set of CacheEntryListenerRegistrations that are all synchronous listeners.

getRegisteredAsynchronousEventListeners

protected CopyOnWriteArraySet<CoherenceCacheEntryListenerRegistration<K,V>> getRegisteredAsynchronousEventListeners()

get asynchronous CacheEntryListenerRegistrations

Returns:

a thread-safe set of CacheEntryListenerRegistrations that are all asynchronous listeners.

setStatisticsEnabled

public void setStatisticsEnabled(boolean fEnabled)

Sets m_stats

Specified by:

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

Parameters:

fEnabled - true to enable

setManagementEnabled

public void setManagementEnabled(boolean fEnabled)

Sets management enablement

Specified by:

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

Parameters:

fEnabled - true if management should be fEnabled

getContext

public JCacheContext getContext()

Return current JCacheContext

Returns:

JCacheContext

destroyCache

public static void destroyCache(CoherenceBasedCacheManager mgr,
                                JCacheIdentifier id,
                                NamedCache namedCache)

Destroy a partitioned cache.

Parameters:

mgr - CoherenceBasedCacheManager

id - PartitionedCache external cache name

namedCache - Coherence NamedCache

destroyCache

public static void destroyCache(CoherenceBasedCacheManager mgr,
                                JCacheIdentifier id)

Destroy a partitioned cache when there is no PartitionedCache object. This method removes leftover context such as mapping from JCache name to configuration and destroys outstanding NamedCache. Handles scenario where cache is created and closed in one jvm and discovered not destroyed in another jvm.

Parameters:

mgr - CoherenceBasedCacheManager

id - PartitionedCache external cache name

toString

public String toString()

Overrides:

toString in class Object