org.infinispan.manager
Class DefaultCacheManager

java.lang.Object
  org.infinispan.manager.DefaultCacheManager

All Implemented Interfaces:

Lifecycle, CacheManager, Listenable

public class DefaultCacheManager
extends Object
implements CacheManager

A CacheManager is the primary mechanism for retrieving a Cache instance, and is often used as a starting point to using the Cache.

CacheManagers are heavyweight objects, and we foresee no more than one CacheManager being used per JVM (unless specific configuration requirements require more than one; but either way, this would be a minimal and finite number of instances).

Constructing a CacheManager is done via one of its constructors, which optionally take in a Configuration or a path or URL to a configuration XML file.

Lifecycle - CacheManagers have a lifecycle (it implements Lifecycle) and the default constructors also call 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, CacheManagers should be made available to any component that requires a Cache, via JNDI or via some other mechanism such as an IoC container.

You obtain Cache instances from the CacheManager by using one of the overloaded getCache(), methods. Note that with getCache(), there is no guarantee that the instance you get is brand-new and empty, since caches are named and shared. Because of this, the CacheManager also acts as a repository of Caches, and is an effective mechanism of looking up or creating Caches on demand.

When the system shuts down, it should call stop() on the CacheManager. This will ensure all caches within its scope are properly stopped as well.

Sample usage: CacheManager manager = CacheManager.getInstance("my-config-file.xml"); Cache entityCache = manager.getCache("myEntityCache"); entityCache.put("aPerson", new Person());

Configuration myNewConfiguration = new Configuration(); myNewConfiguration.setCacheMode(Configuration.CacheMode.LOCAL); manager.defineConfiguration("myLocalCache", myNewConfiguration); Cache localCache = manager.getCache("myLocalCache");

Since:

4.0

Author:

Manik Surtani (manik@jboss.org), Galder Zamarreño

Field Summary

static String	DEFAULT_CACHE_NAME
protected Configuration	defaultConfiguration
protected GlobalConfiguration	globalConfiguration
static String	OBJECT_NAME

Constructor Summary

DefaultCacheManager()
Constructs and starts a default instance of the CacheManager, using configuration defaults.

DefaultCacheManager(boolean start)
Constructs a default instance of the CacheManager, using configuration defaults.

DefaultCacheManager(Configuration defaultConfiguration)
Constructs and starts a new instance of the CacheManager, using the default configuration passed in.

DefaultCacheManager(Configuration defaultConfiguration, boolean start)
Constructs a new instance of the CacheManager, using the default configuration passed in.

DefaultCacheManager(GlobalConfiguration globalConfiguration)
Constructs and starts a new instance of the CacheManager, using the global configuration passed in, and system defaults for the default named cache configuration.

DefaultCacheManager(GlobalConfiguration globalConfiguration, boolean start)
Constructs a new instance of the CacheManager, using the global configuration passed in, and system defaults for the default named cache configuration.

DefaultCacheManager(GlobalConfiguration globalConfiguration, Configuration defaultConfiguration)
Constructs and starts a new instance of the CacheManager, using the global and default configurations passed in.

DefaultCacheManager(GlobalConfiguration globalConfiguration, Configuration defaultConfiguration, boolean start)
Constructs a new instance of the CacheManager, using the global and default configurations passed in.

DefaultCacheManager(InputStream configurationStream)
Constructs and starts a new instance of the CacheManager, using the input stream passed in to read configuration file contents.

DefaultCacheManager(InputStream configurationStream, boolean start)
Constructs a new instance of the CacheManager, using the input stream passed in to read configuration file contents.

DefaultCacheManager(String configurationFile)
Constructs and starts a new instance of the CacheManager, using the configuration file name passed in.

DefaultCacheManager(String configurationFile, boolean start)
Constructs a new instance of the CacheManager, using the configuration file name passed in.

DefaultCacheManager(String globalConfigurationFile, String defaultConfigurationFile, String namedCacheFile, boolean start)
Constructs a new instance of the CacheManager, using the two configuration file names passed in.

Method Summary

void	addListener(Object listener) Adds a listener to the component.
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 templateName, 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()
<K,V> Cache<K,V>	getCache() Retrieves the default cache associated with this cache manager.
<K,V> Cache<K,V>	getCache(String cacheName) Retrieves a named cache from the system.
String	getCacheManagerStatus()
Set<String>	getCacheNames() If no named caches are registered, this method returns an empty set.
String	getClusterName()
String	getCreatedCacheCount()
Configuration	getDefaultConfiguration() Returns default configuration for this CacheManager
String	getDefinedCacheCount()
String	getDefinedCacheNames()
GlobalConfiguration	getGlobalConfiguration() Returns global configuration for this CacheManager
Set<Object>	getListeners()
List<Address>	getMembers()
String	getName()
String	getRunningCacheCount()
ComponentStatus	getStatus()
String	getVersion()
boolean	isCoordinator()
void	removeListener(Object listener) Removes a listener from the component.
void	start()
void	startCache()
void	startCache(String cacheName)
void	stop()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CACHE_NAME

public static final String DEFAULT_CACHE_NAME

See Also:

Constant Field Values

OBJECT_NAME

public static final String OBJECT_NAME

See Also:

Constant Field Values

globalConfiguration

protected final GlobalConfiguration globalConfiguration

defaultConfiguration

protected final Configuration defaultConfiguration

Constructor Detail

DefaultCacheManager

public DefaultCacheManager()

Constructs and starts a default instance of the CacheManager, using configuration defaults.

DefaultCacheManager

public DefaultCacheManager(boolean start)

Constructs a default instance of the CacheManager, using configuration defaults.

Parameters:

start - if true, the cache manager is started

DefaultCacheManager

public DefaultCacheManager(Configuration defaultConfiguration)

Constructs and starts a new instance of the CacheManager, using the default configuration passed in. Uses defaults for a GlobalConfiguration.

Parameters:

defaultConfiguration - configuration to use as a template for all caches created

DefaultCacheManager

public DefaultCacheManager(Configuration defaultConfiguration,
                           boolean start)

Constructs a new instance of the CacheManager, using the default configuration passed in. Uses defaults for a GlobalConfiguration.

Parameters:

defaultConfiguration - configuration file to use as a template for all caches created

start - if true, the cache manager is started

DefaultCacheManager

public DefaultCacheManager(GlobalConfiguration globalConfiguration)

Constructs and starts a new instance of the CacheManager, using the global configuration passed in, and system defaults for the default named cache configuration.

Parameters:

globalConfiguration - GlobalConfiguration to use for all caches created

DefaultCacheManager

public DefaultCacheManager(GlobalConfiguration globalConfiguration,
                           boolean start)

Constructs a new instance of the CacheManager, using the global configuration passed in, and system defaults for the default named cache configuration.

Parameters:

globalConfiguration - GlobalConfiguration to use for all caches created

start - if true, the cache manager is started.

DefaultCacheManager

public DefaultCacheManager(GlobalConfiguration globalConfiguration,
                           Configuration defaultConfiguration)

Constructs and starts a new instance of the CacheManager, using the global and default configurations passed in. If either of these are null, system defaults are used.

Parameters:

globalConfiguration - global configuration to use. If null, a default instance is created.

defaultConfiguration - default configuration to use. If null, a default instance is created.

DefaultCacheManager

public DefaultCacheManager(GlobalConfiguration globalConfiguration,
                           Configuration defaultConfiguration,
                           boolean start)

Constructs a new instance of the CacheManager, using the global and default configurations passed in. If either of these are null, system defaults are used.

Parameters:

globalConfiguration - global configuration to use. If null, a default instance is created.

defaultConfiguration - default configuration to use. If null, a default instance is created.

start - if true, the cache manager is started

DefaultCacheManager

public DefaultCacheManager(String configurationFile)
                    throws IOException

Constructs and starts a new instance of the CacheManager, using the configuration file name passed in. This constructor first searches for the named file on the classpath, and failing that, treats the file name as an absolute path.

Parameters:

configurationFile - name of configuration file to use as a template for all caches created

Throws:

IOException - if there is a problem with the configuration file.

DefaultCacheManager

public DefaultCacheManager(String configurationFile,
                           boolean start)
                    throws IOException

Constructs a new instance of the CacheManager, using the configuration file name passed in. This constructor first searches for the named file on the classpath, and failing that, treats the file name as an absolute path.

Parameters:

configurationFile - name of configuration file to use as a template for all caches created

start - if true, the cache manager is started

Throws:

IOException - if there is a problem with the configuration file.

DefaultCacheManager

public DefaultCacheManager(InputStream configurationStream)
                    throws IOException

Constructs and starts a new instance of the CacheManager, using the input stream passed in to read configuration file contents.

Parameters:

configurationStream - stream containing configuration file contents, to use as a template for all caches created

Throws:

IOException - if there is a problem with the configuration stream.

DefaultCacheManager

public DefaultCacheManager(InputStream configurationStream,
                           boolean start)
                    throws IOException

Constructs a new instance of the CacheManager, using the input stream passed in to read configuration file contents.

Parameters:

configurationStream - stream containing configuration file contents, to use as a template for all caches created

start - if true, the cache manager is started

Throws:

IOException - if there is a problem reading the configuration stream

DefaultCacheManager

public DefaultCacheManager(String globalConfigurationFile,
                           String defaultConfigurationFile,
                           String namedCacheFile,
                           boolean start)
                    throws IOException

Constructs a new instance of the CacheManager, using the two configuration file names passed in. The first file contains the GlobalConfiguration configuration The second file contain the Default configuration. The third filename contains the named cache configuration This constructor first searches for the named file on the classpath, and failing that, treats the file name as an absolute path.

Parameters:

start - if true, the cache manager is started

globalConfigurationFile - name of file that contains the global configuration

defaultConfigurationFile - name of file that contains the default configuration

namedCacheFile - name of file that contains the named cache configuration

Throws:

IOException - if there is a problem with the configuration file.

Method Detail

defineConfiguration

public 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.

Specified by:

defineConfiguration in interface CacheManager

Parameters:

cacheName - name of cache whose configuration is being defined

configurationOverride - configuration overrides to use

Returns:

a cloned configuration instance

defineConfiguration

public Configuration defineConfiguration(String cacheName,
                                         String templateName,
                                         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 CacheManager.defineConfiguration(String, Configuration) in the sense that the base configuration used is the default cache configuration.

Specified by:

defineConfiguration in interface CacheManager

Parameters:

cacheName - name of cache whose configuration is being defined

templateName - 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

getCache

public <K,V> Cache<K,V> getCache()

Retrieves the default cache associated with this cache manager. Note that the default cache does not need to be explicitly created with createCache(String) since it is automatically created lazily when first used.

As such, this method is always guaranteed to return the default cache.

Specified by:

getCache in interface CacheManager

Returns:

the default cache.

getCache

public <K,V> Cache<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.

When creating a new cache, this method will use the configuration passed in to the CacheManager on construction, as a template, and then optionally apply any overrides previously defined for the named cache using the defineConfiguration(String, Configuration) or defineConfiguration(String, String, Configuration) methods, or declared in the configuration file.

Specified by:

getCache in interface CacheManager

Parameters:

cacheName - name of cache to retrieve

Returns:

a cache instance identified by cacheName

getClusterName

public String getClusterName()

Specified by:

getClusterName in interface CacheManager

Returns:

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

getMembers

public List<Address> getMembers()

Specified by:

getMembers in interface CacheManager

getAddress

public Address getAddress()

Specified by:

getAddress in interface CacheManager

isCoordinator

public boolean isCoordinator()

Specified by:

isCoordinator in interface CacheManager

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

addListener

public void addListener(Object listener)

Description copied from interface: Listenable

Adds a listener to the component. Typically, listeners would need to be annotated with Listener and further to that, contain methods annotated appropriately, otherwise the listener will not be registered.

See the Listener annotation for more information.

Specified by:

addListener in interface Listenable

Parameters:

listener - must not be null.

removeListener

public void removeListener(Object listener)

Description copied from interface: Listenable

Removes a listener from the component.

Specified by:

removeListener in interface Listenable

Parameters:

listener - listener to remove. Must not be null.

getListeners

public Set<Object> getListeners()

Specified by:

getListeners in interface Listenable

Returns:

a set of all listeners registered on this component.

getStatus

public ComponentStatus getStatus()

Specified by:

getStatus in interface CacheManager

getGlobalConfiguration

public GlobalConfiguration getGlobalConfiguration()

Description copied from interface: CacheManager

Returns global configuration for this CacheManager

Specified by:

getGlobalConfiguration in interface CacheManager

Returns:

the global configuration object associated to this CacheManager

getDefaultConfiguration

public Configuration getDefaultConfiguration()

Description copied from interface: CacheManager

Returns default configuration for this CacheManager

Specified by:

getDefaultConfiguration in interface CacheManager

Returns:

the default configuration associated with this CacheManager

getCacheNames

public Set<String> getCacheNames()

Description copied from interface: CacheManager

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

Specified by:

getCacheNames in interface CacheManager

Returns:

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

getCacheManagerStatus

public String getCacheManagerStatus()

getDefinedCacheNames

public String getDefinedCacheNames()

getDefinedCacheCount

public String getDefinedCacheCount()

getCreatedCacheCount

public String getCreatedCacheCount()

getRunningCacheCount

public String getRunningCacheCount()

getVersion

public String getVersion()

getName

public String getName()

startCache

public void startCache()

startCache

public void startCache(String cacheName)

toString

public String toString()

Overrides:

toString in class Object