DefaultConfigurableCacheFactory Class |
14c (14.1.1.0)
F23534-02
The DefaultConfigurableCacheFactory provides a facility to
access caches declared in a "cache-config.xsd" compliant configuration
file.
Inheritance HierarchyNamespace: Tangosol.Net
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
SyntaxC#
public class DefaultConfigurableCacheFactory : IConfigurableCacheFactory, IXmlConfigurable
The DefaultConfigurableCacheFactory type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | DefaultConfigurableCacheFactory |
Construct a default DefaultConfigurableCacheFactory using the
default configuration file name.
|
| DefaultConfigurableCacheFactory(String) |
Construct a DefaultConfigurableCacheFactory using the specified
path to a "cache-config.xsd" compliant configuration file.
|
| DefaultConfigurableCacheFactory(IXmlElement) |
Construct a DefaultConfigurableCacheFactory using the specified
configuration XML.
|
Properties| Name | Description | |
|---|---|---|
 | Config |
The current configuration of the object.
|
 | DefaultCacheConfig |
The default XML configuration used when one isn't explicitly passed
in the constructor for this class.
|
| DefaultCacheConfigResource |
The IResource for the default XML configuration used
when one isn't explicitly passed in the constructor for this class.
|
| OperationalContext |
The IOperationalContext for this
DefaultConfigurableCacheFactory.
|
 | StoreCache |
Store that holds cache references by name and optionally,
if configured, IPrincipal.
|
| StoreService |
Store that holds cache references by name and optionally,
if configured, IPrincipal.
|
Methods| Name | Description | |
|---|---|---|
| ConfigureBackingCache |
Configures a backing cache according to the scheme.
|
 | ConfigureCache |
Ensures a cache for given scheme.
|
| ConvertInt(IXmlValue) |
Convert the value in the specified IXmlValue to an int.
If the conversion fails, a warning will be logged.
|
| ConvertInt(IXmlValue, Int32) |
Convert the value in the specified IXmlValue to an int.
If the conversion fails, a warning will be logged.
|
| DestroyCache |
Release and destroy the specified cache.
|
| EnsureCache(String) |
Ensure a cache for the given name using the corresponding XML
configuration.
|
| EnsureCache(DefaultConfigurableCacheFactoryCacheInfo, IXmlElement) |
Obtain the INamedCache reference for the cache
service defined by the specified scheme.
|
| EnsureService(String) |
Ensure a service for the given name using the corresponding XML
configuration.
|
| EnsureService(IXmlElement) |
Ensure the service for the specified scheme.
|
| EnsureService(String, ServiceType) |
Ensure the service for the specified service name and type.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| FindScheme(String) |
In the configuration XML find a "scheme" element associated with
a given cache name.
|
| FindScheme(IXmlElement, String) |
In the specified configuration XML, find a "scheme" element
associated with the specified scheme name.
|
| FindSchemeMapping |
In the configuration XML find a "cache-mapping" element
associated with a given cache name.
|
| FindServiceScheme |
In the configuration XML find a "scheme" element associated with
a given service name.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| initializeBundler |
Initialize the specified bundler using the "bundle-config" element.
|
| InstantiateAny |
Create an object using "class-scheme" element.
|
| InstantiateBundlingNamedCache |
Create a BundlingNamedCache using the "operation-bundling" element.
|
| InstantiateCache |
Create a backing cache using the "class-scheme" element.
|
| InstantiateCacheListener |
Create an ICacheListener using the "class-scheme"
element.
|
| InstantiateCacheStore |
Create an ICacheLoader or ICacheStore
using the "class-scheme" element.
|
| InstantiateLocalNamedCache(Int32, Int32) |
Construct a LocalNamedCache using the specified
parameters.
|
| InstantiateLocalNamedCache(DefaultConfigurableCacheFactoryCacheInfo, IXmlElement) |
Create a backing cache using the "local-scheme" element.
|
| InstantiateNearCache |
Construct an NearCache using the specified
parameters.
|
| InstantiateSubtype |
Construct an instance of the specified type using the specified
parameters.
|
| LoadDefaultCacheConfig |
Load and return the default XML cache configuration.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReleaseCache(INamedCache) |
Release local resources associated with the specified cache
instance.
|
| ReleaseCache(INamedCache, Boolean) |
Release a cache managed by this factory, optionally destroying it.
|
| ReportConversionError |
Log a failed type conversion.
|
| ResolveScheme(DefaultConfigurableCacheFactoryCacheInfo) |
In the configuration XML find a "scheme" element associated with
a given cache and resolve it (recursively) using the "scheme-ref"
elements.
|
| ResolveScheme(IXmlElement, DefaultConfigurableCacheFactoryCacheInfo, Boolean, Boolean) |
Resolve the specified "XYZ-scheme" by retrieving the base element
refered to by the "scheme-ref" element, resolving it recursively,
and combining it with the specified overrides and cache specific
attributes.
|
| ResolveScheme(IXmlElement, IXmlElement, DefaultConfigurableCacheFactoryCacheInfo, Boolean, Boolean, Boolean) |
Resolve the specified "XYZ-scheme" by retrieving the base element
refered to by the "scheme-ref" element, resolving it recursively,
and combining it with the specified overrides and cache specific
attributes.
|
| ResolveSerializer |
Resolve and inject service serializer elements based on defaults
defined in the cache configuration.
|
| Shutdown |
Release all resources allocated by this cache factory.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TranslateSchemeType |
Translate the scheme name into the scheme type.
|
| ValidateConfig |
Check if configuration is valid:
|
| VerifyCacheListener |
Check whether or not an ICacheListener has to be
instantiated and added to an ICache according to a scheme
definition.
|
Fields| Name | Description | |
|---|---|---|
 | CACHE_NAME |
The name of the replaceable parameter representing the cache
name.
|
 | m_storeCache |
Store that holds cache references by name and optionally,
if configured, IPrincipal.
|
| m_storeService |
Store that holds service references by name and optionally,
if configured, IPrincipal.
|
| SCHEME_REF |
The name of the replaceable parameter representing the scheme
reference.
|
RemarksThis class is designed to be easily extendable with a collection of factory methods allowing subclasses to customize it by overriding any subset of cache instantiation routines or even allowing the addition of custom schemes.
There are various ways of using this factory:
IConfigurableCacheFactory factory =
new DefaultConfigurableCacheFactory(path);
INamedCache cacheOne = factory.EnsureCache("one");
INamedCache cacheTwo = factory.EnsureCache("two");
Using this approach allows an easy customization by extending the DefaultConfigurableCacheFactory and changing the instantiation line:
IConfigurableCacheFactory factory =
new CustomConfigurableCacheFactory();
...
Another option is using the static version of the "EnsureCache" call:
INamedCache cacheOne = CacheFactory.GetCache("one");
INamedCache cacheTwo = CacheFactory.GetCache("two");
which uses an instance of IConfigurableCacheFactory
obtained by the ConfigurableCacheFactory.
See Also