00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_CONFIGURABLE_CACHE_FACTORY_HPP 00008 #define COH_CONFIGURABLE_CACHE_FACTORY_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/net/NamedCache.hpp" 00013 #include "coherence/net/Service.hpp" 00014 #include "coherence/run/xml/XmlConfigurable.hpp" 00015 00016 COH_OPEN_NAMESPACE2(coherence,net) 00017 00018 using coherence::run::xml::XmlConfigurable; 00019 00020 /** 00021 * An interface for XML driven %cache factory. 00022 * 00023 * @see DefaultConfigurableCacheFactory 00024 */ 00025 class COH_EXPORT ConfigurableCacheFactory 00026 : public interface_spec<ConfigurableCacheFactory, 00027 implements<XmlConfigurable> > 00028 { 00029 // ----- ConfigurableCacheFactory interface ----------------------------- 00030 00031 public: 00032 /** 00033 * Ensure a %cache for the given name using the corresponding XML 00034 * configuration. 00035 * 00036 * @param vsCacheName the %cache name 00037 * 00038 * @return a handle to a NamedCache created according to the 00039 * configuration XML 00040 */ 00041 virtual NamedCache::Handle ensureCache(String::View vsCacheName) = 0; 00042 00043 /** 00044 * Releases and destroys the specified NamedCache. 00045 * 00046 * <b>Warning:</b> This method is used to completely destroy the 00047 * specified %cache across the cluster. All references in the entire 00048 * cluster to this %cache will be invalidated, the cached data will be 00049 * cleared, and all resources will be released. 00050 * 00051 * @param hCache the NamedCache object to be destroyed 00052 * 00053 * @see releaseCache 00054 */ 00055 virtual void destroyCache(NamedCache::Handle hCache) = 0; 00056 00057 /** 00058 * Release local resources associated with the specified instance of 00059 * the %cache. 00060 * 00061 * Releasing a NamedCache reference makes it no longer usable, but 00062 * does not affect the content of the %cache. In other words, all other 00063 * references to the %cache will still be valid, and the %cache data is 00064 * not affected by releasing the reference. 00065 * 00066 * The reference that is released using this method can no longer be 00067 * used; any attempt to use the reference will result in an exception. 00068 * 00069 * @param hCache the NamedCache object to be released 00070 * 00071 * @see destroyCache 00072 */ 00073 virtual void releaseCache(NamedCache::Handle hCache) = 0; 00074 00075 /** 00076 * Ensure a service for the given name using the corresponding XML 00077 * configuration. 00078 * 00079 * @param vsServiceName the service name 00080 * 00081 * @return a handle to a service created according to the 00082 * configuration XML 00083 */ 00084 virtual Service::Handle ensureService(String::View vsServiceName) = 0; 00085 00086 /** 00087 * Shutdown all services related to this ConfigurableCacheFactory. 00088 */ 00089 virtual void shutdown() = 0; 00090 }; 00091 00092 COH_CLOSE_NAMESPACE2 00093 00094 #endif // COH_CONFIGURABLE_CACHE_FACTORY_HPP