com.hazelcast.cache.impl

Class AbstractHazelcastCachingProvider

java.lang.Object

com.hazelcast.cache.impl.AbstractHazelcastCachingProvider

All Implemented Interfaces:

Closeable, AutoCloseable, javax.cache.spi.CachingProvider

Direct Known Subclasses:

HazelcastClientCachingProvider, HazelcastServerCachingProvider

public abstract class AbstractHazelcastCachingProvider
extends Object
implements javax.cache.spi.CachingProvider

Abstract CachingProvider implementation providing shared functionality to server and client caching providers.

This class encapsulates following details:

• Hazelcast instance for default uri and default class loader.
• default uri.
• default class loader.
• accessing the singleton CacheManager by uri and class loader.
• managing lifecycle of cache managers.

See Also:

CachingProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected ClassLoader	defaultClassLoader
protected URI	defaultURI
protected HazelcastInstance	hazelcastInstance
protected static String	INVALID_HZ_INSTANCE_SPECIFICATION_MESSAGE
protected static ILogger	LOGGER
static String	NAMED_JCACHE_HZ_INSTANCE System property to control whether the default Hazelcast instance, which may be started when obtaining the default CachingProvider, will have an instance name set or not.
protected boolean	namedDefaultHzInstance
static String	SHARED_JCACHE_INSTANCE_NAME Name of default HazelcastInstance which may be started when obtaining the default CachingProvider.
protected static Set<String>	SUPPORTED_SCHEMES

Constructor Summary

Constructors

Constructor and Description
AbstractHazelcastCachingProvider()

Method Summary

Modifier and Type	Method and Description
void	close()
void	close(ClassLoader classLoader)
void	close(URI uri, ClassLoader classLoader)
protected abstract <T extends AbstractHazelcastCacheManager> T	createCacheManager(HazelcastInstance instance, URI uri, ClassLoader classLoader, Properties properties)
protected <T extends AbstractHazelcastCacheManager> T	createHazelcastCacheManager(URI uri, ClassLoader classLoader, Properties managerProperties)
javax.cache.CacheManager	getCacheManager()
javax.cache.CacheManager	getCacheManager(URI uri, ClassLoader classLoader)
javax.cache.CacheManager	getCacheManager(URI uri, ClassLoader classLoader, Properties properties)
ClassLoader	getDefaultClassLoader()
Properties	getDefaultProperties()
URI	getDefaultURI()
protected ClassLoader	getManagerClassLoader(ClassLoader classLoader)
protected URI	getManagerUri(URI uri)
protected abstract HazelcastInstance	getOrCreateInstance(URI uri, ClassLoader classLoader, Properties properties)
protected boolean	isConfigLocation(URI location)
boolean	isSupported(javax.cache.configuration.OptionalFeature optionalFeature)
protected void	shutdownHazelcastInstance()

Methods inherited from class java.lang.Object

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

Field Detail

SHARED_JCACHE_INSTANCE_NAME

public static final String SHARED_JCACHE_INSTANCE_NAME

Name of default HazelcastInstance which may be started when obtaining the default CachingProvider.

See Also:

Constant Field Values

NAMED_JCACHE_HZ_INSTANCE

public static final String NAMED_JCACHE_HZ_INSTANCE

System property to control whether the default Hazelcast instance, which may be started when obtaining the default CachingProvider, will have an instance name set or not. When not set or when system property hazelcast.named.jcache.instance is "true", then a common instance name is used to get-or-create the default HazelcastInstance. When system property hazelcast.named.jcache.instance is "false", then no instance name is set on the default configuration.

See Also:

Constant Field Values

LOGGER

protected static final ILogger LOGGER

INVALID_HZ_INSTANCE_SPECIFICATION_MESSAGE

protected static final String INVALID_HZ_INSTANCE_SPECIFICATION_MESSAGE

See Also:

Constant Field Values

SUPPORTED_SCHEMES

protected static final Set<String> SUPPORTED_SCHEMES

hazelcastInstance

protected volatile HazelcastInstance hazelcastInstance

defaultClassLoader

protected final ClassLoader defaultClassLoader

defaultURI

protected final URI defaultURI

namedDefaultHzInstance

protected final boolean namedDefaultHzInstance

Constructor Detail

AbstractHazelcastCachingProvider

public AbstractHazelcastCachingProvider()

Method Detail

getCacheManager

public javax.cache.CacheManager getCacheManager(URI uri,
                                                ClassLoader classLoader,
                                                Properties properties)

Specified by:

getCacheManager in interface javax.cache.spi.CachingProvider

getDefaultClassLoader

public ClassLoader getDefaultClassLoader()

Specified by:

getDefaultClassLoader in interface javax.cache.spi.CachingProvider

getDefaultURI

public URI getDefaultURI()

Specified by:

getDefaultURI in interface javax.cache.spi.CachingProvider

getDefaultProperties

public Properties getDefaultProperties()

Specified by:

getDefaultProperties in interface javax.cache.spi.CachingProvider

getCacheManager

public javax.cache.CacheManager getCacheManager(URI uri,
                                                ClassLoader classLoader)

Specified by:

getCacheManager in interface javax.cache.spi.CachingProvider

getCacheManager

public javax.cache.CacheManager getCacheManager()

Specified by:

getCacheManager in interface javax.cache.spi.CachingProvider

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface javax.cache.spi.CachingProvider

shutdownHazelcastInstance

protected void shutdownHazelcastInstance()

close

public void close(ClassLoader classLoader)

Specified by:

close in interface javax.cache.spi.CachingProvider

close

public void close(URI uri,
                  ClassLoader classLoader)

Specified by:

close in interface javax.cache.spi.CachingProvider

isSupported

public boolean isSupported(javax.cache.configuration.OptionalFeature optionalFeature)

Specified by:

isSupported in interface javax.cache.spi.CachingProvider

getManagerUri

protected URI getManagerUri(URI uri)

getManagerClassLoader

protected ClassLoader getManagerClassLoader(ClassLoader classLoader)

createHazelcastCacheManager

protected <T extends AbstractHazelcastCacheManager> T createHazelcastCacheManager(URI uri,
                                                                                  ClassLoader classLoader,
                                                                                  Properties managerProperties)

getOrCreateInstance

protected abstract HazelcastInstance getOrCreateInstance(URI uri,
                                                         ClassLoader classLoader,
                                                         Properties properties)
                                                  throws URISyntaxException,
                                                         IOException

Throws:

URISyntaxException

IOException

createCacheManager

protected abstract <T extends AbstractHazelcastCacheManager> T createCacheManager(HazelcastInstance instance,
                                                                                  URI uri,
                                                                                  ClassLoader classLoader,
                                                                                  Properties properties)

isConfigLocation

protected boolean isConfigLocation(URI location)