org.infinispan.api
Interface BasicCacheContainer
- All Superinterfaces:
- Lifecycle
- All Known Subinterfaces:
- CacheContainer, CacheManager, EmbeddedCacheManager
- All Known Implementing Classes:
- AbstractDelegatingEmbeddedCacheManager, DefaultCacheManager, RemoteCacheManager
public interface BasicCacheContainer
- extends Lifecycle
BasicCacheContainer defines the methods used to obtain a BasicCache
.
- Since:
- 4.0
- Author:
- Manik Surtani (manik@jboss.org), Galder ZamarreƱo, Mircea.Markus@jboss.com
- See Also:
EmbeddedCacheManager
Method Summary |
|
getCache()
Retrieves the default cache associated with this cache container. |
|
getCache(String cacheName)
Retrieves a named cache from the system. |
DEFAULT_CACHE_NAME
static final String DEFAULT_CACHE_NAME
- See Also:
- Constant Field Values
getCache
<K,V> BasicCache<K,V> getCache()
- 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.
- Returns:
- the default cache.
getCache
<K,V> BasicCache<K,V> getCache(String cacheName)
- 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
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 EmbeddedCacheManager.defineConfiguration(String, org.infinispan.config.Configuration)
or 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.
- Parameters:
cacheName
- name of cache to retrieve
- Returns:
- a cache instance identified by cacheName
Copyright © 2012 JBoss, a division of Red Hat. All Rights Reserved.