Skip navigation links

com.tangosol.net
Interface CacheFactoryBuilder

All Known Implementing Classes:

ContainerAdapter.ContainerCacheFactoryBuilder, DefaultCacheFactoryBuilder, ScopedCacheFactoryBuilder, SingletonCacheFactoryBuilder

public interface CacheFactoryBuilder

CacheFactoryBuilder provides the means for building and managing configurable cache factories across class loaders in a pluggable fashion.

This is an advanced facility that could be used within J2EE or OSGi containers to provide a class loader based application isolation.

Since:

Coherence 3.5.1

Author:

gg,rhl 2009.07.14

Method Summary

ConfigurableCacheFactory	getConfigurableCacheFactory(java.lang.ClassLoader loader) Return the default ConfigurableCacheFactory for a given class loader.
ConfigurableCacheFactory	getConfigurableCacheFactory(java.lang.String sConfigURI, java.lang.ClassLoader loader) Return the ConfigurableCacheFactory for a given URI and class loader.
void	release(ConfigurableCacheFactory factory) Release the specified ConfigurableCacheFactory.
void	releaseAll(java.lang.ClassLoader loader) Release all ConfigurableCacheFactory objects for a given ClassLoader.
void	setCacheConfiguration(java.lang.ClassLoader loader, XmlElement xmlConfig) Dynamically set the default cache configuration for a given class loader.
void	setCacheConfiguration(java.lang.String sConfigURI, java.lang.ClassLoader loader, XmlElement xmlConfig) Dynamically set the cache configuration for a given URI and class loader.
ConfigurableCacheFactory	setConfigurableCacheFactory(ConfigurableCacheFactory ccf, java.lang.String sConfigURI, java.lang.ClassLoader loader, boolean fReplace) Dynamically set the ConfigurableCacheFactory for a given URI and class loader.

Method Detail

getConfigurableCacheFactory

ConfigurableCacheFactory getConfigurableCacheFactory(java.lang.ClassLoader loader)

Return the default ConfigurableCacheFactory for a given class loader.

Parameters:

loader - class loader for which the configuration should be used; must not be null

Returns:

the default ConfigurableCacheFactory for a given class loader

getConfigurableCacheFactory

ConfigurableCacheFactory getConfigurableCacheFactory(java.lang.String sConfigURI,
                                                     java.lang.ClassLoader loader)

Return the ConfigurableCacheFactory for a given URI and class loader.

Parameters:

sConfigURI - the configuration URI; must not be null

loader - class loader for which the configuration should be used; must not be null

Returns:

the ConfigurableCacheFactory for a given URI and class loader

setCacheConfiguration

void setCacheConfiguration(java.lang.ClassLoader loader,
                           XmlElement xmlConfig)

Dynamically set the default cache configuration for a given class loader. If a ConfigurableCacheFactory for the given class loader already exists, the factory will be released.

Parameters:

loader - class loader for which the configuration should be used; must not be null

xmlConfig - cache configuration in xml element format

setCacheConfiguration

void setCacheConfiguration(java.lang.String sConfigURI,
                           java.lang.ClassLoader loader,
                           XmlElement xmlConfig)

Dynamically set the cache configuration for a given URI and class loader. If a ConfigurableCacheFactory for the given URI and class loader already exists, the factory will be released.

Parameters:

sConfigURI - the configuration URI; must not be null

loader - class loader for which the configuration should be used; must not be null

xmlConfig - cache configuration in xml element format

setConfigurableCacheFactory

ConfigurableCacheFactory setConfigurableCacheFactory(ConfigurableCacheFactory ccf,
                                                     java.lang.String sConfigURI,
                                                     java.lang.ClassLoader loader,
                                                     boolean fReplace)

Dynamically set the ConfigurableCacheFactory for a given URI and class loader. If a ConfigurableCacheFactory for the given URI and class loader already exists and the replacement is requested, the factory will be released.

Parameters:

ccf - the ConfigurableCacheFactory instance

sConfigURI - the configuration URI; must not be null

loader - class loader for which the configuration should be used; must not be null

fReplace - specifies whether to replace a ConfigurableCacheFactory if one is already registered

Returns:

the previous ConfigurableCacheFactory associated with the URI and loader, if any

Since:

Coherence 12.1.2

releaseAll

void releaseAll(java.lang.ClassLoader loader)

Release all ConfigurableCacheFactory objects for a given ClassLoader.

Parameters:

loader - the class loader for which all associated cache factories should be released

release

void release(ConfigurableCacheFactory factory)

Release the specified ConfigurableCacheFactory.

Parameters:

factory - the ConfigurableCacheFactory to release

Skip navigation links