Package com.tangosol.net

Class DefaultConfigurableCacheFactory

  • All Implemented Interfaces:
    ConfigurableCacheFactory
    @Deprecated
public class DefaultConfigurableCacheFactory
extends Base
implements ConfigurableCacheFactory
    Deprecated.
    This class has now been deprecated. It remains part of the distribution of Coherence only for the purpose of providing backwards compatibility for those applications that have extend it or depend on specific implementation semantics.

    Developers are strongly encouraged to refactor the implementations that depend on this class to use the extension mechanisms prescribed by the the ExtensibleConfigurableCacheFactory.

    At some point in the future this class will be removed. No further development or enhancement of this class will occur going forward.

    It is strongly recommended that developers get a ConfigurableCacheFactory instance via CacheFactory.getCacheFactoryBuilder().getConfigurableCacheFactory(), rather than instantiate a DefaultConfigurableCacheFactory instance directly.

    DefaultConfigurableCacheFactory provides a facility to access caches declared in a "coherence-cache-config.xsd" compliant configuration file.

    This 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 addition of custom schemes.

    There are various ways of using this factory: 

       ConfigurableCacheFactory factory =
       new DefaultConfigurableCacheFactory(sPath);
   ...
   ClassLoader loader  = getClass().getClassLoader();
   NamedCache cacheOne = factory.ensureCache("one", loader);
   NamedCache cacheTwo = factory.ensureCache("two", loader);
    Using this approach allows an easy customization by extending the DefaultConfigurableCacheFactory and changing the instantiation line: 
       ConfigurableCacheFactory factory = new CustomConfigurableCacheFactory();
   ...
    Another option is using the static version of the "ensureCache" call: 
       ClassLoader loader  = getClass().getClassLoader();
   NamedCache cacheOne = CacheFactory.getCache("one", loader);
   NamedCache cacheTwo = CacheFactory.getCache("two", loader);
    which uses an instance of ConfigurableCacheFactory obtained by CacheFactory.getConfigurableCacheFactory().

    Since:
    Coherence 2.2
    Author:
    gg 2003.05.26
    See Also:
    CacheFactory.getCache(String, ClassLoader, NamedCache.Option...)

    • Field Detail

      • FILE_CFG_CACHE

        public static final String FILE_CFG_CACHE
        Deprecated.
        The default configuration file name.
        See Also:
        Constant Field Values

      • CACHE_NAME

        public static final String CACHE_NAME
        Deprecated.
        The name of the replaceable parameter representing the cache name.
        See Also:
        Constant Field Values

      • CLASS_LOADER

        public static final String CLASS_LOADER
        Deprecated.
        The name of the replaceable parameter representing the class loader.
        See Also:
        Constant Field Values

      • MGR_CONTEXT

        public static final String MGR_CONTEXT
        Deprecated.
        The name of the replaceable parameter representing the backing map manager context.
        See Also:
        Constant Field Values

      • SCHEME_REF

        public static final String SCHEME_REF
        Deprecated.
        The name of the replaceable parameter representing a scheme reference.
        See Also:
        Constant Field Values

      • CACHE_REF

        public static final String CACHE_REF
        Deprecated.
        The name of the replaceable parameter representing a cache reference.
        See Also:
        Constant Field Values

      • SCHEME_UNKNOWN

        public static final int SCHEME_UNKNOWN
        Deprecated.
        The unknown scheme type.
        See Also:
        Constant Field Values

      • SCHEME_REPLICATED

        public static final int SCHEME_REPLICATED
        Deprecated.
        The replicated cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_OPTIMISTIC

        public static final int SCHEME_OPTIMISTIC
        Deprecated.
        The optimistic cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_DISTRIBUTED

        public static final int SCHEME_DISTRIBUTED
        Deprecated.
        The distributed cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_NEAR

        public static final int SCHEME_NEAR
        Deprecated.
        The near cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_VERSIONED_NEAR

        public static final int SCHEME_VERSIONED_NEAR
        Deprecated.
        The versioned near cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_LOCAL

        public static final int SCHEME_LOCAL
        Deprecated.
        The local cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_OVERFLOW

        public static final int SCHEME_OVERFLOW
        Deprecated.
        The overflow map scheme.
        See Also:
        Constant Field Values

      • SCHEME_EXTERNAL

        public static final int SCHEME_EXTERNAL
        Deprecated.
        The external scheme.
        See Also:
        Constant Field Values

      • SCHEME_EXTERNAL_PAGED

        public static final int SCHEME_EXTERNAL_PAGED
        Deprecated.
        The paged-external scheme.
        See Also:
        Constant Field Values

      • SCHEME_CLASS

        public static final int SCHEME_CLASS
        Deprecated.
        The custom class scheme.
        See Also:
        Constant Field Values

      • SCHEME_READ_WRITE_BACKING

        public static final int SCHEME_READ_WRITE_BACKING
        Deprecated.
        The read write backing map scheme.
        See Also:
        Constant Field Values

      • SCHEME_VERSIONED_BACKING

        public static final int SCHEME_VERSIONED_BACKING
        Deprecated.
        The versioned backing map scheme.
        See Also:
        Constant Field Values

      • SCHEME_INVOCATION

        public static final int SCHEME_INVOCATION
        Deprecated.
        The invocation service scheme.
        See Also:
        Constant Field Values

      • SCHEME_PROXY

        public static final int SCHEME_PROXY
        Deprecated.
        The proxy service scheme.
        See Also:
        Constant Field Values

      • SCHEME_REMOTE_CACHE

        public static final int SCHEME_REMOTE_CACHE
        Deprecated.
        The remote cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_REMOTE_INVOCATION

        public static final int SCHEME_REMOTE_INVOCATION
        Deprecated.
        The remote invocation scheme.
        See Also:
        Constant Field Values

      • SCHEME_TRANSACTIONAL

        public static final int SCHEME_TRANSACTIONAL
        Deprecated.
        The transactional cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_FLASHJOURNAL

        public static final int SCHEME_FLASHJOURNAL
        Deprecated.
        The flash journal cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_RAMJOURNAL

        public static final int SCHEME_RAMJOURNAL
        Deprecated.
        The ram journal cache scheme.
        See Also:
        Constant Field Values

      • SCHEME_PAGED_TOPIC

        public static final int SCHEME_PAGED_TOPIC
        Deprecated.
        The paged topic scheme.
        See Also:
        Constant Field Values

      • m_store

        protected com.tangosol.net.internal.ScopedCacheReferenceStore m_store
        Deprecated.
        Store that holds cache references scoped by class loader and optionally, if configured, Subject.

      • m_setManager

        protected Set m_setManager
        Deprecated.
        A Set of BackingMapManager instances registered by this factory.

        Note: we rely on the BackingMapManager classes *not* to override the hashCode() and equals() methods.

    • Constructor Detail

      • DefaultConfigurableCacheFactory

        public DefaultConfigurableCacheFactory()
        Deprecated.
        Construct a default DefaultConfigurableCacheFactory using the default configuration file name.

      • DefaultConfigurableCacheFactory

        public DefaultConfigurableCacheFactory​(String sPath)
        Deprecated.
        Construct a DefaultConfigurableCacheFactory using the specified path to a "coherence-cache-config.xsd" compliant configuration file or resource.
        Parameters:
        sPath - the configuration resource name or file path

      • DefaultConfigurableCacheFactory

        public DefaultConfigurableCacheFactory​(String sPath,
                                       ClassLoader loader)
        Deprecated.
        Construct a DefaultConfigurableCacheFactory using the specified path to a "coherence-cache-config.xsd" compliant configuration file or resource.
        Parameters:
        sPath - the configuration resource name or file path
        loader - (optional) ClassLoader that should be used to load the configuration resource

      • DefaultConfigurableCacheFactory

        public DefaultConfigurableCacheFactory​(XmlElement xmlConfig)
        Deprecated.
        Construct a DefaultConfigurableCacheFactory using the specified configuration XML.
        Parameters:
        xmlConfig - the configuration XmlElement

      • DefaultConfigurableCacheFactory

        public DefaultConfigurableCacheFactory​(XmlElement xmlConfig,
                                       ClassLoader loader)
        Deprecated.
        Construct a DefaultConfigurableCacheFactory using the specified configuration XML.
        Parameters:
        xmlConfig - the configuration XmlElement
        loader - (optional) ClassLoader that should be used to load the configuration resource

    • Method Detail

      • getConfig

        public XmlElement getConfig()
        Deprecated.
        Obtain the factory configuration XML.
        Returns:
        the configuration XML

      • getConfigUnsafe

        protected XmlElement getConfigUnsafe()
        Deprecated.
        Obtain a mutable reference to the factory configuration XML.

        Note: The caller may not modify the resulting XmlElement's in any way.

        Returns:
        the configuration XML

      • setConfig

        public void setConfig​(XmlElement xmlConfig)
        Deprecated.
        Specify the factory configuration XML.
        Parameters:
        xmlConfig - the configuration XML

      • releaseCache

        public void releaseCache​(NamedCache cache)
        Deprecated.
        Release a cache and its associated resources.

        Releasing a cache makes it no longer usable, but does not affect the cache itself. In other words, all other references to the cache will still be valid, and the cache data is not affected by releasing the reference. Any attempt to use the released cache reference afterword will result in an exception.

        Specified by:
        releaseCache in interface ConfigurableCacheFactory
        Parameters:
        cache - the cache to release

      • destroyCache

        public void destroyCache​(NamedCache cache)
        Deprecated.
        Release and destroy this instance of NamedCache.

        Warning: This method is used to completely destroy the specified cache across the cluster. All references in the entire cluster to this cache will be invalidated, the cached data will be cleared, and all internal and associated resources will be released.

        Specified by:
        destroyCache in interface ConfigurableCacheFactory
        Parameters:
        cache - the cache to release

      • ensureService

        public Service ensureService​(String sServiceName)
        Deprecated.
        Ensure a service for the given name.
        Specified by:
        ensureService in interface ConfigurableCacheFactory
        Parameters:
        sServiceName - the service name
        Returns:
        a Service created

      • activate

        public void activate()
        Deprecated.
        Activate prepares the factory to be used within a container and should be called before any other factory method.
        Specified by:
        activate in interface ConfigurableCacheFactory

      • getScopeName

        public String getScopeName()
        Deprecated.
        Return the scope name for this ConfigurableCacheFactory. If specified, this name will be used as a prefix for the name of all services created by this factory.
        Specified by:
        getScopeName in interface ConfigurableCacheFactory
        Returns:
        the scope name for this ConfigurableCacheFactory; may be null

      • setScopeName

        public void setScopeName​(String sScopeName)
        Deprecated.
        Set the scope name for this ConfigurableCacheFactory. Note that this method should only be invoked by a CacheFactoryBuilder when initializing this ConfigurableCacheFactory instance.

        This method will be removed in a future release.

        Parameters:
        sScopeName - the scope name for this ConfigurableCacheFactory
        Throws:
        IllegalStateException - if this setter is invoked after a service start

      • getConfigClassLoader

        protected ClassLoader getConfigClassLoader()
        Deprecated.
        Return the class loader used to load the configuration for this factory.
        Returns:
        the class loader to use for loading the config

      • checkPermission

        protected static void checkPermission​(NamedCache cache)
        Deprecated.
        Check if the current user is allowed to "join" the cache.
        Parameters:
        cache - the cache
        Throws:
        SecurityException - if permission is denied

      • setConfigClassLoader

        public void setConfigClassLoader​(ClassLoader loader)
        Deprecated.
        Set the class loader used to load the configuration for this factory.
        Parameters:
        loader - the class loader to use for loading the config

      • loadConfig

        public static XmlDocument loadConfig​(String sName)
        Deprecated.
        Load the configuration from a file or resource.
        Parameters:
        sName - the name of file or resource.
        Returns:
        the configuration XML

      • loadConfig

        public static XmlDocument loadConfig​(String sName,
                                     ClassLoader loader)
        Deprecated.
        Load the configuration from a file or resource.
        Parameters:
        sName - the name of file or resource.
        loader - (optional) ClassLoader that should be used to load the configuration resource
        Returns:
        the configuration XML

      • loadConfigAsResource

        public static XmlDocument loadConfigAsResource​(String sResource,
                                               ClassLoader loader)
        Deprecated.
        Load the configuration as a resource.
        Parameters:
        sResource - the resource name
        loader - (optional) ClassLoader that should be used to load the configuration resource
        Returns:
        the configuration XML

      • loadConfigFromFile

        public static XmlDocument loadConfigFromFile​(File file)
        Deprecated.
        Load the configuration from a file or directory.
        Parameters:
        file - file or directory to load the configuration from
        Returns:
        the configuration XML

      • findSchemeMapping

        public DefaultConfigurableCacheFactory.CacheInfo findSchemeMapping​(String sCacheName)
        Deprecated.
        In the configuration XML find a "cache-mapping" element associated with a given cache name.
        Parameters:
        sCacheName - the value of the "cache-name" element to look for
        Returns:
        a CacheInfo object associated with a given cache name

      • resolveScheme

        public XmlElement resolveScheme​(DefaultConfigurableCacheFactory.CacheInfo info)
        Deprecated.
        In the configuration XML find a "scheme" element associated with a given cache and resolve it (recursively) using the "scheme-ref" elements. The returned XML is always a clone of the actual configuration and could be safely modified.
        Parameters:
        info - the cache info
        Returns:
        a resolved "scheme" element associated with a given cache

      • findScheme

        protected XmlElement findScheme​(String sSchemeName)
        Deprecated.
        In the configuration XML find a "scheme" element associated with a given scheme name.
        Parameters:
        sSchemeName - the value of the "scheme-name" element to look for
        Returns:
        a "scheme" element associated with a given scheme name

      • findScheme

        protected static XmlElement findScheme​(XmlElement xmlConfig,
                                       String sSchemeName)
        Deprecated.
        In the specified configuration XML, find a "scheme" element associated with the specified scheme name.
        Parameters:
        xmlConfig - the xml configuration
        sSchemeName - the value of the "scheme-name" element to look for
        Returns:
        a "scheme" element associated with a given scheme name, or null if none is found

      • collectServiceSchemes

        public static Map collectServiceSchemes​(XmlElement xmlConfig)
        Deprecated.
        Collect a map keyed by service names with values of corresponding service schemes in the specified cache configuration.
        Parameters:
        xmlConfig - the cache configuration
        Returns:
        a map keyed by service names with values of service schemes

      • collectServiceSchemes

        protected static void collectServiceSchemes​(XmlElement xmlScheme,
                                            XmlElement xmlConfig,
                                            HashMap mapService)
        Deprecated.
        Collect the service-schemes referenced by the specified scheme element in the cache configuration and update the specified mapping of service names to the associated service schemes.
        Parameters:
        xmlScheme - a scheme element
        xmlConfig - the cache configuration
        mapService - a map of service name to service scheme

      • findServiceScheme

        protected XmlElement findServiceScheme​(String sServiceName)
        Deprecated.
        In the configuration XML find a "scheme" element associated with a given service name.
        Parameters:
        sServiceName - the value of the "service-name" element to look for
        Returns:
        a "scheme" element associated with a given service name

      • resolveScheme

        protected static XmlElement resolveScheme​(XmlElement xmlConfig,
                                          XmlElement xmlScheme,
                                          DefaultConfigurableCacheFactory.CacheInfo info,
                                          boolean fChild,
                                          boolean fRequired,
                                          boolean fApply)
        Deprecated.
        Resolve the specified "XYZ-scheme" by retrieving the base element referred to by the "scheme-ref" element, resolving it recursively, and combining it with the specified overrides and cache specific attributes.
        Parameters:
        xmlConfig - the cache configuration xml
        xmlScheme - a scheme element to resolve
        info - the cache info (optional)
        fChild - if true, the actual cache scheme is the only "xyz-scheme" child of the specified xmlScheme element; otherwise it's the xmlScheme element itself
        fRequired - if true, the child scheme must be present; false otherwise
        fApply - if true, apply the specified overrides and cache-specific attributes to the base scheme element; otherwise return a reference to the base scheme element
        Returns:
        a "scheme" element referred to by the "scheme-ref" value; null if the child is missing and is not required

      • resolveScheme

        protected XmlElement resolveScheme​(XmlElement xmlScheme,
                                   DefaultConfigurableCacheFactory.CacheInfo info,
                                   boolean fChild,
                                   boolean fRequired)
        Deprecated.
        Resolve the specified "XYZ-scheme" by retrieving the base element referred to by the "scheme-ref" element, resolving it recursively, and combining it with the specified overrides and cache specific attributes.
        Parameters:
        xmlScheme - a scheme element to resolve
        info - the cache info (optional)
        fChild - if true, the actual cache scheme is the only "xyz-scheme" child of the specified xmlScheme element; otherwise it's the xmlScheme element itself
        fRequired - if true, the child scheme must be present; false otherwise
        Returns:
        a "scheme" element associated with a given cache name; null if the child is missing and is not required

      • ensureCache

        protected NamedCache ensureCache​(DefaultConfigurableCacheFactory.CacheInfo info,
                                 XmlElement xmlScheme,
                                 ClassLoader loader)
        Deprecated.
        Obtain the NamedCache reference for the cache service defined by the specified scheme.
        Parameters:
        info - the cache info
        xmlScheme - the scheme element for the cache
        loader - (optional) ClassLoader that should be used to deserialize objects in the cache
        Returns:
        NamedCache instance

      • ensureService

        public Service ensureService​(XmlElement xmlScheme)
        Deprecated.
        Ensure the service for the specified scheme.
        Parameters:
        xmlScheme - the scheme
        Returns:
        running Service corresponding to the scheme

      • ensureServiceInternal

        protected Service ensureServiceInternal​(XmlElement xmlScheme)
        Deprecated.
        Ensure the service for the specified scheme.
        Parameters:
        xmlScheme - the scheme
        Returns:
        running Service corresponding to the scheme

      • startService

        protected void startService​(Service service)
        Deprecated.
        Start the given Service. Extensions of this class can override this method to provide pre/post start functionality.
        Parameters:
        service - the Service to start

      • getScopedServiceName

        public String getScopedServiceName​(String sServiceName)
        Deprecated.
        Apply the scope name prefix to the given service name. The name will be formatted as such: [scope name]:[service name]
        Parameters:
        sServiceName - the service name
        Returns:
        the service name with scope prefix, if there is a scope name configured

      • resolveSerializer

        protected void resolveSerializer​(XmlElement xmlConfig)
        Deprecated.
        Resolve and inject service serializer elements based on defaults defined in the cache configuration.
        Parameters:
        xmlConfig - the configuration element to examine and modify

      • resolveSocketProvider

        protected void resolveSocketProvider​(XmlElement xmlConfig)
        Deprecated.
        Resolve and inject service socket-provider elements based on defaults defined in the cache configuration.
        Parameters:
        xmlConfig - the configuration element to examine and modify

      • instantiateBackingMapManager

        protected BackingMapManager instantiateBackingMapManager​(int nSchemeType,
                                                         XmlElement xmlScheme)
        Deprecated.
        Instantiate a BackingMapManager for a given scheme type.

        Note: we rely on the BackingMapManager implementations to have their equals() method test for object identity using the "==" operator (in other words not to override the hashCode() and equals() methods).

        Parameters:
        nSchemeType - the scheme type (one of the SCHEME-* constants)
        xmlScheme - the scheme used to configure the corresponding service
        Returns:
        a new BackingMapManager instance

      • registerBackingMapManager

        protected void registerBackingMapManager​(BackingMapManager mgr)
        Deprecated.
        Register the specified BackingMapManager as a "valid" one. That registry is used to identify services configured and started by this factory and prevent accidental usage of (potentially incompatible) cache services with the same name created by other factories.
        Parameters:
        mgr - a BackingMapManager instance instantiated by this factory

      • validateBackingMapManager

        protected void validateBackingMapManager​(CacheService service)
        Deprecated.
        Ensures that the backing map manager of the specified service was configured by this (or equivalent) factory. This validation is performed to prevent accidental usage of (potentially incompatible) cache services with the same name created by other factories.
        Parameters:
        service - the CacheService to validate

      • configureCache

        public NamedCache configureCache​(DefaultConfigurableCacheFactory.CacheInfo info,
                                 XmlElement xmlScheme,
                                 ClassLoader loader)
        Deprecated.
        Ensures a cache for given scheme.
        Parameters:
        info - the cache info
        xmlScheme - the corresponding scheme
        loader - ClassLoader that should be used to deserialize objects in the cache
        Returns:
        a named cache created according to the description in the configuration

      • instantiateNearCache

        protected NearCache instantiateNearCache​(Map mapFront,
                                         NamedCache mapBack,
                                         int nStrategy)
        Deprecated.
        Construct an NearCache using the specified parameters.

        This method exposes a corresponding NearCache constructor and is provided for the express purpose of allowing its override.

      • instantiateVersionedNearCache

        protected VersionedNearCache instantiateVersionedNearCache​(Map mapLocal,
                                                           NamedCache mapDist,
                                                           NamedCache mapVersion)
        Deprecated.
        Construct an VersionedNearCache using the specified parameters.

        This method exposes a corresponding VersionedNearCache constructor and is provided for the express purpose of allowing its override.

      • configureBackingMap

        public Map configureBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                               XmlElement xmlScheme,
                               BackingMapManagerContext context,
                               ClassLoader loader,
                               Map mapListeners)
        Deprecated.
        Configures a backing map according to the scheme.
        Parameters:
        info - the cache info
        xmlScheme - the scheme element for cache configuration
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        mapListeners - map of registered map listeners keyed by the corresponding map references
        Returns:
        a backing map configured according to the scheme

      • resolveBackingMapScheme

        public XmlElement resolveBackingMapScheme​(DefaultConfigurableCacheFactory.CacheInfo info,
                                          XmlElement xmlScheme)
        Deprecated.
        Traverse the specified scheme to find an enclosed "backing-map-scheme" or a scheme that could serve as such.
        Parameters:
        info - the cache info
        xmlScheme - the scheme element for cache configuration
        Returns:
        the resolved backing map scheme

      • verifyMapListener

        protected void verifyMapListener​(DefaultConfigurableCacheFactory.CacheInfo info,
                                 Map map,
                                 XmlElement xmlScheme,
                                 BackingMapManagerContext context,
                                 ClassLoader loader,
                                 Map mapListeners)
        Deprecated.
        Check whether or not a MapListener has to be instantiated and added to a Map according to a scheme definition.
        Parameters:
        info - the cache info
        map - an ObservableMap to add a listener to
        xmlScheme - the corresponding scheme
        context - BackingMapManagerContext to be used
        loader - ClassLoader that should be used to instantiate a MapListener object
        mapListeners - map of registered map listeners keyed by the corresponding map references
        Throws:
        IllegalArgumentException - if the listener is required, but the map does not implement ObservableMap interface or if the listener cannot be instantiated

      • instantiateReadWriteBackingMap

        protected Map instantiateReadWriteBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                                             XmlElement xmlRWBM,
                                             BackingMapManagerContext context,
                                             Map mapListeners)
        Deprecated.
        Create a ReadWriteBackingMap using the "read-write-backing-map-scheme" element.
        Parameters:
        info - the cache info
        xmlRWBM - "read-write-backing-map-scheme" element
        context - BackingMapManagerContext to be used
        mapListeners - map of registered map listeners keyed by the corresponding map references
        Returns:
        a newly instantiated Map

      • instantiateReadWriteBackingMap

        protected ReadWriteBackingMap instantiateReadWriteBackingMap​(BackingMapManagerContext context,
                                                             ObservableMap mapInternal,
                                                             Map mapMisses,
                                                             CacheLoader store,
                                                             boolean fReadOnly,
                                                             int cWriteBehindSeconds,
                                                             double dflRefreshAheadFactor)
        Deprecated.
        Construct a ReadWriteBackingMap using the specified parameters.

        This method exposes a corresponding ReadWriteBackingMap constructor and is provided for the express purpose of allowing its override.

      • instantiateReadWriteBackingMap

        protected ReadWriteBackingMap instantiateReadWriteBackingMap​(BackingMapManagerContext context,
                                                             ObservableMap mapInternal,
                                                             Map mapMisses,
                                                             BinaryEntryStore storeBinary,
                                                             boolean fReadOnly,
                                                             int cWriteBehindSeconds,
                                                             double dflRefreshAheadFactor)
        Deprecated.
        Construct a ReadWriteBackingMap using the specified parameters.

        This method exposes a corresponding ReadWriteBackingMap constructor and is provided for the express purpose of allowing its override.

      • instantiateReadWriteSplittingBackingMap

        protected ReadWriteSplittingBackingMap instantiateReadWriteSplittingBackingMap​(BackingMapManagerContext context,
                                                                               PartitionAwareBackingMap mapInternal,
                                                                               Map mapMisses,
                                                                               CacheLoader store,
                                                                               boolean fReadOnly,
                                                                               int cWriteBehindSeconds,
                                                                               double dflRefreshAheadFactor)
        Deprecated.
        Construct a ReadWriteSplittingBackingMap using the specified parameters.

        This method exposes a corresponding ReadWriteSplittingBackingMap constructor and is provided for the express purpose of allowing its override.

      • instantiateReadWriteSplittingBackingMap

        protected ReadWriteSplittingBackingMap instantiateReadWriteSplittingBackingMap​(BackingMapManagerContext context,
                                                                               PartitionAwareBackingMap mapInternal,
                                                                               Map mapMisses,
                                                                               BinaryEntryStore storeBinary,
                                                                               boolean fReadOnly,
                                                                               int cWriteBehindSeconds,
                                                                               double dflRefreshAheadFactor)
        Deprecated.
        Construct a ReadWriteSplittingBackingMap using the specified parameters.

        This method exposes a corresponding ReadWriteSplittingBackingMap constructor and is provided for the express purpose of allowing its override.

      • instantiateVersionedBackingMap

        protected Map instantiateVersionedBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                                             XmlElement xmlVBM,
                                             BackingMapManagerContext context,
                                             Map mapListeners)
        Deprecated.
        Create a VersionedBackingMap using the "versioned-backing-map-scheme" element.
        Parameters:
        info - the cache info
        xmlVBM - "versioned-backing-map-scheme" element
        context - BackingMapManagerContext to be used
        mapListeners - map of registered map listeners keyed by the corresponding map references
        Returns:
        a newly instantiated Map

      • instantiateVersionedBackingMap

        protected VersionedBackingMap instantiateVersionedBackingMap​(BackingMapManagerContext context,
                                                             ObservableMap mapInternal,
                                                             Map mapMisses,
                                                             CacheStore store,
                                                             boolean fReadOnly,
                                                             int cWriteBehindSeconds,
                                                             double dflRefreshAheadFactor,
                                                             NamedCache mapVersionTransient,
                                                             NamedCache mapVersionPersist,
                                                             boolean fManageTransient)
        Deprecated.
        Construct a VersionedBackingMap using the specified parameters.

        This method exposes a corresponding VersionedBackingMap constructor and is provided for the express purpose of allowing its override.

      • instantiateLocalCache

        protected Map instantiateLocalCache​(DefaultConfigurableCacheFactory.CacheInfo info,
                                    XmlElement xmlLocal,
                                    BackingMapManagerContext context,
                                    ClassLoader loader)
        Deprecated.
        Create a backing Map using the "local-scheme" element.
        Parameters:
        info - the cache info
        xmlLocal - "local-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated Map

      • configureUnitCalculator

        protected void configureUnitCalculator​(XmlElement xmlCache,
                                       ConfigurableCacheMap cache,
                                       DefaultConfigurableCacheFactory.CacheInfo info,
                                       BackingMapManagerContext context,
                                       ClassLoader loader)
        Deprecated.
        Configure a UnitCalculator for the specified ConfigurableCacheMap.
        Parameters:
        xmlCache - cache scheme that may contain a "unit-calculator" element
        cache - the corresponding ConfigurableCacheMap
        info - the cache info
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes

      • instantiateLocalCache

        protected LocalCache instantiateLocalCache​(int cUnits,
                                           int cExpiryMillis)
        Deprecated.
        Construct a LocalCache using the specified parameters.

        This method exposes a corresponding LocalCache constructor and is provided for the express purpose of allowing its override.

        Parameters:
        cUnits - high watermark
        cExpiryMillis - the expiry value
        Returns:
        a newly instantiated LocalCache

      • instantiateOverflowBackingMap

        protected Map instantiateOverflowBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                                            XmlElement xmlOverflow,
                                            BackingMapManagerContext context,
                                            ClassLoader loader,
                                            Map mapListeners)
        Deprecated.
        Create a backing Map using the "overflow-scheme" element.
        Parameters:
        info - the cache info
        xmlOverflow - "overflow-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        mapListeners - map of registered map listeners keyed by the corresponding map references
        Returns:
        a newly instantiated Map

      • instantiateOverflowMap

        protected OverflowMap instantiateOverflowMap​(ObservableMap mapFront,
                                             Map mapBack,
                                             boolean fExpiry)
        Deprecated.
        Construct an OverflowMap using the specified parameters.

        This method exposes a corresponding OverflowMap constructor and is provided for the express purpose of allowing its override.

      • instantiateSimpleOverflowMap

        protected SimpleOverflowMap instantiateSimpleOverflowMap​(ObservableMap mapFront,
                                                         Map mapBack,
                                                         Map mapMisses)
        Deprecated.
        Construct a SimpleOverflowMap using the specified parameters.

        This method exposes a corresponding SimpleOverflowMap constructor and is provided for the express purpose of allowing its override.

      • instantiateSerializationMap

        protected Map instantiateSerializationMap​(BinaryStore store,
                                          boolean fBinaryMap,
                                          ClassLoader loader,
                                          int cHighUnits,
                                          int cExpiryMillis,
                                          String sSubclass,
                                          XmlElement xmlInitParams)
        Deprecated.
        Instantiate a SerializationMap, SerializationCache, SimpleSerializationMap, or any sub-class thereof.
        Parameters:
        store - a BinaryStore to use to write serialized data to
        fBinaryMap - true if the only data written to the Map will already be in Binary form
        loader - the ClassLoader to use (if not a Binary map)
        cHighUnits - the max size in units for the serialization cache
        cExpiryMillis - the expiry time in milliseconds for the cache
        sSubclass - the sub-class name (or "")
        xmlInitParams - the init params for the sub-class
        Returns:
        a BinaryMap, SerializationMap, SerializationCache, SimpleSerializationMap, or a subclass thereof

      • instantiateExternalBackingMap

        protected Map instantiateExternalBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                                            XmlElement xmlExternal,
                                            BackingMapManagerContext context,
                                            ClassLoader loader)
        Deprecated.
        Create a backing Map using the "external-scheme" element.
        Parameters:
        info - the cache info
        xmlExternal - "external-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated Map

      • instantiatePagedExternalBackingMap

        protected Map instantiatePagedExternalBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                                                 XmlElement xmlPaged,
                                                 BackingMapManagerContext context,
                                                 ClassLoader loader)
        Deprecated.
        Create a backing Map using the "paged-external-scheme" element.
        Parameters:
        info - the cache info
        xmlPaged - "paged-external-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated Map

      • instantiateFlashJournalBackingMap

        protected Map instantiateFlashJournalBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                                                XmlElement xmlJournal,
                                                BackingMapManagerContext context,
                                                ClassLoader loader)
        Deprecated.
        Create a backing Map using the "flashjournal-scheme" element.
        Parameters:
        info - the cache info
        xmlJournal - "flashjournal-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated Map

      • instantiateRamJournalBackingMap

        protected Map instantiateRamJournalBackingMap​(DefaultConfigurableCacheFactory.CacheInfo info,
                                              XmlElement xmlJournal,
                                              BackingMapManagerContext context,
                                              ClassLoader loader)
        Deprecated.
        Create a backing Map using the "ramjournal-scheme" element.
        Parameters:
        info - the cache info
        xmlJournal - "ramjournal-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated Map

      • instantiateBinaryStoreManager

        protected BinaryStoreManager instantiateBinaryStoreManager​(XmlElement xmlConfig,
                                                           ClassLoader loader,
                                                           boolean fPaged)
        Deprecated.
        Create a BinaryStoreManager using the specified XML configuration. The given XML configuration must contain a valid child BinaryStoreManager element:
        • async-store-manager
        • custom-store-manager
        • bdb-store-manager
        • nio-file-manager
        Parameters:
        xmlConfig - the XmlElement that contains the configuration info for the BinaryStoreManager that will be instantiated
        loader - the ClassLoader to instantiate necessary classes
        fPaged - flag indicating whether or not the returned BinaryStoreManager will be used by a SerializationPagedCache
        Returns:
        a newly instantiated BinaryStoreManager created using the given XML configuration

      • instantiateAsyncBinaryStore

        protected AsyncBinaryStore instantiateAsyncBinaryStore​(BinaryStore store,
                                                       int cbMaxAsync)
        Deprecated.
        Construct an AsyncBinaryStore using the specified parameters.
        Parameters:
        store - the BinaryStore to make asynchronous
        cbMaxAsync - the maximum amount of "async writes" data that will be queued
        Returns:
        a new AsyncBinaryStore wrapping the passed BinaryStore

      • instantiateAsyncBinaryStoreManager

        protected AsyncBinaryStoreManager instantiateAsyncBinaryStoreManager​(BinaryStoreManager storeMgr,
                                                                     int cbMaxAsync)
        Deprecated.
        Construct an AsyncBinaryStoreManager using the specified parameters.
        Parameters:
        storeMgr - the BinaryStoreManager to make asynchronous
        cbMaxAsync - the maximum amount of "async writes" data that will be queued
        Returns:
        a new AsyncBinaryStoreManager wrapping the passed BinaryStoreManager

      • instantiateSerializationPagedCache

        protected SerializationPagedCache instantiateSerializationPagedCache​(BinaryStoreManager storeMgr,
                                                                     int cPages,
                                                                     int cPageSecs,
                                                                     ClassLoader loader)
        Deprecated.
        Construct an SerializationPagedCache using the specified parameters.

        This method exposes a corresponding SerializationPagedCache constructor and is provided for the express purpose of allowing its override.

      • instantiateSerializationPagedCache

        protected SerializationPagedCache instantiateSerializationPagedCache​(BinaryStoreManager storeMgr,
                                                                     int cPages,
                                                                     int cPageSecs,
                                                                     boolean fBinaryMap,
                                                                     boolean fPassive)
        Deprecated.
        Construct an SerializationPagedCache using the specified parameters.

        This method exposes a corresponding SerializationPagedCache constructor and is provided for the express purpose of allowing its override.

      • instantiateSerializationCache

        protected SerializationCache instantiateSerializationCache​(BinaryStore store,
                                                           int cMax,
                                                           ClassLoader loader)
        Deprecated.
        Construct an SerializationCache using the specified parameters.

        This method exposes a corresponding SerializationCache constructor and is provided for the express purpose of allowing its override.

      • instantiateSerializationCache

        protected SerializationCache instantiateSerializationCache​(BinaryStore store,
                                                           int cMax,
                                                           boolean fBinaryMap)
        Deprecated.
        Construct an SerializationCache using the specified parameters.

        This method exposes a corresponding SerializationCache constructor and is provided for the express purpose of allowing its override.

      • instantiateSerializationMap

        protected SerializationMap instantiateSerializationMap​(BinaryStore store,
                                                       ClassLoader loader)
        Deprecated.
        Construct an SerializationMap using the specified parameters.

        This method exposes a corresponding SerializationMap constructor and is provided for the express purpose of allowing its override.

      • instantiateSerializationMap

        protected SerializationMap instantiateSerializationMap​(BinaryStore store,
                                                       boolean fBinaryMap)
        Deprecated.
        Construct an SerializationMap using the specified parameters.

        This method exposes a corresponding SerializationMap constructor and is provided for the express purpose of allowing its override.

      • instantiateSimpleSerializationMap

        protected SimpleSerializationMap instantiateSimpleSerializationMap​(BinaryStore store,
                                                                   ClassLoader loader)
        Deprecated.
        Construct a SimpleSerializationMap using the specified parameters.

        This method exposes a corresponding SerializationMap constructor and is provided for the express purpose of allowing its override.

        Since:
        Coherence 3.7

      • instantiateSimpleSerializationMap

        protected SimpleSerializationMap instantiateSimpleSerializationMap​(BinaryStore store,
                                                                   boolean fBinaryMap)
        Deprecated.
        Construct a SimpleSerializationMap using the specified parameters.

        This method exposes a corresponding SerializationMap constructor and is provided for the express purpose of allowing its override.

        Since:
        Coherence 3.7

      • instantiateBundlingNamedCache

        protected BundlingNamedCache instantiateBundlingNamedCache​(NamedCache cache,
                                                           XmlElement xmlBundling)
        Deprecated.
        Create a BundlingNamedCache using the "operation-bundling" element.
        Parameters:
        cache - the wrapped cache
        xmlBundling - the "operation-bundling" element
        Returns:
        a newly instantiated BundlingNamedCache

      • initializeBundler

        protected void initializeBundler​(AbstractBundler bundler,
                                 XmlElement xmlBundle)
        Deprecated.
        Initialize the specified bundler using the "bundle-config" element.
        Parameters:
        bundler - the bundler
        xmlBundle - a "bundle-config" element

      • instantiateCacheStore

        protected Object instantiateCacheStore​(DefaultConfigurableCacheFactory.CacheInfo info,
                                       XmlElement xmlStore,
                                       BackingMapManagerContext context,
                                       ClassLoader loader)
        Deprecated.
        Create a CacheLoader, CacheStore or BinaryEntryStore using the "cachestore-scheme" element.
        Parameters:
        info - the cache info
        xmlStore - "cachestore-scheme" element for the store or loader
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated CacheLoader, CacheStore or BinaryEntryStore

      • instantiateMapListener

        protected MapListener instantiateMapListener​(DefaultConfigurableCacheFactory.CacheInfo info,
                                             XmlElement xmlClass,
                                             BackingMapManagerContext context,
                                             ClassLoader loader)
        Deprecated.
        Create a MapListener using the using the "class-scheme" element. If the value of any "param-value" element contains the literal "{cache-name}", replace it with the actual cache name.
        Parameters:
        info - the cache info
        xmlClass - "class-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated MapListener

      • instantiateAny

        public Object instantiateAny​(DefaultConfigurableCacheFactory.CacheInfo info,
                             XmlElement xmlClass,
                             BackingMapManagerContext context,
                             ClassLoader loader)
        Deprecated.
        Create an Object using "class-scheme" element.

        If the value of any "param-value" element contains the literal "{cache-name}", replace it with the actual cache name.
        If the value of "param-value" element is "{class-loader}" and "param-type" element is "java.lang.ClassLoader" replace it with the current ClassLoader object.
        If the value of "param-value" element is "{manager-context}" and "param-type" element is "com.tangosol.net.BackingMapManagerContext" replace it with the current BackingMapManagerContext object.
        Finally, if the value of "param-type" is "{scheme-ref}" then the "param-value" should be a name of the scheme that will be used in place of the value.

        Parameters:
        info - the cache info
        xmlClass - "class-scheme" element
        context - BackingMapManagerContext to be used
        loader - the ClassLoader to instantiate necessary classes
        Returns:
        a newly instantiated Object

      • instantiateSubclass

        public Object instantiateSubclass​(String sClass,
                                  Class clzSuper,
                                  ClassLoader loader,
                                  Object[] aoParam,
                                  XmlElement xmlParams)
        Deprecated.
        Construct an instance of the specified class using the specified parameters.
        Parameters:
        sClass - the class name
        clzSuper - the super class of the newly instantiated class
        loader - the ClassLoader to instantiate necessary classes
        aoParam - the constructor parameters
        xmlParams - the "init-params" XmlElement (optional)
        Returns:
        a newly instantiated Object

      • release

        public void release​(Map map,
                    Map mapListeners)
        Deprecated.
        Release all resources associated with the specified backing map.
        Parameters:
        map - the map being released
        mapListeners - map of registered map listeners keyed by the corresponding map references

      • release

        protected void release​(CacheLoader loader)
        Deprecated.
        Release all resources associated with the specified loader.
        Parameters:
        loader - the cache loader being released

      • release

        protected void release​(BinaryStore store)
        Deprecated.
        Release all resources associated with the specified binary store.
        Parameters:
        store - the binary store being released

      • releaseCache

        protected void releaseCache​(NamedCache cache,
                            boolean fDestroy)
        Deprecated.
        Release a cache managed by this factory, optionally destroying it.
        Parameters:
        cache - the cache to release
        fDestroy - true to destroy the cache as well

      • translateSchemeType

        public int translateSchemeType​(String sScheme)
        Deprecated.
        Translate the scheme name into the scheme type. Valid scheme types are any of the SCHEME_* constants.
        Parameters:
        sScheme - the scheme name
        Returns:
        the scheme type

      • translateStandardSchemeType

        public static int translateStandardSchemeType​(String sScheme)
        Deprecated.
        Translate the scheme name into the scheme type. Valid scheme types are any of the SCHEME_* constants.
        Parameters:
        sScheme - the scheme name
        Returns:
        the scheme type

      • isPutAllOptimized

        public static boolean isPutAllOptimized​(Map map)
        Deprecated.
        Determines whether or not the specified Map is optimized for a putAll() operation versus a regular put() operation.
        Parameters:
        map - a Map instance to check
        Returns:
        true if putAll should be preferred over put if the return value is not needed; false otherwise

      • isCanonicalKeySupported

        public static boolean isCanonicalKeySupported​(Map map)
        Deprecated.
        Determine whether the provided map allows reference access to the keys it holds.
        Parameters:
        map - a Map instance to check
        Returns:
        true iff the Map's keys can be canonicalized

      • getRequestTimeout

        protected static long getRequestTimeout​(XmlElement xmlScheme)
        Deprecated.
        Return the request timeout based on the XmlElement.
        Parameters:
        xmlScheme - the xml scheme that stores the request timeout
        Returns:
        the request timeout

      • isSerializerCompatible

        protected boolean isSerializerCompatible​(Service serviceThis,
                                         Service serviceThat)
        Deprecated.
        Determines whether or not the serializers for the specified services are compatible. In other words, this method returns true iff object serialized with the first Serializer can be deserialized by the second and visa versa.
        Parameters:
        serviceThis - the first Service
        serviceThat - the second Service
        Returns:
        true iff the two Serializers are stream compatible

      • configureInterceptors

        protected void configureInterceptors​(XmlElement xmlConfig)
        Deprecated.
        Using the provided base XML find all interceptors instantiating as appropriate and registering with the Events Registry.

        Interceptors may exist in either the caching-scheme-mapping or within a distributed-scheme. The former allows restricting events based on cache named whilst the latter can be bound at service level.

        Parameters:
        xmlConfig - the base cache configuration xml
        Since:
        12.1.2

      • registerInterceptor

        protected void registerInterceptor​(XmlElement xmlInterceptor,
                                   String sCacheName,
                                   String sServiceName)
        Deprecated.
        This method will instantiate an EventInterceptor based on the XML provided. Additionally the service and cache names will be passed to the interceptor if possible. These values should be empty strings if they are to be ignored.

        This method will register the EventInterceptor instantiated with the events registry; Registry.

        Parameters:
        xmlInterceptor - the xml containing the definition of the interceptor
        sCacheName - the cache name or an empty string
        sServiceName - the service name or an empty string
        Throws:
        IllegalArgumentException - if a nested instance or class-scheme is absent, an interceptor identifier is missing or the EventInterceptor implementation can not be resolved
        Since:
        Coherence 12.1.2

      • unregister

        protected void unregister​(String sCacheName,
                          String sContext)
        Deprecated.
        as of Coherence 3.7.1; use MBeanHelper.unregisterCacheMBean(String, String) instead
        Unregister the caches for a given cache name and context from the cluster registry.
        Parameters:
        sCacheName - the cache name
        sContext - the cache context (tier)

      • pushCacheContext

        protected void pushCacheContext​(String sContext)
        Deprecated.
        Push cache context into a thread-local storage.
        Parameters:
        sContext - cache context (tag)

      • popCacheContext

        protected String popCacheContext()
        Deprecated.
        Pop cache context from a thread-local storage.
        Returns:
        the popped cache context

      • convertInt

        protected int convertInt​(XmlValue xmlValue)
        Deprecated.
        Convert the value in the specified XmlValue to an int. If the conversion fails, a warning will be logged.
        Parameters:
        xmlValue - the element expected to contain an int value
        Returns:
        the int value in the provided element, or 0 upon a conversion failure

      • convertInt

        protected int convertInt​(XmlValue xmlValue,
                         int nDefault)
        Deprecated.
        Convert the value in the specified XmlValue to an int. If the conversion fails, a warning will be logged.
        Parameters:
        xmlValue - the element expected to contain an int value
        nDefault - the value that will be returned if the element does not contain a value that can be converted to int
        Returns:
        the int value in the provided element, or nDefault upon a conversion failure

      • convertLong

        protected long convertLong​(XmlValue xmlValue)
        Deprecated.
        Convert the value in the specified XmlValue to a long. If the conversion fails, a warning will be logged.
        Parameters:
        xmlValue - the element expected to contain a long value
        Returns:
        the long value in the provided element, or 0 upon a conversion failure

      • convertDouble

        protected double convertDouble​(XmlValue xmlValue)
        Deprecated.
        Convert the value in the specified XmlValue to a double. If the conversion fails, a warning will be logged.
        Parameters:
        xmlValue - the element expected to contain a double value
        Returns:
        the double value in the provided element, or 0.0 upon a conversion failure

      • reportConversionError

        protected void reportConversionError​(XmlValue xmlValue,
                                     String sType,
                                     String sDefault,
                                     RuntimeException e)
        Deprecated.
        Log a failed type conversion.
        Parameters:
        xmlValue - element that contains the value that failed conversion
        sType - type that conversion was attempted to
        sDefault - default value that will be substituted
        e - root cause of failed type conversion