org.infinispan.commons.api

Interface BasicCacheContainer

All Superinterfaces:

Lifecycle

All Known Subinterfaces:

CacheContainer, EmbeddedCacheManager, RemoteCacheContainer

All Known Implementing Classes:

AbstractDelegatingEmbeddedCacheManager, AbstractDelegatingEmbeddedCacheManager, DefaultCacheManager, RemoteCacheManager

public interface BasicCacheContainer
extends Lifecycle

BasicCacheContainer defines the methods used to obtain a org.infinispan.api.BasicCache.

Since:

4.0

See Also:

EmbeddedCacheManager, RemoteCacheManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CACHE_NAME Deprecated.

Method Summary

Modifier and Type	Method and Description
<K,V> BasicCache<K,V>	getCache() Retrieves the default cache associated with this cache container.
<K,V> BasicCache<K,V>	getCache(java.lang.String cacheName) Retrieves a named cache from the system.
java.util.Set<java.lang.String>	getCacheNames() This method returns a collection of caches names which contains the caches that have been defined via XML or programmatically, and the caches that have been created at runtime via this cache manager instance.

Methods inherited from interface org.infinispan.commons.api.Lifecycle

start, stop

Field Detail

DEFAULT_CACHE_NAME

@Deprecated
static final java.lang.String DEFAULT_CACHE_NAME

Deprecated.

See Also:

Constant Field Values

Method Detail

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, unless one has not been supplied to the cache container.

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(java.lang.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

getCacheNames

java.util.Set<java.lang.String> getCacheNames()

This method returns a collection of caches names which contains the caches that have been defined via XML or programmatically, and the caches that have been created at runtime via this cache manager instance. If no named caches are registered or no caches have been created, this method returns an empty set. The list of caches does not include internal-only caches InternalCacheRegistry

Returns:

an immutable set of caches registered or created with this cache manager.