javax.cache

Class Caching.CachingProviderRegistry

java.lang.Object

javax.cache.Caching.CachingProviderRegistry

Enclosing class:

Caching

public static class Caching.CachingProviderRegistry
extends Object

Maintains a registry of loaded CachingProviders scoped by ClassLoader.

Constructor Summary

Constructors

Constructor and Description
Caching.CachingProviderRegistry() Constructs a CachingProviderManager.

Method Summary

Methods

Modifier and Type	Method and Description
CachingProvider	getCachingProvider() Obtains the only CachingProvider defined by the getDefaultClassLoader().
CachingProvider	getCachingProvider(ClassLoader classLoader) Obtains the only CachingProvider defined by the specified ClassLoader.
CachingProvider	getCachingProvider(String fullyQualifiedClassName) Obtain the CachingProvider that is implemented by the specified fully qualified class name using the getDefaultClassLoader().
CachingProvider	getCachingProvider(String fullyQualifiedClassName, ClassLoader classLoader) Obtain the CachingProvider that is implemented by the specified fully qualified class name using the provided ClassLoader.
Iterable<CachingProvider>	getCachingProviders() Obtain the CachingProviders that are available via the getDefaultClassLoader().
Iterable<CachingProvider>	getCachingProviders(ClassLoader classLoader) Obtain the CachingProviders that are available via the specified ClassLoader.
ClassLoader	getDefaultClassLoader() Obtains the ClassLoader to use for API methods that don't explicitly require a ClassLoader but internally require one.
protected CachingProvider	loadCachingProvider(String fullyQualifiedClassName, ClassLoader classLoader) Load and instantiate the CachingProvider with the specified fully qualified class name using the provided ClassLoader
void	setDefaultClassLoader(ClassLoader classLoader) Set the ClassLoader to use for API methods that don't explicitly require a ClassLoader, but internally use one.

Methods inherited from class java.lang.Object

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

Constructor Detail

Caching.CachingProviderRegistry

public Caching.CachingProviderRegistry()

Constructs a CachingProviderManager.

Method Detail

getDefaultClassLoader

public ClassLoader getDefaultClassLoader()

Obtains the ClassLoader to use for API methods that don't explicitly require a ClassLoader but internally require one.

By default this is the Thread.getContextClassLoader().

Returns:

the default ClassLoader

setDefaultClassLoader

public void setDefaultClassLoader(ClassLoader classLoader)

Set the ClassLoader to use for API methods that don't explicitly require a ClassLoader, but internally use one.

Parameters:

classLoader - the ClassLoader or null if the calling Thread.getContextClassLoader() should be used

getCachingProvider

public CachingProvider getCachingProvider()

Obtains the only CachingProvider defined by the getDefaultClassLoader().

Should zero or more than one CachingProviders be available, a CacheException is thrown.

Returns:

the CachingProvider

Throws:

CacheException - should zero or more than one CachingProvider be available or a CachingProvider could not be loaded

See Also:

getCachingProvider(ClassLoader), getCachingProviders(ClassLoader)

getCachingProvider

public CachingProvider getCachingProvider(ClassLoader classLoader)

Obtains the only CachingProvider defined by the specified ClassLoader.

Should zero or more than one CachingProviders be available, a CacheException is thrown.

Parameters:

classLoader - the ClassLoader to use for loading the CachingProvider

Returns:

the CachingProvider

Throws:

CacheException - should zero or more than one CachingProvider be available or a CachingProvider could not be loaded

See Also:

getCachingProviders(ClassLoader)

getCachingProviders

public Iterable<CachingProvider> getCachingProviders()

Obtain the CachingProviders that are available via the getDefaultClassLoader().

If a javax.cache.cachingprovider system property is defined, only that CachingProvider specified by that property is returned. Otherwise all CachingProviders that are available via a ServiceLoader for CachingProviders using the default ClassLoader (and those explicitly requested via getCachingProvider(String)) are returned.

Returns:

an Iterable of CachingProviders loaded by the default ClassLoader

getCachingProviders

public Iterable<CachingProvider> getCachingProviders(ClassLoader classLoader)

Obtain the CachingProviders that are available via the specified ClassLoader.

If a javax.cache.cachingprovider system property is defined, only that CachingProvider specified by that property is returned. Otherwise all CachingProviders that are available via a ServiceLoader for CachingProviders using the specified ClassLoader (and those explicitly requested via getCachingProvider(String, ClassLoader)) are returned.

Parameters:

classLoader - the ClassLoader of the returned CachingProviders

Returns:

an Iterable of CachingProviders loaded by the specified ClassLoader

getCachingProvider

public CachingProvider getCachingProvider(String fullyQualifiedClassName)

Obtain the CachingProvider that is implemented by the specified fully qualified class name using the getDefaultClassLoader(). Should this CachingProvider already be loaded it is simply returned, otherwise an attempt will be made to load and instantiate the specified class name (using a no-args constructor).

Parameters:

fullyQualifiedClassName - the fully qualified class name of the CachingProvider

Returns:

the CachingProvider

Throws:

CacheException - when the CachingProvider can't be created

loadCachingProvider

protected CachingProvider loadCachingProvider(String fullyQualifiedClassName,
                                  ClassLoader classLoader)
                                       throws CacheException

Load and instantiate the CachingProvider with the specified fully qualified class name using the provided ClassLoader

Parameters:

fullyQualifiedClassName - the name of the CachingProvider class

classLoader - the ClassLoader to use

Returns:

a new CachingProvider instance

Throws:

CacheException - if the specified CachingProvider could not be loaded or the specified class is not a CachingProvider

getCachingProvider

public CachingProvider getCachingProvider(String fullyQualifiedClassName,
                                 ClassLoader classLoader)

Obtain the CachingProvider that is implemented by the specified fully qualified class name using the provided ClassLoader. Should this CachingProvider already be loaded it is returned, otherwise an attempt will be made to load and instantiate the specified class (using a no-args constructor).

Parameters:

fullyQualifiedClassName - the fully qualified class name of the CachingProvider

classLoader - the ClassLoader to load the CachingProvider

Returns:

the CachingProvider

Throws:

CacheException - when the CachingProvider can't be created