Package com.tangosol.net

Class CacheFactory

  • public abstract class CacheFactory
extends Base
    Factory for the Coherence™ cache product.

    One of the most common functions provided by the CacheFactory is ability to obtain an instance of a cache. To get a cache reference use the getCache(String, ClassLoader) or getCache(String) methods.

    When a cache retrieved by any of the above methods is no longer used, it is recommended to call releaseCache(NamedCache) to release the associated resources. To destroy all instances of the cache across the cluster, use destroyCache(NamedCache).

    Applications that require more control when obtaining cache and service references should use the CacheFactoryBuilder API.

    Author:
    cp, gg 2001.12.14

    • Field Detail

      • PRODUCT

        public static final String PRODUCT
        The product name string.

      • VERSION

        public static final String VERSION
        Software version string.

      • VERSION_ENCODED

        public static final int VERSION_ENCODED
        Software version encoded to an int.

    • Constructor Detail

      • CacheFactory

        public CacheFactory()

    • Method Detail

      • getCacheFactoryBuilder

        public static CacheFactoryBuilder getCacheFactoryBuilder()
        Obtain the CacheFactoryBuilder singleton using the configuration info from the "cache-factory-builder-config" element.
        Returns:
        an instance of CacheFactoryBuilder
        Since:
        Coherence 3.5.1

      • setCacheFactoryBuilder

        public static void setCacheFactoryBuilder​(CacheFactoryBuilder cfb)
        Specify a singleton CacheFactoryBuilder.
        Parameters:
        cfb - an instance of CacheFactoryBuilder
        Since:
        Coherence 3.5.1

      • getConfigurableCacheFactory

        public static ConfigurableCacheFactory getConfigurableCacheFactory()
        Obtain the ConfigurableCacheFactory singleton using the configuration info from the "configurable-cache-factory-config" element located in the tangosol-coherence.xml configuration file.
        Returns:
        an instance of ConfigurableCacheFactory
        Since:
        Coherence 2.2

      • setConfigurableCacheFactory

        public static void setConfigurableCacheFactory​(ConfigurableCacheFactory factory)
        Deprecated.
        As of 12.2.1 deprecated with no replacement
        Specify a singleton of ConfigurableCacheFactory.
        Parameters:
        factory - an instance of ConfigurableCacheFactory
        Since:
        Coherence 2.2

      • getService

        public static Service getService​(String sName)
        Return an instance of a service configured by the current ConfigurableCacheFactory. This helper method is a simple wrapper around the ConfigurableCacheFactory.ensureService(String) method.
        Parameters:
        sName - service name (unique for a given configurable cache factory). If the Service with the specified name already exists, a reference to the same object will be returned
        Returns:
        the Service object
        Since:
        Coherence 3.3

      • getCache

        public static <K,​V> NamedCache<K,​V> getCache​(String sName,
                                                         ClassLoader loader)
        Return an instance of a cache configured by the current ConfigurableCacheFactory with a specific ClassLoader no options.

        This helper method is a simple wrapper around the ConfigurableCacheFactory.ensureCache(String, ClassLoader, NamedCache.Option...) method.

        Parameters:
        sName - cache name (unique for a given configurable cache factory). If the NamedCache with the specified name already exists, a reference to the same object will be returned
        loader - ClassLoader that should be used to deserialize objects inserted in the map by other members of the cluster
        Returns:
        the NamedCache reference
        Since:
        Coherence 2.2

      • getLocalTransaction

        public static TransactionMap getLocalTransaction​(NamedCache map)
        Factory method returning an instance of the TransactionMap that is based on the specified NamedCache and is local to this JVM.

        Note: TransactionMap instance returned by this method will also implement the NamedCache interface, allowing a client code to chain local transaction by using the returned TransactionMap as a parameter for another getLocalTransaction() call.

        Parameters:
        map - the NamedCache object to be used as a base for transaction
        Returns:
        a TransactionMap instance
        Since:
        Coherence 1.2

      • commitTransactionCollection

        public static boolean commitTransactionCollection​(Collection collCaches,
                                                  int cRetry)
        Commit the transaction represented by a collection of TransactionMap objects. Due to any of a number of reasons, the transaction could fail to commit; if it fails to commit, the transaction is rolled back.
        Parameters:
        collCaches - a collection of TransactionMap objects
        cRetry - the number of times [0..100] to retry a stage of the transaction if a concurrency conflict occurs
        Returns:
        true if the transaction could be committed; false otherwise

      • rollbackTransactionCollection

        public static void rollbackTransactionCollection​(Collection collCaches)
        Roll back the transaction represented by a collection of TransactionMap objects.
        Parameters:
        collCaches - a collection of TransactionMap objects

      • getCluster

        public static Cluster getCluster()
        Return a Cluster object for Coherence services.
        Returns:
        a Cluster object which may or may not be running
        Since:
        Coherence 1.1

      • ensureCluster

        public static Cluster ensureCluster()
        Obtain a Cluster object running Coherence services. Calling this method is optional. The cluster member carrying caching services will be lazily initialized when a first cache is about to be created. However, that operation could take significant time (especially for a first cluster member). This method forces initialization, making all cache creating requests predictably faster.
        Returns:
        a Cluster object
        Since:
        Coherence 1.1

      • shutdown

        public static void shutdown()
        Shutdown all clustered services.
        Since:
        Coherence 1.0

      • releaseCache

        public static void releaseCache​(NamedCache cache)
        Release local resources associated with the specified instance of the cache. This invalidates a reference obtained by any of getCache() methods.

        Releasing a NamedCache reference makes it no longer usable, but does not affect the content of the cache. In other words, all other references to the cache will still be valid, and the cache data is not affected by releasing the reference.

        The reference that is released using this method can no longer be used; any attempt to use the reference will result in an exception.

        The purpose for releasing a cache reference is to allow the cache implementation to release the ClassLoader used to deserialize items in the cache. The cache implementation ensures that all references to that ClassLoader are released. This implies that objects in the cache that were loaded by that ClassLoader will be re-serialized to release their hold on that ClassLoader. The result is that the ClassLoader can be garbage-collected by Java in situations where the cache is operating in an application server and applications are dynamically loaded and unloaded.

        Parameters:
        cache - the NamedCache object to be released
        Since:
        Coherence 1.1
        See Also:
        CacheService.releaseCache(NamedCache), destroyCache(NamedCache)

      • destroyCache

        public static void destroyCache​(NamedCache cache)
        Releases and destroys the specified 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 resources will be released.

        Parameters:
        cache - the NamedCache object to be destroyed
        Since:
        Coherence 1.1
        See Also:
        CacheService.destroyCache(NamedCache), releaseCache(NamedCache)

      • getEdition

        public static String getEdition()
        Returns the edition currently loaded based on the operational configuration.
        Returns:
        the abbreviated string representation of the current edition. Potential values include (GE,EE,SE,RTC,DC)
        Since:
        Coherence 12.1.2

      • log

        @Deprecated
public static void log​(String sMessage,
                       int nSeverity)
        Deprecated.
        since Coherence 14.1.2, and may be removed in a future version; use one of Logger methods instead.
        Log a message using Coherence logging facility which is driven by the "logging-config" element located in the tangosol-coherence.xml configuration file.
        Parameters:
        sMessage - a message to log
        nSeverity - the severity of the logged message; 0=default, 1=error; 2=warning; 3=info; 4-9=debug
        Since:
        Coherence 2.0

      • isLogEnabled

        @Deprecated
public static boolean isLogEnabled​(int nSeverity)
        Deprecated.
        since Coherence 14.1.2, and may be removed in a future version; use Logger.isEnabled(int) method instead.
        Check if a message of the specified severity level will be logged using the Coherence logging facility.
        Parameters:
        nSeverity - the severity of a message
        Returns:
        true if a message with the specified severity level will be logged; false otherwise
        Since:
        Coherence 3.2
        See Also:
        log(java.lang.String, int)

      • getClusterConfig

        public static XmlElement getClusterConfig()
        Return the default cluster configuration as defined by the "cluster-config" element in the tangosol-coherence.xml configuration file.
        Returns:
        XmlElement representing the default cluster configuration

      • getReplicatedCacheConfig

        public static XmlElement getReplicatedCacheConfig()
        Return the default replicated cache configuration.
        Returns:
        XmlElement representing the replicated cache configuration
        See Also:
        getServiceConfig(String)

      • getDistributedCacheConfig

        public static XmlElement getDistributedCacheConfig()
        Return the default distributed (partitioned) cache configuration.
        Returns:
        XmlElement representing the partitioned cache configuration
        See Also:
        getServiceConfig(String)

      • getLicenseMode

        public static String getLicenseMode()
        Returns the value of license-mode child element of license-config element in the operational configuration.
        Returns:
        configured license mode of either eval, dev or prod
        Since:
        Coherence 21.12

      • getLoggingConfig

        public static XmlElement getLoggingConfig()
        Return the configuration info for the logging facility as defined by the "logging-config" element in the tangosol-coherence.xml configuration file.
        Returns:
        XmlElement representing the logging facility configuration
        Since:
        Coherence 2.2

      • setLoggingConfig

        public static void setLoggingConfig​(XmlElement xmlCfg)
        Set the configuration info for the logging facility. If the Logger daemon is already running, this call will also force its restart.
        Parameters:
        xmlCfg - an XmlElement representing the new logging configuration
        Since:
        Coherence 3.4.1

      • getCacheFactoryBuilderConfig

        public static XmlElement getCacheFactoryBuilderConfig()
        Return the cache factory builder configuration as defined by the "cache-factory-builder-config" element in the tangosol-coherence.xml configuration file.
        Returns:
        XmlElement representing the cache factory builder configuration
        Since:
        Coherence 3.5.1

      • setCacheFactoryBuilderConfig

        public static void setCacheFactoryBuilderConfig​(XmlElement xmlCfg)
        Set the cache factory builder configuration. If the Cluster service is already running, this call will not have any effect.
        Parameters:
        xmlCfg - an XmlElement representing the cache factory builder configuration
        Since:
        Coherence 3.5.1

      • getConfigurableCacheFactoryConfig

        public static XmlElement getConfigurableCacheFactoryConfig()
        Return the configurable cache factory configuration as defined by the "configurable-cache-factory-config" element in the tangosol-coherence.xml configuration file.
        Returns:
        XmlElement representing the configurable cache factory configuration
        Since:
        Coherence 2.2

      • setConfigurableCacheFactoryConfig

        public static void setConfigurableCacheFactoryConfig​(XmlElement xmlCfg)
        Set the configurable cache factory configuration. If the Cluster service is already running, this call will not have any effect.
        Parameters:
        xmlCfg - an XmlElement representing the configurable cache factory configuration
        Since:
        Coherence 3.4.1

      • getSecurityConfig

        public static XmlElement getSecurityConfig()
        Return the security framework configuration.
        Returns:
        XmlElement representing the security framework configuration
        Since:
        Coherence 2.5

      • setSecurityConfig

        public static void setSecurityConfig​(XmlElement xmlCfg)
        Set the security framework configuration. If the Cluster service is already running, this call will not have any effect.
        Parameters:
        xmlCfg - an XmlElement representing the security framework configuration
        Since:
        Coherence 3.4.1

      • getManagementConfig

        public static XmlElement getManagementConfig()
        Return the management framework configuration.
        Returns:
        XmlElement representing the management framework configuration
        Since:
        Coherence 3.3

      • setManagementConfig

        public static void setManagementConfig​(XmlElement xmlCfg)
        Set the management framework configuration. If the Cluster service is already running, this call will not have any effect.
        Parameters:
        xmlCfg - an XmlElement representing the management framework configuration
        Since:
        Coherence 3.4.1

      • getServiceConfig

        public static XmlElement getServiceConfig​(String sServiceType)
        Return the configuration for the specified service type.
        Parameters:
        sServiceType - the service type
        Returns:
        XmlElement representing the service configuration
        Since:
        Coherence 2.2

      • setServiceConfig

        public static void setServiceConfig​(String sServiceType,
                                    XmlElement xmlCfg)
        Set the configuration for the specified service type. If the Cluster service is already running, this call may not have any effect.
        Parameters:
        sServiceType - the service type
        xmlCfg - an XmlElement representing the service configuration
        Since:
        Coherence 3.4.1

      • setLoggingLevel

        public static void setLoggingLevel​(Integer ILevel)
        Set the Coherence logging level.
        Parameters:
        ILevel - the logging level to set
        Since:
        22.09

      • main

        public static void main​(String[] asArg)
                 throws Exception
        Invoke the Coherence command line tool.
        Throws:
        Exception