public interface EmbeddedCacheManager extends CacheContainer, Listenable
Configuration
or a path or URL to a configuration XML file: see DefaultCacheManager
.
Lifecycle - EmbeddedCacheManagers have a lifecycle (it implements Lifecycle
) and
the default constructors also call Lifecycle.start()
. Overloaded versions of the constructors are available, that do
not start the CacheManager, although it must be kept in mind that CacheManagers need to be started
before they can be used to create Cache instances.
Once constructed, EmbeddedCacheManagers should be made available to any component that requires a Cache,
via JNDI or via some other mechanism
such as an dependency injection framework.
DefaultCacheManager
DEFAULT_CACHE_NAME
Modifier and Type | Method and Description |
---|---|
boolean |
cacheExists(String cacheName)
A cache is considered to exist if it has been created and started via
one of the
CacheContainer.getCache() methods and has not yet been removed via
removeCache(String) . |
Configuration |
defineConfiguration(String cacheName,
Configuration configurationOverride)
Deprecated.
|
Configuration |
defineConfiguration(String cacheName,
Configuration configurationOverride)
Defines a named cache's configuration using the following algorithm:
Unlike previous versions of Infinispan, this method does not build on an existing configuration (default or named).
|
Configuration |
defineConfiguration(String cacheName,
String templateCacheName,
Configuration configurationOverride)
Deprecated.
|
Address |
getAddress() |
<K,V> Cache<K,V> |
getCache(String cacheName,
boolean createIfAbsent)
Retrieves a named cache from the system in the same way that
CacheContainer.getCache(String) does except that if offers the possibility for the
named cache not to be retrieved if it has not yet been started, or if
it's been removed after being started. |
Configuration |
getCacheConfiguration(String name)
Returns the configuration for the given cache.
|
GlobalConfiguration |
getCacheManagerConfiguration()
Returns global configuration for this CacheManager
|
Set<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.
|
String |
getClusterName() |
Address |
getCoordinator() |
Configuration |
getDefaultCacheConfiguration()
Returns default configuration for this CacheManager
|
Configuration |
getDefaultConfiguration()
Deprecated.
Use
getDefaultCacheConfiguration() instead.
Please note that before this method was deprecated, modifications on the
Configuration returned would be applied to the default cache if it
was not started. Since the deprecation, this method returns a copy and
so any changes to the returned object won't have any impact on the
default cache instance. |
GlobalConfiguration |
getGlobalConfiguration()
Deprecated.
Use
getCacheManagerConfiguration() instead.
Please note that before this method was deprecated, modifications on the
GlobalConfiguration returned would be applied to the cache manager if it
was not started. Since the deprecation, this method returns a copy and
so any changes to the returned object won't have any impact on the cache
manager instance. |
List<Address> |
getMembers() |
ComponentStatus |
getStatus() |
Transport |
getTransport() |
boolean |
isCoordinator() |
boolean |
isDefaultRunning()
Tests whether the default cache is running.
|
boolean |
isRunning(String cacheName)
Tests whether a named cache is running.
|
void |
removeCache(String cacheName)
Removes a cache with the given name from the system.
|
EmbeddedCacheManager |
startCaches(String... cacheNames)
Starts a set of caches in parallel.
|
getCache, getCache
addListener, getListeners, removeListener
@Deprecated Configuration defineConfiguration(String cacheName, Configuration configurationOverride)
defineConfiguration(String, String, org.infinispan.config.Configuration)
insteadcacheName
- name of cache whose configuration is being definedconfigurationOverride
- configuration overrides to useConfiguration defineConfiguration(String cacheName, Configuration configurationOverride)
ConfigurationBuilder.read(org.infinispan.configuration.cache.Configuration)
.
The other way to define named cache's configuration is declaratively, in the XML file passed in to the cache
manager. This method enables you to override certain properties that have previously been defined via XML.
Passing a brand new Configuration instance as configuration override without having called any of its setters will
effectively return the named cache's configuration since no overrides where passed to it.cacheName
- name of cache whose configuration is being definedconfigurationOverride
- configuration overrides to use@Deprecated Configuration defineConfiguration(String cacheName, String templateCacheName, Configuration configurationOverride)
defineConfiguration(String, org.infinispan.configuration.cache.Configuration)
insteaddefineConfiguration(String, Configuration)
in the sense that the base configuration used is the default cache
configuration.cacheName
- name of cache whose configuration is being definedtemplateCacheName
- name of cache to which to which apply overrides if cache name has not been previously
definedconfigurationOverride
- configuration overrides to useString getClusterName()
Address getAddress()
Address getCoordinator()
boolean isCoordinator()
ComponentStatus getStatus()
@Deprecated GlobalConfiguration getGlobalConfiguration()
getCacheManagerConfiguration()
instead.
Please note that before this method was deprecated, modifications on the
GlobalConfiguration returned would be applied to the cache manager if it
was not started. Since the deprecation, this method returns a copy and
so any changes to the returned object won't have any impact on the cache
manager instance.GlobalConfiguration getCacheManagerConfiguration()
Configuration getCacheConfiguration(String name)
@Deprecated Configuration getDefaultConfiguration()
getDefaultCacheConfiguration()
instead.
Please note that before this method was deprecated, modifications on the
Configuration returned would be applied to the default cache if it
was not started. Since the deprecation, this method returns a copy and
so any changes to the returned object won't have any impact on the
default cache instance.Configuration getDefaultCacheConfiguration()
Set<String> getCacheNames()
boolean isRunning(String cacheName)
cacheName
- name of cache to test.boolean isDefaultRunning()
boolean cacheExists(String cacheName)
CacheContainer.getCache()
methods and has not yet been removed via
removeCache(String)
.
In environments when caches are continuously created and removed, this
method offers the possibility to find out whether a cache has either,
not been started, or if it was started, whether it's been removed already
or not.cacheName
- <K,V> Cache<K,V> getCache(String cacheName, boolean createIfAbsent)
CacheContainer.getCache(String)
does except that if offers the possibility for the
named cache not to be retrieved if it has not yet been started, or if
it's been removed after being started.cacheName
- name of cache to retrievecreateIfAbsent
- if false, the named cache will not be
retrieved if it hasn't been retrieved previously or if it's been
removed. If true, this methods works just like CacheContainer.getCache(String)
EmbeddedCacheManager startCaches(String... cacheNames)
cacheNames
- the names of the caches to startvoid removeCache(String cacheName)
cacheName
- name of cache to removeTransport getTransport()
Copyright © 2017 JBoss, a division of Red Hat. All Rights Reserved.