org.infinispan.commons.api.BasicCacheContainer Maven / Gradle / Ivy
package org.infinispan.commons.api;
/**
* BasicCacheContainer defines the methods used to obtain a {@link org.infinispan.api.BasicCache}.
*
*
*
* @see org.infinispan.manager.EmbeddedCacheManager
* @see org.infinispan.client.hotrod.RemoteCacheManager
*
* @author Manik Surtani ([email protected])
* @author Galder Zamarreño
* @author [email protected]
* @since 4.0
*/
public interface BasicCacheContainer extends Lifecycle {
String DEFAULT_CACHE_NAME = "___defaultcache";
/**
* Retrieves the default cache associated with this cache container.
*
* As such, this method is always guaranteed to return the default cache.
*
* NB: Shared caches are supported (and in fact encouraged) but if they are used it's the users responsibility to
* ensure that at least one but only one caller calls stop() on the cache, and it does so with the awareness
* that others may be using the cache.
*
* @return the default cache.
*/
BasicCache getCache();
/**
* Retrieves a named cache from the system. If the cache has been previously created with the same name, the running
* cache instance is returned. Otherwise, this method attempts to create the cache first.
*
* In the case of a {@link org.infinispan.manager.EmbeddedCacheManager}: when creating a new cache, this method will
* use the configuration passed in to the EmbeddedCacheManager on construction, as a template, and then optionally
* apply any overrides previously defined for the named cache using the {@link EmbeddedCacheManager#defineConfiguration(String, org.infinispan.config.Configuration)}
* or {@link EmbeddedCacheManager#defineConfiguration(String, String, org.infinispan.config.Configuration)}
* methods, or declared in the configuration file.
*
* NB: Shared caches are supported (and in fact encouraged) but if they are used it's the users responsibility to
* ensure that at least one but only one caller calls stop() on the cache, and it does so with the awareness
* that others may be using the cache.
*
* @param cacheName name of cache to retrieve
* @return a cache instance identified by cacheName
*/
BasicCache getCache(String cacheName);
}