Package com.tangosol.coherence.jcache.passthroughcache

Class PassThroughCacheConfiguration<K,V>

java.lang.Object

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

Type Parameters:

K - the type of the Cache keys

V - the type of the Cache values

All Implemented Interfaces:

CoherenceBasedConfiguration<K,V>, Serializable, javax.cache.configuration.Configuration<K,V>

public class PassThroughCacheConfiguration<K,V>
extends Object
implements CoherenceBasedConfiguration<K,V>

A Configuration for a Cache based on an existing Coherence NamedCache.

Caches produced according to this configuration are not expected to be JCache-compliant. They simply provide a JCache interface (aka: wrapper) over native Coherence NamedCaches.

Since:

Coherence 12.1.3

Author:

bo 2013.10.23

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PassThroughCacheConfiguration()	Constructs a PassThroughCacheConfiguration that defaults to using the Cache name as the underlying NamedCache name with Object-based key and value types.
PassThroughCacheConfiguration(PassThroughCacheConfiguration<K,V> configuration)	Constructs a PassThroughCacheConfiguration based on a provided PassThroughCacheConfiguration.
PassThroughCacheConfiguration(javax.cache.configuration.CompleteConfiguration<K,V> configuration)	Constructs a PassThroughConfiguration based on a JCache CompleteConfiguration.

Method Summary

Modifier and Type	Method	Description
CoherenceBasedCache<K,V>	createCache(CoherenceBasedCacheManager manager, String sJCacheName)	Creates a CoherenceBasedCache based on the current state of the CoherenceBasedConfiguration, to be owned by the specified CoherenceBasedCacheManager.
void	destroyCache(CoherenceBasedCacheManager manager, String name)	Destroy a CoherenceBasedCache implementation.
Class<K>	getKeyType()
String	getNamedCacheName()	Obtains the desired mapping of a JCache Cache name to an Coherence NamedCache.
Class<V>	getValueType()
boolean	isStoreByValue()
PassThroughCacheConfiguration<K,V>	setNamedCacheName(String sNamedCacheName)	Sets the desired Coherence NamedCache name to map to when specifying a JCache Cache name
PassThroughCacheConfiguration<K,V>	setTypes(Class<K> clzKey, Class<V> clzValue)	Sets the expected type of keys and values for a PassThroughCache configured with this Configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

PassThroughCacheConfiguration

public PassThroughCacheConfiguration()

Constructs a PassThroughCacheConfiguration that defaults to using the Cache name as the underlying NamedCache name with Object-based key and value types.

PassThroughCacheConfiguration

public PassThroughCacheConfiguration(javax.cache.configuration.CompleteConfiguration<K,V> configuration)

Constructs a PassThroughConfiguration based on a JCache CompleteConfiguration.

WARNING: This is a lossy construction and a warning will be emitted when this method is called. Most CompleteConfiguration properties are ignored. Native Coherence configuration must be used when using PassThroughCache;

Parameters:

configuration - configuration properties of a JCache CompleteConfiguration. Note most of these properties are ignored.

PassThroughCacheConfiguration

public PassThroughCacheConfiguration(PassThroughCacheConfiguration<K,V> configuration)

Constructs a PassThroughCacheConfiguration based on a provided PassThroughCacheConfiguration.

Parameters:

configuration - the PassThroughCacheConfiguration

Method Detail

setNamedCacheName

public PassThroughCacheConfiguration<K,V> setNamedCacheName(String sNamedCacheName)

Sets the desired Coherence NamedCache name to map to when specifying a JCache Cache name

Parameters:

sNamedCacheName - the desired NamedCache (or null to default to the JCache name)

Returns:

the PassThroughCacheConfiguration to support fluent-style calls

getNamedCacheName

public String getNamedCacheName()

Obtains the desired mapping of a JCache Cache name to an Coherence NamedCache.

Returns:

the NamedCache name to use

setTypes

public PassThroughCacheConfiguration<K,V> setTypes(Class<K> clzKey,
                                                         Class<V> clzValue)

Sets the expected type of keys and values for a PassThroughCache configured with this Configuration. Setting both to Object.class means type-safety checks are not required (which is the default)

Parameters:

clzKey - the expected key type

clzValue - the expected value type

Returns:

the PassThroughCacheConfiguration to permit fluent-style method calls

Throws:

NullPointerException - should the key or value type be null

getKeyType

public Class<K> getKeyType()

Specified by:

getKeyType in interface javax.cache.configuration.Configuration<K,V>

getValueType

public Class<V> getValueType()

Specified by:

getValueType in interface javax.cache.configuration.Configuration<K,V>

isStoreByValue

public boolean isStoreByValue()

Specified by:

isStoreByValue in interface javax.cache.configuration.Configuration<K,V>

createCache

public CoherenceBasedCache<K,V> createCache(CoherenceBasedCacheManager manager,
                                                  String sJCacheName)
                                           throws IllegalArgumentException

Description copied from interface: CoherenceBasedConfiguration

Creates a CoherenceBasedCache based on the current state of the CoherenceBasedConfiguration, to be owned by the specified CoherenceBasedCacheManager.

Specified by:

createCache in interface CoherenceBasedConfiguration<K,V>

Parameters:

manager - the owning CoherenceBasedCacheManager

sJCacheName - the name of the Cache to be configured

Returns:

a CoherenceBasedCache

Throws:

IllegalArgumentException - when a Cache can't be created based on the current CoherenceBasedConfiguration

destroyCache

public void destroyCache(CoherenceBasedCacheManager manager,
                         String name)

Description copied from interface: CoherenceBasedConfiguration

Destroy a CoherenceBasedCache implementation.

Specified by:

destroyCache in interface CoherenceBasedConfiguration<K,V>

Parameters:

manager - the owning CoherenceBasedCacheManager

name - the name of the Cache to be destroyed