org.infinispan.manager
Interface EmbeddedCacheManager

All Superinterfaces:

CacheContainer, Lifecycle, Listenable

All Known Subinterfaces:

CacheManager

All Known Implementing Classes:

DefaultCacheManager

public interface EmbeddedCacheManager
extends CacheContainer, Listenable

EmbeddedCacheManager is an CacheManager that runs in the same JVM as the client.

Constructing a EmbeddedCacheManager is done via one of its constructors, which optionally take in a 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.

Since:

4.1

Author:

Manik Surtani (manik@jboss.org), Galder Zamarreno, Mircea.Markus@jboss.com

See Also:

DefaultCacheManager

Field Summary

Fields inherited from interface org.infinispan.manager.CacheContainer

DEFAULT_CACHE_NAME

Method Summary

Configuration	defineConfiguration(String cacheName, Configuration configurationOverride) Defines a named cache's configuration using the following algorithm: If cache name hasn't been defined before, this method creates a clone of the default cache's configuration, applies a clone of the configuration overrides passed in and returns this configuration instance.
Configuration	defineConfiguration(String cacheName, String templateCacheName, Configuration configurationOverride) Defines a named cache's configuration using the following algorithm: Regardless of whether the cache name has been defined or not, this method creates a clone of the configuration of the cache whose name matches the given template cache name, then applies a clone of the configuration overrides passed in and finally returns this configuration instance.
Address	getAddress()
Set<String>	getCacheNames() If no named caches are registered, this method returns an empty set.
String	getClusterName()
Configuration	getDefaultConfiguration() Returns default configuration for this CacheManager
GlobalConfiguration	getGlobalConfiguration() Returns global configuration for this CacheManager
List<Address>	getMembers()
ComponentStatus	getStatus()
boolean	isCoordinator()

Methods inherited from interface org.infinispan.manager.CacheContainer

getCache, getCache

Methods inherited from interface org.infinispan.lifecycle.Lifecycle

start, stop

Methods inherited from interface org.infinispan.notifications.Listenable

addListener, getListeners, removeListener

Method Detail

defineConfiguration

Configuration defineConfiguration(String cacheName,
                                  Configuration configurationOverride)

Defines a named cache's configuration using the following algorithm:

If cache name hasn't been defined before, this method creates a clone of the default cache's configuration, applies a clone of the configuration overrides passed in and returns this configuration instance.

If cache name has been previously defined, this method creates a clone of this cache's existing configuration, applies a clone of the configuration overrides passed in and returns the configuration instance.

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.

Parameters:

cacheName - name of cache whose configuration is being defined

configurationOverride - configuration overrides to use

Returns:

a cloned configuration instance

defineConfiguration

Configuration defineConfiguration(String cacheName,
                                  String templateCacheName,
                                  Configuration configurationOverride)

Defines a named cache's configuration using the following algorithm:

Regardless of whether the cache name has been defined or not, this method creates a clone of the configuration of the cache whose name matches the given template cache name, then applies a clone of the configuration overrides passed in and finally returns this configuration instance.

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.

If templateName is null or there isn't any named cache with that name, this methods works exactly like defineConfiguration(String, Configuration) in the sense that the base configuration used is the default cache configuration.

Parameters:

cacheName - name of cache whose configuration is being defined

templateCacheName - name of cache to which to which apply overrides if cache name has not been previously defined

configurationOverride - configuration overrides to use

Returns:

a cloned configuration instance

getClusterName

String getClusterName()

Returns:

the name of the cluster. Null if running in local mode.

getMembers

List<Address> getMembers()

getAddress

Address getAddress()

isCoordinator

boolean isCoordinator()

getStatus

ComponentStatus getStatus()

getGlobalConfiguration

GlobalConfiguration getGlobalConfiguration()

Returns global configuration for this CacheManager

Returns:

the global configuration object associated to this CacheManager

getDefaultConfiguration

Configuration getDefaultConfiguration()

Returns default configuration for this CacheManager

Returns:

the default configuration associated with this CacheManager

getCacheNames

Set<String> getCacheNames()

If no named caches are registered, this method returns an empty set. The default cache is never included in this set of cache names.

Returns:

an immutable set of non-default named caches registered with this cache manager.